Merge pull request #7 from tekktrik/dev/add-driver-class

Add I2CDeviceDriver duck type

Author: tannewt

circuitpython_typing/device_drivers.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney
+# SPDX-License-Identifier: MIT
+"""
+`circuitpython_typing.device_drivers`
+================================================================================
+
+Type annotation definitions for device drivers. Used for `adafruit_register`.
+
+* Author(s): Alec Delaney
+"""
+
+from adafruit_bus_device import I2CDevice
+
+# # Protocol was introduced in Python 3.8.
+try:
+    from typing import Protocol
+except ImportError:
+    from typing_extensions import Protocol
+
+
+# pylint: disable=too-few-public-methods
+class I2CDeviceDriver(Protocol):
+    """Describes classes that are drivers utilizing `I2CDevice`"""
+
+    i2c_device: I2CDevice

requirements.txt

@@ -4,3 +4,4 @@
 # SPDX-License-Identifier: MIT
 
 typing_extensions; python_version <= '3.7'
+adafruit-circuitpython-busdevice

setup.py

@@ -39,7 +39,10 @@
     # Author details
     author="Adafruit Industries",
     author_email="[email protected]",
-    install_requires=["typing_extensions; python_version <= '3.7'"],
+    install_requires=[
+        "typing_extensions; python_version <= '3.7'",
+        "adafruit-circuitpython-busdevice",
+    ],
     # Choose your license
     license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers