Fix mypy errors in src/frheed/cameras (#25)

Author: ecyoung3

pyproject.toml

@@ -58,21 +58,27 @@ include = [
 packages = ["src/frheed"]
 
 [tool.ruff]
-# Increase the line length from the default of 88
 line-length = 100
-
-# Always autofix when possible
 fix = true
 
 [tool.ruff.lint]
-# Specify rules explicitly to avoid configuration drift due to defaults changing
 select = [
     "E",  # all pyflakes rules
     "F",  # all pycodestyle rules
     "I",  # all isort rules
 ]
-
-# Rules to exclude from autofix
 unfixable = [
     "F401",  # unused imports
 ]
+
+[tool.mypy]
+disallow_untyped_defs = true
+warn_return_any = true
+
+# Third-party libraries without stubs
+[[tool.mypy.overrides]]
+module = [
+    "PySpin",
+]
+follow_imports = "silent"
+ignore_missing_imports = true

src/frheed/cameras/flir/__init__.py

@@ -3,9 +3,13 @@
 Adapted from simple_pyspin: https://github.com/klecknerlab/simple_pyspin
 """
 
+from __future__ import annotations
+
+import collections
+import logging
 import time
-from collections import deque
-from typing import Tuple, Union
+from types import TracebackType
+from typing import Any
 
 import numpy as np
 import PySpin
@@ -63,9 +67,7 @@
     "SerialReceiveQueueClear": "Clear Serial Port",
 }
 
-_DEBUG = __name__ == "__main__"
-
-_SYSTEM = None
+_SYSTEM: PySpin.System | None = None
 
 
 def list_cameras() -> PySpin.CameraList:
@@ -178,7 +180,7 @@ class FlirCamera:
         PySpin.intfICommand: "command",
     }
 
-    def __init__(self, src: Union[int, str] = 0, lock: bool = False):
+    def __init__(self, src: int | str = 0, lock: bool = False):
         """
         Parameters
         ----------
@@ -196,9 +198,7 @@ def __init__(self, src: Union[int, str] = 0, lock: bool = False):
         super().__setattr__("lock", lock)
 
         cam_list = list_cameras()
-
-        if _DEBUG:
-            print(f"Found {cam_list.GetSize()} FLIR camera(s)")
+        logging.debug("Found %s FLIR camera(s)", cam_list.GetSize())
 
         self._src_type = type(src)
         self._src = src
@@ -216,10 +216,10 @@ def __init__(self, src: Union[int, str] = 0, lock: bool = False):
 
         # Other attributes which may be accessed later
         self._running = False
-        self._frame_times = deque()
+        self._frame_times: collections.deque[float] = collections.deque()
         self._incomplete_image_count = 0
 
-    def __getattr__(self, attr: str) -> object:
+    def __getattr__(self, attr: str) -> Any:
         # Add this in so @property decorator works as expected
         if attr in self.__dict__:
             return self.__dict__[attr]
@@ -265,11 +265,16 @@ def __setattr__(self, attr: str, val: object) -> None:
             else:
                 super().__setattr__(attr, val)
 
-    def __enter__(self) -> "FlirCamera":
+    def __enter__(self) -> FlirCamera:
         self.init()
         return self
 
-    def __exit__(self, type, value, traceback) -> None:
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
         self.close()
 
     def __del__(self) -> None:
@@ -388,7 +393,7 @@ def height(self) -> int:
         return int(height)
 
     @property
-    def shape(self) -> Tuple[int, int]:
+    def shape(self) -> tuple[int, int]:
         """Get the camera array dimensions (Height x Width)"""
         if not self.initialized:
             self.init()
@@ -405,10 +410,11 @@ def init(self) -> None:
         Initializes the camera. Automatically called if the camera is opened
         using a 'with' clause.
         """
-
         self.cam.Init()
 
-        for node in self.cam.GetNodeMap().GetNodes():
+        node_map: PySpin.INodeMap = self.cam.GetNodeMap()
+        nodes: list[PySpin.INode] = node_map.GetNodes()
+        for node in nodes:
             pit = node.GetPrincipalInterfaceType()
             name = node.GetName()
             self.camera_node_types[name] = self._attr_type_names.get(pit, pit)
@@ -456,7 +462,7 @@ def stop(self) -> None:
 
         if self.running:
             self.cam.EndAcquisition()
-        self._frame_times = deque()
+        self._frame_times.clear()
         self._incomplete_image_count = 0
         self._running = False
 
@@ -474,11 +480,10 @@ def close(self) -> None:
             pass
 
         # Reset attributes
-        self.camera_attributes = {}
-        self.camera_methods = {}
-        self.camera_node_types = {}
+        self.camera_attributes: dict[str, Any] = {}
+        self.camera_methods: dict[str, PySpin.CCommandPtr] = {}
+        self.camera_node_types: dict[str, str] = {}
         self._initialized = False
-        # self.system.ReleaseInstance()
 
     def get_image(self, wait: bool = True) -> PySpin.ImagePtr:
         """
@@ -513,7 +518,7 @@ def get_image(self, wait: bool = True) -> PySpin.ImagePtr:
 
     def get_array(
         self, wait: bool = True, get_chunk: bool = False, complete_frames_only: bool = False
-    ) -> Union[np.ndarray, Tuple[np.ndarray, PySpin.PySpin.ChunkData]]:
+    ) -> np.ndarray | tuple[np.ndarray, PySpin.PySpin.ChunkData]:
         """
         Get an image from the camera, and convert it to a numpy array.
 
@@ -547,12 +552,14 @@ def get_array(
         if len(self._frame_times) > 3600:
             self._frame_times.popleft()
 
+        arr: np.ndarray = img.GetNDArray()
         if get_chunk:
-            return img.GetNDArray(), img.GetChunkData()
+            chunk: PySpin.PySpin.ChunkData = img.GetChunkData()
+            return (arr, chunk)
         else:
-            return img.GetNDArray()
+            return arr
 
-    def get_info(self, name: str) -> dict:
+    def get_info(self, name: str) -> dict[str, Any]:
         """
         Get information on a camera node (attribute or method).
 
@@ -570,7 +577,7 @@ def get_info(self, name: str) -> dict:
                 - "unit": the unit of the value (as a string).
                 - "min" and "max": the min/max value.
         """
-        info = {"name": name}
+        info: dict[str, Any] = {"name": name}
 
         if name in self.camera_attributes:
             node = self.camera_attributes[name]
@@ -716,25 +723,3 @@ def document(self, verbose: bool = True) -> str:
             lines.append("")
 
         return "\n".join(lines)
-
-
-if __name__ == "__main__":
-
-    def test():
-        with FlirCamera() as cam:
-            print(cam.document(verbose=False))
-            print(cam)
-            cam.start()
-            while True:
-                try:
-                    global image
-                    image = cam.get_array()
-                    # print(cam.incomplete_image_count, cam.real_fps)
-                    print(cam.DeviceTemperature)
-
-                except KeyboardInterrupt:
-                    break
-
-    # test()
-
-    print(list_cameras())

src/frheed/cameras/usb/__init__.py

@@ -2,10 +2,14 @@
 Connecting to USB cameras.
 """
 
+from __future__ import annotations
+
+import collections
+import logging
 import os
 import time
-from collections import deque
-from typing import List, Optional, Tuple, Union
+from types import TracebackType
+from typing import Any
 
 import cv2
 import numpy as np
@@ -16,8 +20,6 @@
 # https://stackoverflow.com/a/54585850/10342097
 os.environ["OPENCV_VIDEOIO_PRIORITY_MSMF"] = "0"
 
-_DEBUG = __name__ == "__main__"
-
 # Get non-platform-specific capture properties (0 < id < 50)
 _CAP_PROPS = [
     prop for prop in dir(cv2) if prop.startswith("CAP_PROP") and getattr(cv2, prop, 1000) < 50
@@ -43,7 +45,7 @@
 _DEFAULT_BACKEND = cv2.CAP_DSHOW  # cv2.CAP_DSHOW or cv2.CAP_MSMF
 
 
-def list_cameras() -> List[int]:
+def list_cameras() -> list[int]:
     """
     Get list of indices of available USB cameras.
 
@@ -129,11 +131,8 @@ class UsbCamera:
     }
 
     def __init__(
-        self,
-        src: Union[int, str] = 0,
-        lock: bool = False,
-        backend: Optional[int] = _DEFAULT_BACKEND,  # cv2.CAP_DSHOW
-    ):
+        self, src: int | str = 0, lock: bool = False, backend: int | None = _DEFAULT_BACKEND
+    ) -> None:
         """
         Parameters
         ----------
@@ -149,10 +148,12 @@ def __init__(
         super().__setattr__("camera_attributes", {})
         super().__setattr__("camera_methods", {})
         super().__setattr__("lock", lock)
+        self.camera_attributes: dict[str, Any]
+        self.camera_methods: dict[str, Any]
+        self.lock: bool
 
         cam_list = list_cameras()
-        if _DEBUG:
-            print(f"Found {len(cam_list)} USB camera(s)")
+        logging.debug("Found %s USB camera(s)", len(cam_list))
 
         if not cam_list:
             raise CameraError("No USB cameras detected.")
@@ -174,10 +175,10 @@ def __init__(
 
         # Other attributes which may be accessed later
         self._running = True  # camera is running as soon as you connect to it
-        self._frame_times = deque()
+        self._frame_times: collections.deque[float] = collections.deque()
         self._incomplete_image_count = 0
 
-    def __getattr__(self, attr: str) -> object:
+    def __getattr__(self, attr: str) -> Any:
         # Add this in so @property decorator works as expected
         if attr in self.__dict__:
             return self.__dict__[attr]
@@ -191,7 +192,7 @@ def __getattr__(self, attr: str) -> object:
         else:
             raise AttributeError(attr)
 
-    def __setattr__(self, attr: str, val: object) -> None:
+    def __setattr__(self, attr: str, val: Any) -> None:
         if attr in self.camera_attributes:
             propId = getattr(cv2, attr, None)
             if propId is None:
@@ -205,8 +206,7 @@ def __setattr__(self, attr: str, val: object) -> None:
 
             success = self.cam.set(propId, val)
             result = "succeeded" if success else "failed"
-            if _DEBUG or not success:
-                print(f"Setting {attr} to {val} {result}")
+            logging.debug("Setting %s to %s %s", attr, val, result)
 
         else:
             if attr == "__class__":
@@ -216,11 +216,16 @@ def __setattr__(self, attr: str, val: object) -> None:
             else:
                 super().__setattr__(attr, val)
 
-    def __enter__(self) -> "UsbCamera":
+    def __enter__(self) -> UsbCamera:
         self.init()
         return self
 
-    def __exit__(self, type, value, traceback) -> None:
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
         self.close()
 
     def __del__(self) -> None:
@@ -275,10 +280,10 @@ def height(self) -> int:
         return int(self.CAP_PROP_FRAME_HEIGHT)
 
     @property
-    def shape(self) -> Tuple[int, int]:
+    def shape(self) -> tuple[int, int]:
         return (self.width, self.height)
 
-    def init(self):
+    def init(self) -> None:
         if not self.initialized:
             self.cam.open(self._src)
 
@@ -291,7 +296,7 @@ def start(self, continuous: bool = True) -> None:
         self._running = True
 
     def stop(self) -> None:
-        self._frame_times = []
+        self._frame_times.clear()
         self._incomplete_image_count = 0
         self._running = False
 
@@ -337,26 +342,3 @@ def get_info(self, name: str) -> dict:
         """Get information about a camera node (attribute or method)."""
         # TODO: Fully implement
         return {"name": name}
-
-
-if __name__ == "__main__":
-
-    def test():
-        from PIL import Image
-
-        with UsbCamera() as cam:
-            while True:
-                try:
-                    for prop in cam._cap_props:
-                        print(prop, (getattr(cam, prop)))
-
-                    break
-
-                    array = cam.get_array()
-                    Image.fromarray(array).show()
-                    break
-
-                except KeyboardInterrupt:
-                    break
-
-    test()