Merge pull request #56 from tekktrik/doc/use-circuitpython-typing

Use circuitpython_typing.FillBasedLED instead of custom Pixel protocol

Author: FoamyGuy

adafruit_espatcontrol/adafruit_espatcontrol_wifimanager.py

@@ -18,27 +18,8 @@
 
 try:
     from typing import Dict, Any, Optional, Union, Tuple
-
-    try:
-        from typing import Protocol
-    except ImportError:
-        from typing_extensions import Protocol
+    from circuitpython_typing.led import FillBasedLED
     from adafruit_espatcontrol.adafruit_espatcontrol import ESP_ATcontrol
-
-    class Pixel(Protocol):
-        """
-        A class for providing type hints for parameters
-        requiring a pixel device (NeoPixel/DotStar)
-        """
-
-        def fill(  # pylint: disable=unused-argument, no-self-use
-            self, value: Union[int, Tuple[int, int, int]]
-        ) -> Any:
-            """
-            Duck types out the fill method for pixel devices
-            """
-            ...
-
 except ImportError:
     pass
 
@@ -52,7 +33,7 @@ def __init__(
         self,
         esp: ESP_ATcontrol,
         secrets: Dict[str, Union[str, int]],
-        status_pixel: Optional[Pixel] = None,
+        status_pixel: Optional[FillBasedLED] = None,
         attempts: int = 2,
     ):
         """

requirements.txt

@@ -3,4 +3,5 @@
 # SPDX-License-Identifier: Unlicense
 
 Adafruit-Blinka
+adafruit-circuitpython-typing>=1.4.0
 pyserial

setup.py

@@ -34,7 +34,11 @@
     # Author details
     author="Adafruit Industries",
     author_email="[email protected]",
-    install_requires=["Adafruit-Blinka", "pyserial"],
+    install_requires=[
+        "Adafruit-Blinka",
+        "adafruit-circuitpython-typing>=1.4.0",
+        "pyserial",
+    ],
     # Choose your license
     license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers