Merge pull request #29 from tekktrik/doc/add-typing

Add type annotations, documentation tweaks

Author: TheKitty

adafruit_nunchuk.py

@@ -29,32 +29,37 @@
 from collections import namedtuple
 from adafruit_bus_device.i2c_device import I2CDevice
 
+try:
+    from typing import Type
+    from busio import I2C
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Nunchuk.git"
 
 _I2C_INIT_DELAY = 0.1
 
 
 class Nunchuk:
-    """
-    Class which provides interface to Nintendo Nunchuk controller.
+    """Class which provides interface to Nintendo Nunchuk controller.
 
-    :param i2c: The `busio.I2C` object to use.
-    :param address: The I2C address of the device. Default is 0x52.
-    :type address: int, optional
-    :param i2c_read_delay: The time in seconds to pause between the
+    :param ~I2C i2c: The `busio.I2C` object to use.
+    :param int address: (Optional) The I2C address of the device. Default is 0x52.
+    :param float i2c_read_delay: (Optional) The time in seconds to pause between the
         I2C write and read. This needs to be at least 200us. A
         conservative default of 2000us is used since some hosts may
         not be able to achieve such timing.
-    :type i2c_read_delay: float, optional
     """
 
     _Values = namedtuple("Values", ("joystick", "buttons", "acceleration"))
     _Joystick = namedtuple("Joystick", ("x", "y"))
     _Buttons = namedtuple("Buttons", ("C", "Z"))
     _Acceleration = namedtuple("Acceleration", ("x", "y", "z"))
 
-    def __init__(self, i2c, address=0x52, i2c_read_delay=0.002):
+    def __init__(
+        self, i2c: I2C, address: int = 0x52, i2c_read_delay: float = 0.002
+    ) -> None:
         self.buffer = bytearray(8)
         self.i2c_device = I2CDevice(i2c, address)
         self._i2c_read_delay = i2c_read_delay
@@ -67,7 +72,7 @@ def __init__(self, i2c, address=0x52, i2c_read_delay=0.002):
             i2c_dev.write(b"\xFB\x00")
 
     @property
-    def values(self):
+    def values(self) -> Type[tuple]:
         """The current state of all values."""
         self._read_data()
         return self._Values(
@@ -77,33 +82,33 @@ def values(self):
         )
 
     @property
-    def joystick(self):
+    def joystick(self) -> Type[tuple]:
         """The current joystick position."""
         return self._joystick()
 
     @property
-    def buttons(self):  # pylint: disable=invalid-name
-        """The current pressed state of button Z."""
+    def buttons(self) -> Type[tuple]:  # pylint: disable=invalid-name
+        """The current pressed state of buttons C and Z."""
         return self._buttons()
 
     @property
-    def acceleration(self):
+    def acceleration(self) -> Type[tuple]:
         """The current accelerometer reading."""
         return self._acceleration()
 
-    def _joystick(self, do_read=True):
+    def _joystick(self, do_read: bool = True) -> Type[tuple]:
         if do_read:
             self._read_data()
         return self._Joystick(self.buffer[0], self.buffer[1])  # x, y
 
-    def _buttons(self, do_read=True):
+    def _buttons(self, do_read: bool = True) -> Type[tuple]:
         if do_read:
             self._read_data()
         return self._Buttons(
             not bool(self.buffer[5] & 0x02), not bool(self.buffer[5] & 0x01)  # C  # Z
         )
 
-    def _acceleration(self, do_read=True):
+    def _acceleration(self, do_read: bool = True) -> Type[tuple]:
         if do_read:
             self._read_data()
         return self._Acceleration(
@@ -112,10 +117,10 @@ def _acceleration(self, do_read=True):
             ((self.buffer[5] & 0x0C) >> 2) | (self.buffer[4] << 2),  # az
         )
 
-    def _read_data(self):
+    def _read_data(self) -> bytearray:
         return self._read_register(b"\x00")
 
-    def _read_register(self, address):
+    def _read_register(self, address) -> bytearray:
         with self.i2c_device as i2c:
             i2c.write(address)
             time.sleep(self._i2c_read_delay)  # at least 200us