Added type hints

Author: thusser

pyobs_fli/__init__.py

@@ -4,3 +4,6 @@
 __title__ = 'FLI camera modules'
 
 from .flicamera import FliCamera
+
+
+__all__ = ['FliCamera']

pyobs_fli/flicamera.py

@@ -3,14 +3,14 @@
 import threading
 from datetime import datetime
 import time
-from typing import Tuple
-from astropy.io import fits
+from typing import Tuple, Any, Optional, Dict
+import numpy as np
 
 from pyobs.interfaces import ICamera, IWindow, IBinning, ICooling
 from pyobs.modules.camera.basecamera import BaseCamera
 from pyobs.images import Image
 from pyobs.utils.enums import ExposureStatus
-from pyobs_fli.flidriver import *
+from pyobs_fli.flidriver import FliDriver, FliTemperature
 
 
 log = logging.getLogger(__name__)
@@ -20,23 +20,23 @@ class FliCamera(BaseCamera, ICamera, IWindow, IBinning, ICooling):
     """A pyobs module for FLI cameras."""
     __module__ = 'pyobs_fli'
 
-    def __init__(self, setpoint: float = -20, *args, **kwargs):
+    def __init__(self, setpoint: float = -20., **kwargs: Any):
         """Initializes a new FliCamera.
 
         Args:
             setpoint: Cooling temperature setpoint.
         """
-        BaseCamera.__init__(self, *args, **kwargs)
+        BaseCamera.__init__(self, **kwargs)
 
         # variables
-        self._driver = None
-        self._temp_setpoint = setpoint
+        self._driver: Optional[FliDriver] = None
+        self._temp_setpoint: Optional[float] = setpoint
 
         # window and binning
-        self._window = None
-        self._binning = None
+        self._window = (0, 0, 0, 0)
+        self._binning = (1, 1)
 
-    def open(self):
+    def open(self) -> None:
         """Open module."""
         BaseCamera.open(self)
 
@@ -58,9 +58,10 @@ def open(self):
         self._window, self._binning = self._driver.get_window_binning()
 
         # set cooling
-        self.set_cooling(True, self._temp_setpoint)
+        if self._temp_setpoint is not None:
+            self.set_cooling(True, self._temp_setpoint)
 
-    def close(self):
+    def close(self) -> None:
         """Close the module."""
         BaseCamera.close(self)
 
@@ -70,31 +71,33 @@ def close(self):
             self._driver.close()
             self._driver = None
 
-    def get_full_frame(self, *args, **kwargs) -> Tuple[int, int, int, int]:
+    def get_full_frame(self, **kwargs: Any) -> Tuple[int, int, int, int]:
         """Returns full size of CCD.
 
         Returns:
             Tuple with left, top, width, and height set.
         """
+        if self._driver is None:
+            raise ValueError('No camera driver.')
         return self._driver.get_full_frame()
 
-    def get_window(self, *args, **kwargs) -> Tuple[int, int, int, int]:
+    def get_window(self, **kwargs: Any) -> Tuple[int, int, int, int]:
         """Returns the camera window.
 
         Returns:
             Tuple with left, top, width, and height set.
         """
         return self._window
 
-    def get_binning(self, *args, **kwargs) -> Tuple[int, int]:
+    def get_binning(self, **kwargs: Any) -> Tuple[int, int]:
         """Returns the camera binning.
 
         Returns:
             Tuple with x and y.
         """
         return self._binning
 
-    def set_window(self, left: float, top: float, width: float, height: float, *args, **kwargs):
+    def set_window(self, left: int, top: int, width: int, height: int, **kwargs: Any) -> None:
         """Set the camera window.
 
         Args:
@@ -109,7 +112,7 @@ def set_window(self, left: float, top: float, width: float, height: float, *args
         self._window = (left, top, width, height)
         log.info('Setting window to %dx%d at %d,%d...', width, height, left, top)
 
-    def set_binning(self, x: int, y: int, *args, **kwargs):
+    def set_binning(self, x: int, y: int, **kwargs: Any) -> None:
         """Set the camera binning.
 
         Args:
@@ -137,6 +140,10 @@ def _expose(self, exposure_time: float, open_shutter: bool, abort_event: threadi
             ValueError: If exposure was not successful.
         """
 
+        # check driver
+        if self._driver is None:
+            raise ValueError('No camera driver.')
+
         # set binning
         log.info("Set binning to %dx%d.", self._binning[0], self._binning[1])
         self._driver.set_binning(*self._binning)
@@ -220,16 +227,18 @@ def _expose(self, exposure_time: float, open_shutter: bool, abort_event: threadi
         self._change_exposure_status(ExposureStatus.IDLE)
         return image
 
-    def _abort_exposure(self):
+    def _abort_exposure(self) -> None:
         """Abort the running exposure. Should be implemented by derived class.
 
         Raises:
             ValueError: If an error occured.
         """
+        if self._driver is None:
+            raise ValueError('No camera driver.')
         self._driver.cancel_exposure()
         self._camera_status = ExposureStatus.IDLE
 
-    def get_cooling_status(self, *args, **kwargs) -> Tuple[bool, float, float]:
+    def get_cooling_status(self, **kwargs: Any) -> Tuple[bool, float, float]:
         """Returns the current status for the cooling.
 
         Returns:
@@ -238,21 +247,25 @@ def get_cooling_status(self, *args, **kwargs) -> Tuple[bool, float, float]:
                 SetPoint (float):       Setpoint for the cooling in celsius.
                 Power (float):          Current cooling power in percent or None.
         """
+        if self._driver is None:
+            raise ValueError('No camera driver.')
         enabled = self._temp_setpoint is not None
-        return enabled, self._temp_setpoint, self._driver.get_cooler_power()
+        return enabled, self._temp_setpoint if self._temp_setpoint is not None else 99., self._driver.get_cooler_power()
 
-    def get_temperatures(self, *args, **kwargs) -> dict:
+    def get_temperatures(self, **kwargs: Any) -> Dict[str, float]:
         """Returns all temperatures measured by this module.
 
         Returns:
             Dict containing temperatures.
         """
+        if self._driver is None:
+            raise ValueError('No camera driver.')
         return {
             'CCD': self._driver.get_temp(FliTemperature.CCD),
             'Base': self._driver.get_temp(FliTemperature.BASE)
         }
 
-    def set_cooling(self, enabled: bool, setpoint: float, *args, **kwargs):
+    def set_cooling(self, enabled: bool, setpoint: float, **kwargs: Any) -> None:
         """Enables/disables cooling and sets setpoint.
 
         Args:
@@ -262,6 +275,8 @@ def set_cooling(self, enabled: bool, setpoint: float, *args, **kwargs):
         Raises:
             ValueError: If cooling could not be set.
         """
+        if self._driver is None:
+            raise ValueError('No camera driver.')
 
         # log
         if enabled:

pyobs_fli/flidriver.pyx

@@ -2,6 +2,8 @@
 
 from collections import namedtuple
 from enum import Enum
+from typing import Tuple, List
+
 import numpy as np
 cimport numpy as np
 np.import_array()
@@ -24,7 +26,7 @@ cdef class FliDriver:
     """Wrapper for the FLI driver."""
 
     @staticmethod
-    def list_devices():
+    def list_devices() -> List[DeviceInfo]:
         """List all FLI USB cameras connected to this computer.
 
         Returns:
@@ -71,7 +73,7 @@ cdef class FliDriver:
         """
         self._device_info = device_info
 
-    def open(self):
+    def open(self) -> None:
         """Open driver.
 
         Raises:
@@ -81,7 +83,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not open device.')
 
-    def close(self):
+    def close(self) -> None:
         """Close driver.
 
         Raises:
@@ -92,11 +94,11 @@ cdef class FliDriver:
             raise ValueError('Could not open device.')
 
     @property
-    def name(self):
+    def name(self) -> str:
         """Returns the name of the connected device."""
         return self._device_info.name.decode('utf-8')
 
-    def get_window_binning(self):
+    def get_window_binning(self) -> Tuple[Tuple[int, int, int, int], Tuple[int, int]]:
         """Get tuple of window and binning dicts.
 
         Returns:
@@ -117,7 +119,7 @@ cdef class FliDriver:
         # return window and binning
         return (hoffset, voffset, width, height), (hbin, vbin)
 
-    def get_visible_frame(self):
+    def get_visible_frame(self) -> Tuple[int, int, int, int]:
         """Returns the visible frame of the connected camera.
 
         Returns:
@@ -138,7 +140,7 @@ cdef class FliDriver:
         # return it
         return ul_x, ul_y, lr_x -  ul_x, lr_y - ul_y
 
-    def get_full_frame(self):
+    def get_full_frame(self) -> Tuple[int, int, int, int]:
         """Returns the full frame of the connected camera.
 
         Returns:
@@ -159,7 +161,7 @@ cdef class FliDriver:
         # return it
         return ul_x, ul_y, lr_x -  ul_x, lr_y - ul_y
 
-    def set_binning(self, x: int, y: int):
+    def set_binning(self, x: int, y: int) -> None:
         """Set the binning.
 
         Args:
@@ -180,7 +182,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not set y binning.')
 
-    def set_window(self, left: int, top: int, width: int, height: int):
+    def set_window(self, left: int, top: int, width: int, height: int) -> None:
         """Sets the window.
 
         Args:
@@ -198,7 +200,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not set window.')
 
-    def init_exposure(self, open_shutter: bool):
+    def init_exposure(self, open_shutter: bool) -> None:
         """Initializes an exposure.
 
         Args:
@@ -218,7 +220,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not set frame type.')
 
-    def set_exposure_time(self, exptime: int):
+    def set_exposure_time(self, exptime: int) -> None:
         """Sets the exposure time.
 
         Args:
@@ -233,7 +235,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not set exposure time.')
 
-    def start_exposure(self):
+    def start_exposure(self) -> None:
         """Start a new exposure.
 
         Raises:
@@ -245,7 +247,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not start exposure.')
 
-    def is_exposing(self):
+    def is_exposing(self) -> bool:
         """Checks, whether the camera is currently exposing
 
         Returns:
@@ -270,7 +272,7 @@ cdef class FliDriver:
         return (status == FLI_CAMERA_STATUS_UNKNOWN and timeleft == 0) or \
                (status != FLI_CAMERA_STATUS_UNKNOWN and status & FLI_CAMERA_DATA_READY)
 
-    def get_temp(self, channel: FliTemperature):
+    def get_temp(self, channel: FliTemperature) -> float:
         """Returns the temperature of the given sensor.
 
         Args:
@@ -294,7 +296,7 @@ cdef class FliDriver:
         # return it
         return temp
 
-    def get_cooler_power(self):
+    def get_cooler_power(self) -> float:
         """Get power of cooling in percent.
 
         Returns:
@@ -315,7 +317,7 @@ cdef class FliDriver:
         # return it
         return power
 
-    def grab_row(self, width: int):
+    def grab_row(self, width: int) -> np.ndarray:
         """Reads out a row from the camera.
 
         Args:
@@ -332,7 +334,7 @@ cdef class FliDriver:
         cdef np.ndarray[unsigned short, ndim=1] row = np.zeros((width), dtype=np.ushort)
 
         # get pointer to data
-        cdef unsigned short* row_data = <unsigned short*> row.data
+        cdef void* row_data = <void*> row.data
 
         # call library
         res = FLIGrabRow(self._device, row_data, width)
@@ -342,7 +344,7 @@ cdef class FliDriver:
         # return row
         return row
 
-    def cancel_exposure(self):
+    def cancel_exposure(self) -> None:
         """Cancel an exposure.
 
         Raises:
@@ -353,7 +355,7 @@ cdef class FliDriver:
         if res != 0:
             raise ValueError('Could not cancel exposure.')
 
-    def set_temperature(self, setpoint: float):
+    def set_temperature(self, setpoint: float) -> None:
         """Set cooling emperature setpoint.
 
         Args: