Add type annotations

Author: tekktrik

adafruit_register/i2c_bcd_alarm.py

@@ -17,16 +17,27 @@
 
 import time
 
+try:
+    from typing import Optional, Type, Tuple
+    from typing_extensions import Literal
+    from circuitpython_typing.device_drivers import I2CDeviceDriver
 
-def _bcd2bin(value):
+    FREQUENCY_T = Literal[
+        "monthly", "weekly", "daily", "hourly", "secondly", "minutely"
+    ]
+except ImportError:
+    pass
+
+
+def _bcd2bin(value: int) -> int:
     """Convert binary coded decimal to Binary
 
     :param value: the BCD value to convert to binary (required, no default)
     """
     return value - 6 * (value >> 4)
 
 
-def _bin2bcd(value):
+def _bin2bcd(value: int) -> int:
     """Convert a binary value to binary coded decimal.
 
     :param value: the binary value to convert to BCD. (required, no default)
@@ -68,8 +79,12 @@ class BCDAlarmTimeRegister:
 
     # Defaults are based on alarm1 of the DS3231.
     def __init__(
-        self, register_address, has_seconds=True, weekday_shared=True, weekday_start=1
-    ):
+        self,
+        register_address: int,
+        has_seconds: bool = True,
+        weekday_shared: bool = True,
+        weekday_start: Literal[0, 1] = 1,
+    ) -> None:
         buffer_size = 5
         if weekday_shared:
             buffer_size -= 1
@@ -81,7 +96,11 @@ def __init__(
         self.weekday_shared = weekday_shared
         self.weekday_start = weekday_start
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> Tuple[time.struct_time, FREQUENCY_T]:
         # Read the alarm register.
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
@@ -136,7 +155,9 @@ def __get__(self, obj, objtype=None):
             frequency,
         )
 
-    def __set__(self, obj, value):
+    def __set__(
+        self, obj: I2CDeviceDriver, value: Tuple[time.struct_time, FREQUENCY_T]
+    ) -> None:
         if len(value) != 2:
             raise ValueError("Value must be sequence of length two")
         # Turn all components off by default.

adafruit_register/i2c_bcd_datetime.py

@@ -17,16 +17,23 @@
 
 import time
 
+try:
+    from typing import Optional, Type
+    from typing_extensions import Literal
+    from circuitpython_typing.device_drivers import I2CDeviceDriver
+except ImportError:
+    pass
 
-def _bcd2bin(value):
+
+def _bcd2bin(value: int) -> int:
     """Convert binary coded decimal to Binary
 
     :param value: the BCD value to convert to binary (required, no default)
     """
     return value - 6 * (value >> 4)
 
 
-def _bin2bcd(value):
+def _bin2bcd(value: int) -> int:
     """Convert a binary value to binary coded decimal.
 
     :param value: the binary value to convert to BCD. (required, no default)
@@ -52,7 +59,12 @@ class BCDDateTimeRegister:
         week
     """
 
-    def __init__(self, register_address, weekday_first=True, weekday_start=1):
+    def __init__(
+        self,
+        register_address: int,
+        weekday_first: bool = True,
+        weekday_start: Literal[0, 1] = 1,
+    ) -> None:
         self.buffer = bytearray(8)
         self.buffer[0] = register_address
         if weekday_first:
@@ -63,7 +75,11 @@ def __init__(self, register_address, weekday_first=True, weekday_start=1):
         # Masking value list   n/a  sec min hr day wkday mon year
         self.mask_datetime = b"\xFF\x7F\x7F\x3F\x3F\x07\x1F\xFF"
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> time.struct_time:
         # Read and return the date and time.
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
@@ -84,7 +100,7 @@ def __get__(self, obj, objtype=None):
             )
         )
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: time.struct_time) -> None:
         self.buffer[1] = _bin2bcd(value.tm_sec) & 0x7F  # format conversions
         self.buffer[2] = _bin2bcd(value.tm_min)
         self.buffer[3] = _bin2bcd(value.tm_hour)

adafruit_register/i2c_bit.py

@@ -15,6 +15,12 @@
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Register.git"
 
+try:
+    from typing import Optional, Type, NoReturn
+    from circuitpython_typing.device_drivers import I2CDeviceDriver
+except ImportError:
+    pass
+
 
 class RWBit:
     """
@@ -23,13 +29,19 @@ class RWBit:
     Values are `bool`
 
     :param int register_address: The register address to read the bit from
-    :param type bit: The bit index within the byte at ``register_address``
+    :param int bit: The bit index within the byte at ``register_address``
     :param int register_width: The number of bytes in the register. Defaults to 1.
     :param bool lsb_first: Is the first byte we read from I2C the LSB? Defaults to true
 
     """
 
-    def __init__(self, register_address, bit, register_width=1, lsb_first=True):
+    def __init__(
+        self,
+        register_address: int,
+        bit: int,
+        register_width: int = 1,
+        lsb_first: bool = True,
+    ) -> None:
         self.bit_mask = 1 << (bit % 8)  # the bitmask *within* the byte!
         self.buffer = bytearray(1 + register_width)
         self.buffer[0] = register_address
@@ -38,12 +50,16 @@ def __init__(self, register_address, bit, register_width=1, lsb_first=True):
         else:
             self.byte = register_width - (bit // 8)  # the byte number within the buffer
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> bool:
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
         return bool(self.buffer[self.byte] & self.bit_mask)
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: bool) -> None:
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
             if value:
@@ -64,5 +80,5 @@ class ROBit(RWBit):
 
     """
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: bool) -> NoReturn:
         raise AttributeError()

adafruit_register/i2c_bits.py

@@ -15,6 +15,12 @@
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Register.git"
 
+try:
+    from typing import Optional, Type, NoReturn
+    from circuitpython_typing.device_drivers import I2CDeviceDriver
+except ImportError:
+    pass
+
 
 class RWBits:
     """
@@ -25,7 +31,7 @@ class RWBits:
 
     :param int num_bits: The number of bits in the field.
     :param int register_address: The register address to read the bit from
-    :param type lowest_bit: The lowest bits index within the byte at ``register_address``
+    :param int lowest_bit: The lowest bits index within the byte at ``register_address``
     :param int register_width: The number of bytes in the register. Defaults to 1.
     :param bool lsb_first: Is the first byte we read from I2C the LSB? Defaults to true
     :param bool signed: If True, the value is a "two's complement" signed value.
@@ -34,13 +40,13 @@ class RWBits:
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        num_bits,
-        register_address,
-        lowest_bit,
-        register_width=1,
-        lsb_first=True,
-        signed=False,
-    ):
+        num_bits: int,
+        register_address: int,
+        lowest_bit: int,
+        register_width: int = 1,
+        lsb_first: bool = True,
+        signed: bool = False,
+    ) -> None:
         self.bit_mask = ((1 << num_bits) - 1) << lowest_bit
         # print("bitmask: ",hex(self.bit_mask))
         if self.bit_mask >= 1 << (register_width * 8):
@@ -51,7 +57,11 @@ def __init__(  # pylint: disable=too-many-arguments
         self.lsb_first = lsb_first
         self.sign_bit = (1 << (num_bits - 1)) if signed else 0
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> int:
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
         # read the number of bytes into a single variable
@@ -67,7 +77,7 @@ def __get__(self, obj, objtype=None):
             reg -= 2 * self.sign_bit
         return reg
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: int) -> None:
         value <<= self.lowest_bit  # shift the value over to the right spot
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
@@ -100,5 +110,5 @@ class ROBits(RWBits):
     :param int register_width: The number of bytes in the register. Defaults to 1.
     """
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: int) -> NoReturn:
         raise AttributeError()

adafruit_register/i2c_struct.py

@@ -12,11 +12,17 @@
 * Author(s): Scott Shawcroft
 """
 
-import struct
-
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Register.git"
 
+import struct
+
+try:
+    from typing import Optional, Type, Tuple, Any, NoReturn
+    from circuitpython_typing.device_drivers import I2CDeviceDriver
+except ImportError:
+    pass
+
 
 class Struct:
     """
@@ -26,20 +32,24 @@ class Struct:
     module documentation for struct format string and its possible value types.
 
     :param int register_address: The register address to read the bit from
-    :param type struct_format: The struct format string for this register.
+    :param str struct_format: The struct format string for this register.
     """
 
-    def __init__(self, register_address, struct_format):
+    def __init__(self, register_address: int, struct_format: str) -> None:
         self.format = struct_format
         self.buffer = bytearray(1 + struct.calcsize(self.format))
         self.buffer[0] = register_address
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> Tuple:
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1)
         return struct.unpack_from(self.format, memoryview(self.buffer)[1:])
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: Tuple) -> None:
         struct.pack_into(self.format, self.buffer, 1, *value)
         with obj.i2c_device as i2c:
             i2c.write(self.buffer)
@@ -53,21 +63,25 @@ class UnaryStruct:
     module documentation for struct format string and its possible value types.
 
     :param int register_address: The register address to read the bit from
-    :param type struct_format: The struct format string for this register.
+    :param str struct_format: The struct format string for this register.
     """
 
-    def __init__(self, register_address, struct_format):
+    def __init__(self, register_address: int, struct_format: str) -> None:
         self.format = struct_format
         self.address = register_address
 
-    def __get__(self, obj, objtype=None):
+    def __get__(
+        self,
+        obj: Optional[I2CDeviceDriver],
+        objtype: Optional[Type[I2CDeviceDriver]] = None,
+    ) -> Any:
         buf = bytearray(1 + struct.calcsize(self.format))
         buf[0] = self.address
         with obj.i2c_device as i2c:
             i2c.write_then_readinto(buf, buf, out_end=1, in_start=1)
         return struct.unpack_from(self.format, buf, 1)[0]
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: Any) -> None:
         buf = bytearray(1 + struct.calcsize(self.format))
         buf[0] = self.address
         struct.pack_into(self.format, buf, 1, value)
@@ -86,5 +100,5 @@ class ROUnaryStruct(UnaryStruct):
     :param type struct_format: The struct format string for this register.
     """
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: I2CDeviceDriver, value: Any) -> NoReturn:
         raise AttributeError()