Add type hints

Using digitalio.DigitalInOut long form where appropriate so it's not confused with the library's custom version of it, and doesn't have an impact on existing code

Author: tekktrik

adafruit_mcp230xx/digital_inout.py

@@ -14,19 +14,26 @@
 
 import digitalio
 
+try:
+    import typing # pylint: disable=unused-import
+    from adafruit_mcp230xx.mcp230xx import MCP230XX
+    from digitalio import Pull, Direction
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx.git"
 
 # Internal helpers to simplify setting and getting a bit inside an integer.
-def _get_bit(val, bit):
+def _get_bit(val, bit: int) -> int:
     return val & (1 << bit) > 0
 
 
-def _enable_bit(val, bit):
+def _enable_bit(val, bit: int) -> int:
     return val | (1 << bit)
 
 
-def _clear_bit(val, bit):
+def _clear_bit(val, bit: int) -> int:
     return val & ~(1 << bit)
 
 
@@ -41,7 +48,7 @@ class DigitalInOut:
     configurations.
     """
 
-    def __init__(self, pin_number, mcp230xx):
+    def __init__(self, pin_number: int, mcp230xx: MCP230XX):
         """Specify the pin number of the MCP230xx (0...7 for MCP23008, or 0...15
         for MCP23017) and MCP23008 instance.
         """
@@ -53,14 +60,14 @@ def __init__(self, pin_number, mcp230xx):
     # is unused by this class).  Do not remove them, instead turn off pylint
     # in this case.
     # pylint: disable=unused-argument
-    def switch_to_output(self, value=False, **kwargs):
+    def switch_to_output(self, value: bool = False, **kwargs):
         """Switch the pin state to a digital output with the provided starting
         value (True/False for high or low, default is False/low).
         """
         self.direction = digitalio.Direction.OUTPUT
         self.value = value
 
-    def switch_to_input(self, pull=None, invert_polarity=False, **kwargs):
+    def switch_to_input(self, pull: Pull = None, invert_polarity: bool = False, **kwargs):
         """Switch the pin state to a digital input with the provided starting
         pull-up resistor state (optional, no pull-up by default) and input polarity.  Note that
         pull-down resistors are NOT supported!
@@ -80,7 +87,7 @@ def value(self):
         return _get_bit(self._mcp.gpio, self._pin)
 
     @value.setter
-    def value(self, val):
+    def value(self, val: bool):
         if val:
             self._mcp.gpio = _enable_bit(self._mcp.gpio, self._pin)
         else:
@@ -96,7 +103,7 @@ def direction(self):
         return digitalio.Direction.OUTPUT
 
     @direction.setter
-    def direction(self, val):
+    def direction(self, val: Direction):
         if val == digitalio.Direction.INPUT:
             self._mcp.iodir = _enable_bit(self._mcp.iodir, self._pin)
         elif val == digitalio.Direction.OUTPUT:
@@ -119,7 +126,7 @@ def pull(self):
         return None
 
     @pull.setter
-    def pull(self, val):
+    def pull(self, val: Pull):
         try:
             if val is None:
                 self._mcp.gppu = _clear_bit(self._mcp.gppu, self._pin)
@@ -143,7 +150,7 @@ def invert_polarity(self):
         return False
 
     @invert_polarity.setter
-    def invert_polarity(self, val):
+    def invert_polarity(self, val: bool):
         if val:
             self._mcp.ipol = _enable_bit(self._mcp.ipol, self._pin)
         else:

adafruit_mcp230xx/mcp23008.py

@@ -16,6 +16,12 @@
 from .mcp230xx import MCP230XX
 from .digital_inout import DigitalInOut
 
+try:
+    import typing # pylint: disable=unused-import
+    from busio import I2C
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx.git"
 
@@ -37,7 +43,7 @@ class MCP23008(MCP230XX):
     at the specified I2C address.
     """
 
-    def __init__(self, i2c, address=_MCP23008_ADDRESS, reset=True):
+    def __init__(self, i2c: I2C, address: int = _MCP23008_ADDRESS, reset: bool = True):
         super().__init__(i2c, address)
 
         if reset:
@@ -55,7 +61,7 @@ def gpio(self):
         return self._read_u8(_MCP23008_GPIO)
 
     @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: int):
         self._write_u8(_MCP23008_GPIO, val)
 
     @property
@@ -66,7 +72,7 @@ def iodir(self):
         return self._read_u8(_MCP23008_IODIR)
 
     @iodir.setter
-    def iodir(self, val):
+    def iodir(self, val: int):
         self._write_u8(_MCP23008_IODIR, val)
 
     @property
@@ -78,10 +84,10 @@ def gppu(self):
         return self._read_u8(_MCP23008_GPPU)
 
     @gppu.setter
-    def gppu(self, val):
+    def gppu(self, val: int):
         self._write_u8(_MCP23008_GPPU, val)
 
-    def get_pin(self, pin):
+    def get_pin(self, pin: int) -> DigitalInOut:
         """Convenience function to create an instance of the DigitalInOut class
         pointing at the specified pin of this MCP23008 device.
         """

adafruit_mcp230xx/mcp23016.py

@@ -24,6 +24,12 @@
 from .mcp230xx import MCP230XX
 from .digital_inout import DigitalInOut
 
+try:
+    import typing # pylint: disable=unused-import
+    from busio import I2C
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx.git"
 
@@ -45,7 +51,7 @@ class MCP23016(MCP230XX):
     at the specified I2C address.
     """
 
-    def __init__(self, i2c, address=_MCP23016_ADDRESS, reset=True):
+    def __init__(self, i2c: I2C, address: int = _MCP23016_ADDRESS, reset: bool = True):
         super().__init__(i2c, address)
 
         if reset:
@@ -62,7 +68,7 @@ def gpio(self):
         return self._read_u16le(_MCP23016_GPIO0)
 
     @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: int):
         self._write_u16le(_MCP23016_GPIO0, val)
 
     @property
@@ -74,7 +80,7 @@ def gpioa(self):
         return self._read_u8(_MCP23016_GPIO0)
 
     @gpioa.setter
-    def gpioa(self, val):
+    def gpioa(self, val: int):
         self._write_u8(_MCP23016_GPIO0, val)
 
     @property
@@ -86,7 +92,7 @@ def gpiob(self):
         return self._read_u8(_MCP23016_GPIO1)
 
     @gpiob.setter
-    def gpiob(self, val):
+    def gpiob(self, val: int):
         self._write_u8(_MCP23016_GPIO1, val)
 
     @property
@@ -97,7 +103,7 @@ def iodir(self):
         return self._read_u16le(_MCP23016_IODIR0)
 
     @iodir.setter
-    def iodir(self, val):
+    def iodir(self, val: int):
         self._write_u16le(_MCP23016_IODIR0, val)
 
     @property
@@ -108,7 +114,7 @@ def iodira(self):
         return self._read_u8(_MCP23016_IODIR0)
 
     @iodira.setter
-    def iodira(self, val):
+    def iodira(self, val: int):
         self._write_u8(_MCP23016_IODIR0, val)
 
     @property
@@ -119,10 +125,10 @@ def iodirb(self):
         return self._read_u8(_MCP23016_IODIR1)
 
     @iodirb.setter
-    def iodirb(self, val):
+    def iodirb(self, val: int):
         self._write_u8(_MCP23016_IODIR1, val)
 
-    def get_pin(self, pin):
+    def get_pin(self, pin: int) -> DigitalInOut:
         """Convenience function to create an instance of the DigitalInOut class
         pointing at the specified pin of this MCP23016 device.
         """

adafruit_mcp230xx/mcp23017.py

@@ -18,6 +18,12 @@
 from .mcp230xx import MCP230XX
 from .digital_inout import DigitalInOut
 
+try:
+    import typing # pylint: disable=unused-import
+    from busio import I2C
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx.git"
 
@@ -45,7 +51,7 @@ class MCP23017(MCP230XX):
     at the specified I2C address.
     """
 
-    def __init__(self, i2c, address=_MCP23017_ADDRESS, reset=True):
+    def __init__(self, i2c: I2C, address: int = _MCP23017_ADDRESS, reset: bool = True):
         super().__init__(i2c, address)
         if reset:
             # Reset to all inputs with no pull-ups and no inverted polarity.
@@ -63,7 +69,7 @@ def gpio(self):
         return self._read_u16le(_MCP23017_GPIOA)
 
     @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: int):
         self._write_u16le(_MCP23017_GPIOA, val)
 
     @property
@@ -75,7 +81,7 @@ def gpioa(self):
         return self._read_u8(_MCP23017_GPIOA)
 
     @gpioa.setter
-    def gpioa(self, val):
+    def gpioa(self, val: int):
         self._write_u8(_MCP23017_GPIOA, val)
 
     @property
@@ -87,7 +93,7 @@ def gpiob(self):
         return self._read_u8(_MCP23017_GPIOB)
 
     @gpiob.setter
-    def gpiob(self, val):
+    def gpiob(self, val: int):
         self._write_u8(_MCP23017_GPIOB, val)
 
     @property
@@ -98,7 +104,7 @@ def iodir(self):
         return self._read_u16le(_MCP23017_IODIRA)
 
     @iodir.setter
-    def iodir(self, val):
+    def iodir(self, val: int):
         self._write_u16le(_MCP23017_IODIRA, val)
 
     @property
@@ -109,7 +115,7 @@ def iodira(self):
         return self._read_u8(_MCP23017_IODIRA)
 
     @iodira.setter
-    def iodira(self, val):
+    def iodira(self, val: int):
         self._write_u8(_MCP23017_IODIRA, val)
 
     @property
@@ -120,7 +126,7 @@ def iodirb(self):
         return self._read_u8(_MCP23017_IODIRB)
 
     @iodirb.setter
-    def iodirb(self, val):
+    def iodirb(self, val: int):
         self._write_u8(_MCP23017_IODIRB, val)
 
     @property
@@ -132,7 +138,7 @@ def gppu(self):
         return self._read_u16le(_MCP23017_GPPUA)
 
     @gppu.setter
-    def gppu(self, val):
+    def gppu(self, val: int):
         self._write_u16le(_MCP23017_GPPUA, val)
 
     @property
@@ -144,7 +150,7 @@ def gppua(self):
         return self._read_u8(_MCP23017_GPPUA)
 
     @gppua.setter
-    def gppua(self, val):
+    def gppua(self, val: int):
         self._write_u8(_MCP23017_GPPUA, val)
 
     @property
@@ -156,10 +162,10 @@ def gppub(self):
         return self._read_u8(_MCP23017_GPPUB)
 
     @gppub.setter
-    def gppub(self, val):
+    def gppub(self, val: int):
         self._write_u8(_MCP23017_GPPUB, val)
 
-    def get_pin(self, pin):
+    def get_pin(self, pin: int) -> DigitalInOut:
         """Convenience function to create an instance of the DigitalInOut class
         pointing at the specified pin of this MCP23017 device.
         """
@@ -176,7 +182,7 @@ def ipol(self):
         return self._read_u16le(_MCP23017_IPOLA)
 
     @ipol.setter
-    def ipol(self, val):
+    def ipol(self, val: int):
         self._write_u16le(_MCP23017_IPOLA, val)
 
     @property
@@ -188,7 +194,7 @@ def ipola(self):
         return self._read_u8(_MCP23017_IPOLA)
 
     @ipola.setter
-    def ipola(self, val):
+    def ipola(self, val: int):
         self._write_u8(_MCP23017_IPOLA, val)
 
     @property
@@ -200,7 +206,7 @@ def ipolb(self):
         return self._read_u8(_MCP23017_IPOLB)
 
     @ipolb.setter
-    def ipolb(self, val):
+    def ipolb(self, val: int):
         self._write_u8(_MCP23017_IPOLB, val)
 
     @property
@@ -215,7 +221,7 @@ def interrupt_configuration(self):
         return self._read_u16le(_MCP23017_INTCONA)
 
     @interrupt_configuration.setter
-    def interrupt_configuration(self, val):
+    def interrupt_configuration(self, val: int):
         self._write_u16le(_MCP23017_INTCONA, val)
 
     @property
@@ -229,7 +235,7 @@ def interrupt_enable(self):
         return self._read_u16le(_MCP23017_GPINTENA)
 
     @interrupt_enable.setter
-    def interrupt_enable(self, val):
+    def interrupt_enable(self, val: int):
         self._write_u16le(_MCP23017_GPINTENA, val)
 
     @property
@@ -242,7 +248,7 @@ def default_value(self):
         return self._read_u16le(_MCP23017_DEFVALA)
 
     @default_value.setter
-    def default_value(self, val):
+    def default_value(self, val: int):
         self._write_u16le(_MCP23017_DEFVALA, val)
 
     @property
@@ -258,7 +264,7 @@ def io_control(self):
         return self._read_u8(_MCP23017_IOCON)
 
     @io_control.setter
-    def io_control(self, val):
+    def io_control(self, val: int):
         val &= ~0x80
         self._write_u8(_MCP23017_IOCON, val)