Type annotate characteristics/string.py

Author: tekktrik

adafruit_ble/characteristics/string.py

@@ -10,9 +10,22 @@
 
 """
 
+from __future__ import annotations
+
 from . import Attribute
 from . import Characteristic
 
+try:
+    from typing import Optional, Type, Union, TYPE_CHECKING
+
+    if TYPE_CHECKING:
+        from circuitpython_typing import ReadableBuffer
+        from adafruit_ble.uuid import UUID
+        from adafruit_ble.services import Service
+
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"
 
@@ -23,12 +36,12 @@ class StringCharacteristic(Characteristic):
     def __init__(
         self,
         *,
-        uuid=None,
-        properties=Characteristic.READ,
-        read_perm=Attribute.OPEN,
-        write_perm=Attribute.OPEN,
-        initial_value=None
-    ):
+        uuid: Optional[UUID] = None,
+        properties: int = Characteristic.READ,
+        read_perm: int = Attribute.OPEN,
+        write_perm: int = Attribute.OPEN,
+        initial_value: Optional[ReadableBuffer] = None,
+    ) -> None:
         super().__init__(
             uuid=uuid,
             properties=properties,
@@ -39,19 +52,23 @@ def __init__(
             initial_value=initial_value,
         )
 
-    def __get__(self, obj, cls=None):
+    def __get__(
+        self, obj: Optional[Service], cls: Optional[Type[Service]] = None
+    ) -> Union[str, "StringCharacteristic"]:
         if obj is None:
             return self
         return str(super().__get__(obj, cls), "utf-8")
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: Service, value: str) -> None:
         super().__set__(obj, value.encode("utf-8"))
 
 
 class FixedStringCharacteristic(Characteristic):
     """Fixed strings are set once when bound and unchanged after."""
 
-    def __init__(self, *, uuid=None, read_perm=Attribute.OPEN):
+    def __init__(
+        self, *, uuid: Optional[UUID] = None, read_perm: int = Attribute.OPEN
+    ) -> None:
         super().__init__(
             uuid=uuid,
             properties=Characteristic.READ,
@@ -60,7 +77,9 @@ def __init__(self, *, uuid=None, read_perm=Attribute.OPEN):
             fixed_length=True,
         )
 
-    def __get__(self, obj, cls=None):
+    def __get__(
+        self, obj: Service, cls: Optional[Type[Service]] = None
+    ) -> Union[str, "FixedStringCharacteristic"]:
         if obj is None:
             return self
         return str(super().__get__(obj, cls), "utf-8")