Merge pull request #46 from tekktrik/feature/add-typing

Add typing

Author: FoamyGuy

adafruit_mcp230xx/digital_inout.py

@@ -14,19 +14,26 @@
 
 import digitalio
 
+try:
+    from typing import Optional
+    from adafruit_mcp230xx.mcp23xxx import MCP23XXX
+    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: MCP23XXX) -> None:
         """Specify the pin number of the MCP230xx (0...7 for MCP23008, or 0...15
         for MCP23017) and MCP23008 instance.
         """
@@ -53,14 +60,16 @@ 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) -> None:
         """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
+    ) -> None:
         """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!
@@ -72,22 +81,22 @@ def switch_to_input(self, pull=None, invert_polarity=False, **kwargs):
     # pylint: enable=unused-argument
 
     @property
-    def value(self):
+    def value(self) -> bool:
         """The value of the pin, either True for high or False for
         low.  Note you must configure as an output or input appropriately
         before reading and writing this value.
         """
         return _get_bit(self._mcp.gpio, self._pin)
 
     @value.setter
-    def value(self, val):
+    def value(self, val: bool) -> None:
         if val:
             self._mcp.gpio = _enable_bit(self._mcp.gpio, self._pin)
         else:
             self._mcp.gpio = _clear_bit(self._mcp.gpio, self._pin)
 
     @property
-    def direction(self):
+    def direction(self) -> bool:
         """The direction of the pin, either True for an input or
         False for an output.
         """
@@ -96,7 +105,7 @@ def direction(self):
         return digitalio.Direction.OUTPUT
 
     @direction.setter
-    def direction(self, val):
+    def direction(self, val: Direction) -> None:
         if val == digitalio.Direction.INPUT:
             self._mcp.iodir = _enable_bit(self._mcp.iodir, self._pin)
         elif val == digitalio.Direction.OUTPUT:
@@ -105,7 +114,7 @@ def direction(self, val):
             raise ValueError("Expected INPUT or OUTPUT direction!")
 
     @property
-    def pull(self):
+    def pull(self) -> Optional[digitalio.Pull]:
         """Enable or disable internal pull-up resistors for this pin.  A
         value of digitalio.Pull.UP will enable a pull-up resistor, and None will
         disable it.  Pull-down resistors are NOT supported!
@@ -119,7 +128,7 @@ def pull(self):
         return None
 
     @pull.setter
-    def pull(self, val):
+    def pull(self, val: Pull) -> None:
         try:
             if val is None:
                 self._mcp.gppu = _clear_bit(self._mcp.gppu, self._pin)
@@ -134,7 +143,7 @@ def pull(self, val):
             raise ValueError("Pull-up/pull-down resistors not supported.") from error
 
     @property
-    def invert_polarity(self):
+    def invert_polarity(self) -> bool:
         """The polarity of the pin, either True for an Inverted or
         False for an normal.
         """
@@ -143,7 +152,7 @@ def invert_polarity(self):
         return False
 
     @invert_polarity.setter
-    def invert_polarity(self, val):
+    def invert_polarity(self, val: bool) -> None:
         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,9 @@ 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
+    ) -> None:
         super().__init__(i2c, address)
 
         if reset:
@@ -47,41 +55,41 @@ def __init__(self, i2c, address=_MCP23008_ADDRESS, reset=True):
             self._write_u8(_MCP23008_IPOL, 0x00)
 
     @property
-    def gpio(self):
+    def gpio(self) -> int:
         """The raw GPIO output register.  Each bit represents the
         output value of the associated pin (0 = low, 1 = high), assuming that
         pin has been configured as an output previously.
         """
         return self._read_u8(_MCP23008_GPIO)
 
     @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: int) -> None:
         self._write_u8(_MCP23008_GPIO, val)
 
     @property
-    def iodir(self):
+    def iodir(self) -> int:
         """The raw IODIR direction register.  Each bit represents
         direction of a pin, either 1 for an input or 0 for an output mode.
         """
         return self._read_u8(_MCP23008_IODIR)
 
     @iodir.setter
-    def iodir(self, val):
+    def iodir(self, val: int) -> None:
         self._write_u8(_MCP23008_IODIR, val)
 
     @property
-    def gppu(self):
+    def gppu(self) -> int:
         """The raw GPPU pull-up register.  Each bit represents
         if a pull-up is enabled on the specified pin (1 = pull-up enabled,
         0 = pull-up disabled).  Note pull-down resistors are NOT supported!
         """
         return self._read_u8(_MCP23008_GPPU)
 
     @gppu.setter
-    def gppu(self, val):
+    def gppu(self, val: int) -> None:
         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,9 @@ 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
+    ) -> None:
         super().__init__(i2c, address)
 
         if reset:
@@ -54,86 +62,86 @@ def __init__(self, i2c, address=_MCP23016_ADDRESS, reset=True):
             self._write_u16le(_MCP23016_IPOL0, 0x0000)
 
     @property
-    def gpio(self):
+    def gpio(self) -> int:
         """The raw GPIO output register.  Each bit represents the
         output value of the associated pin (0 = low, 1 = high), assuming that
         pin has been configured as an output previously.
         """
         return self._read_u16le(_MCP23016_GPIO0)
 
     @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: int) -> None:
         self._write_u16le(_MCP23016_GPIO0, val)
 
     @property
-    def gpioa(self):
+    def gpioa(self) -> int:
         """The raw GPIO 0 output register.  Each bit represents the
         output value of the associated pin (0 = low, 1 = high), assuming that
         pin has been configured as an output previously.
         """
         return self._read_u8(_MCP23016_GPIO0)
 
     @gpioa.setter
-    def gpioa(self, val):
+    def gpioa(self, val: int) -> None:
         self._write_u8(_MCP23016_GPIO0, val)
 
     @property
-    def gpiob(self):
+    def gpiob(self) -> int:
         """The raw GPIO 1 output register.  Each bit represents the
         output value of the associated pin (0 = low, 1 = high), assuming that
         pin has been configured as an output previously.
         """
         return self._read_u8(_MCP23016_GPIO1)
 
     @gpiob.setter
-    def gpiob(self, val):
+    def gpiob(self, val: int) -> None:
         self._write_u8(_MCP23016_GPIO1, val)
 
     @property
-    def iodir(self):
+    def iodir(self) -> int:
         """The raw IODIR direction register.  Each bit represents
         direction of a pin, either 1 for an input or 0 for an output mode.
         """
         return self._read_u16le(_MCP23016_IODIR0)
 
     @iodir.setter
-    def iodir(self, val):
+    def iodir(self, val: int) -> None:
         self._write_u16le(_MCP23016_IODIR0, val)
 
     @property
-    def iodira(self):
+    def iodira(self) -> int:
         """The raw IODIR0 direction register.  Each bit represents
         direction of a pin, either 1 for an input or 0 for an output mode.
         """
         return self._read_u8(_MCP23016_IODIR0)
 
     @iodira.setter
-    def iodira(self, val):
+    def iodira(self, val: int) -> None:
         self._write_u8(_MCP23016_IODIR0, val)
 
     @property
-    def iodirb(self):
+    def iodirb(self) -> int:
         """The raw IODIR0 direction register.  Each bit represents
         direction of a pin, either 1 for an input or 0 for an output mode.
         """
         return self._read_u8(_MCP23016_IODIR1)
 
     @iodirb.setter
-    def iodirb(self, val):
+    def iodirb(self, val: int) -> None:
         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.
         """
         if not 0 <= pin <= 15:
             raise ValueError("Pin number must be 0-15.")
         return DigitalInOut(pin, self)
 
-    def clear_inta(self):
+    def clear_inta(self) -> None:
         """Clears port 0 interrupts."""
         self._read_u8(_MCP23016_INTCAP0)
 
-    def clear_intb(self):
+    def clear_intb(self) -> None:
         """Clears port 1 interrupts."""
         self._read_u8(_MCP23016_INTCAP1)