Updated type hints for return values, fix type hint imports, update requirements

Author: jsymons

adafruit_is31fl3741/__init__.py

@@ -30,7 +30,8 @@
 import busio
 
 try:
-    from typing import Optional
+    # Used only for typing
+    from typing import Optional, Tuple, Union  # pylint: disable=unused-import
     from PIL import Image
 except ImportError:
     pass
@@ -106,16 +107,16 @@ def __init__(
         self._page = None
         self.reset()
 
-    def reset(self):
+    def reset(self) -> None:
         """Reset"""
         self.page = 4
         self._reset_reg = 0xAE
 
-    def unlock(self):
+    def unlock(self) -> None:
         """Unlock"""
         self._lock_reg = 0xC5
 
-    def set_led_scaling(self, scale: int):
+    def set_led_scaling(self, scale: int) -> None:
         """Set LED scaling.
 
         param scale: The scale.
@@ -130,34 +131,34 @@ def set_led_scaling(self, scale: int):
             i2c.write(bytes(scalebuf))
 
     @property
-    def global_current(self):
+    def global_current(self) -> int:
         """Global current"""
         self.page = 4
         return self._gcurrent_reg
 
     @global_current.setter
-    def global_current(self, current: int):
+    def global_current(self, current: int) -> None:
         self.page = 4
         self._gcurrent_reg = current
 
     @property
-    def enable(self):
+    def enable(self) -> bool:
         """Enable"""
         self.page = 4
         return self._shutdown_bit
 
     @enable.setter
-    def enable(self, enable: bool):
+    def enable(self, enable: bool) -> None:
         self.page = 4
         self._shutdown_bit = enable
 
     @property
-    def page(self):
+    def page(self) -> Union[int, None]:
         """Page"""
         return self._page
 
     @page.setter
-    def page(self, page_value: int):
+    def page(self, page_value: int) -> None:
         if page_value == self._page:
             return  # already set
         if page_value > 4:
@@ -166,7 +167,7 @@ def page(self, page_value: int):
         self.unlock()
         self._page_reg = page_value
 
-    def __getitem__(self, led: int):
+    def __getitem__(self, led: int) -> int:
         if not 0 <= led <= 350:
             raise ValueError("LED must be 0 ~ 350")
         if self._pixel_buffer:
@@ -184,7 +185,7 @@ def __getitem__(self, led: int):
             )
         return self._buf[1]
 
-    def __setitem__(self, led: int, pwm: int):
+    def __setitem__(self, led: int, pwm: int) -> None:
         if not 0 <= led <= 350:
             raise ValueError("LED must be 0 ~ 350")
         if not 0 <= pwm <= 255:
@@ -205,12 +206,12 @@ def __setitem__(self, led: int, pwm: int):
 
     # This function must be replaced for each board
     @staticmethod
-    def pixel_addrs(x: int, y: int):
+    def pixel_addrs(x: int, y: int) -> Tuple[int, ...]:
         """Calulate the offset into the device array for x,y pixel"""
         raise NotImplementedError("Supported in subclasses only")
 
     # pylint: disable-msg=too-many-arguments
-    def pixel(self, x: int, y: int, color: Optional[int] = None):
+    def pixel(self, x: int, y: int, color: Optional[int] = None) -> Union[int, None]:
         """
         Color of for x-, y-pixel
 
@@ -232,7 +233,7 @@ def pixel(self, x: int, y: int, color: Optional[int] = None):
 
     # pylint: enable-msg=too-many-arguments
 
-    def image(self, img: Image):
+    def image(self, img: Image) -> None:
         """Set buffer to value of Python Imaging Library image.  The image should
         be in 8-bit mode (L) and a size equal to the display size.
 
@@ -255,7 +256,7 @@ def image(self, img: Image):
             for y in range(self.height):  #  but these displays are small!
                 self.pixel(x, y, pixels[(x, y)])
 
-    def show(self):
+    def show(self) -> None:
         """Issue in-RAM pixel data to device. No effect if pixels are
         unbuffered.
         """

adafruit_is31fl3741/adafruit_ledglasses.py

@@ -23,10 +23,16 @@
 
 """
 from struct import unpack_from
-import busio
 import adafruit_is31fl3741
 from . import IS31FL3741
 
+try:
+    # Used only for typing
+    from typing import Tuple  # pylint: disable=unused-import
+    import busio
+except ImportError:
+    pass
+
 
 class Right_Ring:
     """The right eye ring of the LED glasses"""
@@ -87,7 +93,7 @@ class Right_Ring:
     def __init__(self, is31_controller: IS31FL3741):
         self._is31 = is31_controller
 
-    def __setitem__(self, led: int, color: int):
+    def __setitem__(self, led: int, color: int) -> None:
         if not 0 <= led <= 23:
             raise ValueError("led must be 0~23")
 
@@ -96,7 +102,7 @@ def __setitem__(self, led: int, color: int):
         self._is31[rgb[1]] = (color >> 8) & 0xFF
         self._is31[rgb[2]] = color & 0xFF
 
-    def __getitem__(self, led: int):
+    def __getitem__(self, led: int) -> int:
         if not 0 <= led <= 23:
             raise ValueError("led must be 0~23")
         rgb = unpack_from(">HHH", self.ledmap_bytes, led * 6)
@@ -161,10 +167,10 @@ class Left_Ring:
         b"\x00\xF1\x00\xF0\x01\x5E"
     )
 
-    def __init__(self, is31_controller: IS31FL3741):
+    def __init__(self, is31_controller: IS31FL3741) -> None:
         self._is31 = is31_controller
 
-    def __setitem__(self, led: int, color: int):
+    def __setitem__(self, led: int, color: int) -> None:
         if not 0 <= led <= 23:
             raise ValueError("led must be 0~23")
 
@@ -173,7 +179,7 @@ def __setitem__(self, led: int, color: int):
         self._is31[rgb[1]] = (color >> 8) & 0xFF
         self._is31[rgb[2]] = color & 0xFF
 
-    def __getitem__(self, led: int):
+    def __getitem__(self, led: int) -> int:
         if not 0 <= led <= 23:
             raise ValueError("led must be 0~23")
         rgb = unpack_from(">HHH", self.ledmap_bytes, led * 6)
@@ -387,7 +393,7 @@ def __init__(self, i2c: busio.I2C, allocate: int = adafruit_is31fl3741.NO_BUFFER
         self.grid = self
 
     @staticmethod
-    def pixel_addrs(x: int, y: int):
+    def pixel_addrs(x: int, y: int) -> Tuple[int, ...]:
         return unpack_from(
             ">HHH", LED_Glasses.ledmap_bytes, ((y * LED_Glasses.width) + x) * 6
         )

adafruit_is31fl3741/adafruit_rgbmatrixqt.py

@@ -25,7 +25,8 @@
 
 # imports
 try:
-    from typing import Tuple
+    # Used only for typing
+    from typing import Tuple  # pylint: disable=unused-import
 except ImportError:
     pass
 from . import IS31FL3741

adafruit_is31fl3741/issi_evb.py

@@ -29,6 +29,12 @@
 # imports
 from . import IS31FL3741
 
+try:
+    # Used only for typing
+    from typing import Tuple  # pylint: disable=unused-import
+except ImportError:
+    pass
+
 
 class ISSI_EVB(IS31FL3741):
     """Supports the ISSI IS31FL3741 eval board"""
@@ -37,7 +43,7 @@ class ISSI_EVB(IS31FL3741):
     height = 9
 
     @staticmethod
-    def pixel_addrs(x: int, y: int):
+    def pixel_addrs(x: int, y: int) -> Tuple[int, int, int]:
         """Calulate the RGB offsets into the device array for x,y pixel"""
         if x > 9:
             offset = (x + 80 + y * 3) * 3

requirements.txt

@@ -5,3 +5,4 @@
 Adafruit-Blinka
 adafruit-circuitpython-framebuf
 adafruit-circuitpython-register
+Pillow