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

Add type annotations

Author: tekktrik

adafruit_pybadger/clue.py

@@ -38,14 +38,19 @@
 
 Buttons = namedtuple("Buttons", "a b")
 
+try:
+    from typing import Type
+except ImportError:
+    pass
+
 
 class Clue(PyBadgerBase):
     """Class that represents a single CLUE."""
 
     _audio_out = audiopwmio.PWMAudioOut
     _neopixel_count = 1
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         i2c = board.I2C()
@@ -64,7 +69,7 @@ def __init__(self):
         self._buttons = KeyStates(self._keys)
 
     @property
-    def button(self):
+    def button(self) -> Type[tuple]:
         """The buttons on the board.
 
         Example use:

adafruit_pybadger/cpb_gizmo.py

@@ -38,6 +38,11 @@
 import neopixel
 from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates
 
+try:
+    from typing import Type
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git"
 
@@ -51,7 +56,7 @@ class CPB_Gizmo(PyBadgerBase):
     _audio_out = audiopwmio.PWMAudioOut
     _neopixel_count = 10
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         _i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA)
@@ -74,7 +79,7 @@ def __init__(self):
         self._light_sensor = analogio.AnalogIn(board.LIGHT)
 
     @property
-    def button(self):
+    def button(self) -> Type[tuple]:
         """The buttons on the board.
 
         Example use:

adafruit_pybadger/magtag.py

@@ -30,6 +30,11 @@
 import neopixel
 from adafruit_pybadger.pybadger_base import PyBadgerBase
 
+try:
+    from typing import Type
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git"
 
@@ -41,7 +46,7 @@ class MagTag(PyBadgerBase):
 
     _neopixel_count = 4
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         # NeoPixels
@@ -50,7 +55,7 @@ def __init__(self):
         )
 
     @property
-    def button(self):
+    def button(self) -> Type[tuple]:
         """The buttons on the board.
 
         Example use:

adafruit_pybadger/pewpewm4.py

@@ -31,6 +31,11 @@
 import keypad
 from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates
 
+try:
+    from typing import Type
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git"
 
@@ -43,7 +48,7 @@ class PewPewM4(PyBadgerBase):
     _audio_out = audioio.AudioOut
     _neopixel_count = 0
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         self._keys = keypad.Keys(
@@ -63,7 +68,7 @@ def __init__(self):
         self._buttons = KeyStates(self._keys)
 
     @property
-    def button(self):
+    def button(self) -> Type[tuple]:
         """The buttons on the board.
 
         Example use:

adafruit_pybadger/pybadge.py

@@ -40,6 +40,11 @@
 import neopixel
 from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates
 
+try:
+    from typing import Type
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git"
 
@@ -52,7 +57,7 @@ class PyBadge(PyBadgerBase):
     _audio_out = audioio.AudioOut
     _neopixel_count = 5
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         i2c = None
@@ -100,7 +105,7 @@ def __init__(self):
         self._light_sensor = analogio.AnalogIn(board.A7)
 
     @property
-    def button(self):
+    def button(self) -> Type[tuple]:
         """The buttons on the board.
 
         Example use: