Annotate services/nordic.py

Author: tekktrik

adafruit_ble/services/nordic.py

@@ -11,10 +11,22 @@
 
 """
 
+from __future__ import annotations
+
 from . import Service
 from ..uuid import VendorUUID
 from ..characteristics.stream import StreamOut, StreamIn
 
+try:
+    from typing import Optional, TYPE_CHECKING
+
+    if TYPE_CHECKING:
+        from circuitpython_typing import WriteableBuffer, ReadableBuffer
+        import _bleio
+
+except ImportError:
+    pass
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"
 
@@ -39,7 +51,7 @@ class UARTService(Service):
         buffer_size=64,
     )
 
-    def __init__(self, service=None):
+    def __init__(self, service: Optional[_bleio.Service] = None) -> None:
         super().__init__(service=service)
         self.connectable = True
         if not service:
@@ -50,7 +62,7 @@ def __init__(self, service=None):
             self._tx = self._server_rx
             self._rx = self._server_tx
 
-    def read(self, nbytes=None):
+    def read(self, nbytes: Optional[int] = None) -> Optional[bytes]:
         """
         Read characters. If ``nbytes`` is specified then read at most that many bytes.
         Otherwise, read everything that arrives until the connection times out.
@@ -61,7 +73,9 @@ def read(self, nbytes=None):
         """
         return self._rx.read(nbytes)
 
-    def readinto(self, buf, nbytes=None):
+    def readinto(
+        self, buf: WriteableBuffer, nbytes: Optional[int] = None
+    ) -> Optional[int]:
         """
         Read bytes into the ``buf``. If ``nbytes`` is specified then read at most
         that many bytes. Otherwise, read at most ``len(buf)`` bytes.
@@ -71,7 +85,7 @@ def readinto(self, buf, nbytes=None):
         """
         return self._rx.readinto(buf, nbytes)
 
-    def readline(self):
+    def readline(self) -> Optional[bytes]:
         """
         Read a line, ending in a newline character.
 
@@ -81,14 +95,14 @@ def readline(self):
         return self._rx.readline()
 
     @property
-    def in_waiting(self):
+    def in_waiting(self) -> int:
         """The number of bytes in the input buffer, available to be read."""
         return self._rx.in_waiting
 
-    def reset_input_buffer(self):
+    def reset_input_buffer(self) -> None:
         """Discard any unread characters in the input buffer."""
         self._rx.reset_input_buffer()
 
-    def write(self, buf):
+    def write(self, buf: ReadableBuffer) -> None:
         """Write a buffer of bytes."""
         self._tx.write(buf)