Merge pull request #105 from tekktrik/doc/fix-type-annotatations

Fix type annotatations, minor tweaks

Author: tekktrik

adafruit_ht16k33/animations.py

@@ -16,6 +16,13 @@
 
 from time import sleep
 
+try:
+    from typing import List
+    from adafruit_ht16k33.segments import Seg14x4
+except ImportError:
+    pass
+
+
 N = 16384
 M = 8192
 L = 4096
@@ -45,11 +52,17 @@ class Animation:
 
     """
 
-    def __init__(self, display):
+    def __init__(self, display: Seg14x4) -> None:
 
         self._display = display
 
-    def animate(self, digits, bitmasks, delay=0.2, auto_write=True):
+    def animate(
+        self,
+        digits: List[int],
+        bitmasks: List[int],
+        delay: float = 0.2,
+        auto_write: bool = True,
+    ) -> None:
         """Animate function
 
 
@@ -84,12 +97,10 @@ def animate(self, digits, bitmasks, delay=0.2, auto_write=True):
                     self._display.show()
                     sleep(delay)
 
-    def chase_forward_and_reverse(self, delay=0.2, cycles=5):
+    def chase_forward_and_reverse(self, delay: float = 0.2, cycles: int = 5):
         """Chase Forward and Reverse Animation"""
 
-        cy = 0
-
-        while cy < cycles:
+        for _ in range(cycles):
             self.animate([0, 1, 2, 3], [A, 0], delay)
             self.animate([3], [B, C, D, 0], delay)
             self.animate([2, 1, 0], [D, 0], delay)
@@ -103,15 +114,12 @@ def chase_forward_and_reverse(self, delay=0.2, cycles=5):
             self.animate([2, 1], [G2, G1, 0], delay)
             self.animate([0], [H, 0], delay)
 
-            cy += 1
-
-    def prelude_to_spinners(self, delay=0.2, cycles=5):
+    def prelude_to_spinners(self, delay: float = 0.2, cycles: int = 5) -> None:
         """Prelude to Spinners Animation"""
 
-        cy = 0
         auto_write = False
 
-        while cy < cycles:
+        for _ in range(cycles):
             self.animate([1, 2], [A], 0, auto_write)
             self._display.show()
             sleep(delay)
@@ -164,15 +172,12 @@ def prelude_to_spinners(self, delay=0.2, cycles=5):
             self._display.show()
             sleep(delay)
 
-            cy += 1
-
-    def spinners(self, delay=0.2, cycles=5):
+    def spinners(self, delay: float = 0.2, cycles: int = 5) -> None:
         """Spinners Animation"""
 
-        cy = 0
         auto_write = False
 
-        while cy < cycles:
+        for _ in range(cycles):
             self.animate([0], [H + M], 0, auto_write)
             self.animate([1], [J + K], 0, auto_write)
             self.animate([2], [H + M], 0, auto_write)
@@ -194,16 +199,14 @@ def spinners(self, delay=0.2, cycles=5):
             self._display.show()
             sleep(delay)
 
-            cy += 1
-
         self._display.fill(0)
 
-    def enclosed_spinners(self, delay=0.2, cycles=5):
+    def enclosed_spinners(self, delay: float = 0.2, cycles: int = 5) -> None:
         """Enclosed Spinner Animation"""
-        cy = 0
+
         auto_write = False
 
-        while cy < cycles:
+        for _ in range(cycles):
             self.animate([0], [A + D + E + F + H + M], 0, auto_write)
             self.animate([1], [A + D + J + K], 0, auto_write)
             self.animate([2], [A + D + H + M], 0, auto_write)
@@ -225,30 +228,26 @@ def enclosed_spinners(self, delay=0.2, cycles=5):
             self._display.show()
             sleep(delay)
 
-            cy += 1
-
         self._display.fill(0)
 
-    def count_down(self):
+    def count_down(self) -> None:
         """Countdown Method"""
+
         auto_write = False
         numbers = [
             [A + B + C + D + G1 + G2 + N],
             [A + B + D + E + G1 + G2 + N],
             [B + C + N],
         ]
-        index = 0
 
         self._display.fill(0)
 
-        while index < len(numbers):
-            self.animate([index], numbers[index], 0, auto_write)
+        for index, number in enumerate(numbers):
+            self.animate([index], number, 0, auto_write)
             self._display.show()
             sleep(1)
             self._display.fill(0)
             sleep(0.5)
 
-            index += 1
-
         sleep(1)
         self._display.fill(0)

adafruit_ht16k33/bargraph.py

@@ -12,10 +12,6 @@
 
 from adafruit_ht16k33.ht16k33 import HT16K33
 
-try:
-    from typing import Optional
-except ImportError:
-    pass
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HT16K33.git"
@@ -29,14 +25,14 @@ class Bicolor24(HT16K33):
     LED_GREEN = 2
     LED_YELLOW = 3
 
-    def __getitem__(self, key: int) -> Optional[bool]:
+    def __getitem__(self, key: int) -> int:
         # map to HT16K33 row (x) and column (y), see schematic
         x = key % 4 + 4 * (key // 12)
         y = key // 4 - 3 * (key // 12)
         # construct the color value and return it
         return self._pixel(x, y) | self._pixel(x + 8, y) << 1
 
-    def __setitem__(self, key: int, value: bool) -> None:
+    def __setitem__(self, key: int, value: int) -> None:
         # map to HT16K33 row (x) and column (y), see schematic
         x = key % 4 + 4 * (key // 12)
         y = key // 4 - 3 * (key // 12)
@@ -45,10 +41,12 @@ def __setitem__(self, key: int, value: bool) -> None:
         # conditionally turn on green LED
         self._pixel(x + 8, y, value >> 1)
 
-    def fill(self, color: bool) -> None:
+    def fill(self, color: int) -> None:
         """Fill the whole display with the given color.
 
-        :param bool color: Whether to fill the display
+        :param int color: Whether to fill the display, where 0 is no
+            color, 1 is red, 2 is green, and 3 is yellow (red +
+            green)
         """
 
         what_it_was = self.auto_write

adafruit_ht16k33/ht16k33.py

@@ -20,6 +20,7 @@
 except ImportError:
     pass
 
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HT16K33.git"
 
@@ -33,8 +34,8 @@ class HT16K33:
     """
     The base class for all displays. Contains common methods.
 
-    :param I2C i2c: The I2C bus object
-    :param int address: The I2C addess of the HT16K33.
+    :param ~busio.I2C i2c: The I2C bus object
+    :param int|list|tuple address: The I2C addess(es) of the HT16K33.
     :param bool auto_write: True if the display should immediately change when
         set. If False, `show` must be called explicitly.
     :param float brightness: 0.0 - 1.0 default brightness level.
@@ -43,7 +44,7 @@ class HT16K33:
     def __init__(
         self,
         i2c: I2C,
-        address: Union[int, Tuple, List] = 0x70,
+        address: Union[int, List[int], Tuple[int, ...]] = 0x70,
         auto_write: bool = True,
         brightness: float = 1.0,
     ) -> None:
@@ -65,7 +66,7 @@ def __init__(
         self.blink_rate = 0
         self.brightness = brightness
 
-    def _write_cmd(self, byte: bytearray, i2c_index: int = 0) -> None:
+    def _write_cmd(self, byte: int, i2c_index: int = 0) -> None:
         self._temp[0] = byte
         with self.i2c_device[i2c_index]:
             self.i2c_device[i2c_index].write(self._temp)
@@ -76,7 +77,7 @@ def blink_rate(self) -> int:
         return self._blink_rate
 
     @blink_rate.setter
-    def blink_rate(self, rate: Optional[int] = None) -> None:
+    def blink_rate(self, rate: int) -> None:
         if not 0 <= rate <= 3:
             raise ValueError("Blink rate must be an integer in the range: 0-3")
         rate = rate & 0x03
@@ -156,8 +157,8 @@ def _pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]
             self.show()
         return None
 
-    def _set_buffer(self, i: int, value: bool) -> None:
+    def _set_buffer(self, i: int, value: int) -> None:
         self._buffer[i + 1] = value  # Offset by 1 to move past register address.
 
-    def _get_buffer(self, i: int) -> bool:
+    def _get_buffer(self, i: int) -> int:
         return self._buffer[i + 1]  # Offset by 1 to move past register address.

adafruit_ht16k33/matrix.py

@@ -11,12 +11,13 @@
 from adafruit_ht16k33.ht16k33 import HT16K33
 
 try:
-    from typing import Union, List, Tuple, Optional
+    from typing import Optional, Tuple, Union, List
+    from circuitpython_typing.pil import Image
     from busio import I2C
-    from PIL import Image
 except ImportError:
     pass
 
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HT16K33.git"
 
@@ -43,11 +44,11 @@ def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
         x = (x - 1) % 8
         return super()._pixel(x, y, color)
 
-    def __getitem__(self, key: int) -> Optional[bool]:
+    def __getitem__(self, key: Tuple[int, int]) -> Optional[bool]:
         x, y = key
         return self.pixel(x, y)
 
-    def __setitem__(self, key: int, value: bool) -> None:
+    def __setitem__(self, key: Tuple[int, int], value: Optional[bool]) -> None:
         x, y = key
         self.pixel(x, y, value)
 
@@ -173,7 +174,7 @@ class Matrix16x8(Matrix8x8):
     def __init__(
         self,
         i2c: I2C,
-        address: Union[int, Tuple, List] = 0x70,
+        address: Union[int, List[int], Tuple[int, ...]] = 0x70,
         auto_write: bool = True,
         brightness: float = 1.0,
     ) -> None:
@@ -229,14 +230,14 @@ class Matrix8x8x2(Matrix8x8):
     LED_GREEN = 2
     LED_YELLOW = 3
 
-    def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
+    def pixel(self, x: int, y: int, color: Optional[int] = None) -> Optional[int]:
         """Get or set the color of a given pixel.
 
         :param int x: The x coordinate of the pixel
         :param int y: The y coordinate of the pixel
-        :param bool color: (Optional) The state to set the pixel
+        :param int color: (Optional) The color to set the pixel
         :return: If ``color`` was not set, this returns the state of the pixel
-        :rtype: bool
+        :rtype: int
         """
         if not 0 <= x <= 7:
             return None
@@ -249,10 +250,10 @@ def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
             return super()._pixel(y, x) | super()._pixel(y + 8, x) << 1
         return None
 
-    def fill(self, color: bool) -> None:
+    def fill(self, color: int) -> None:
         """Fill the whole display with the given color.
 
-        :param bool color: Whether to fill the display
+        :param int color: The color to fill the display
         """
 
         fill1 = 0xFF if color & 0x01 else 0x00