missed adding actual code

Author: dhalbert

circuitpython_typing/__init__.py

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+"""
+`circuitpython_typing`
+================================================================================
+
+Types needed for type annotation that are not in `typing`
+
+
+* Author(s): Alec Delaney, Dan Halbert
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Typing.git"
+
+from typing import Union
+from array import array
+
+ReadableBuffer = Union[bytes, bytearray, memoryview, array]
+"""Classes that implement the readable buffer protocol
+  * `bytes`
+  * `bytearray`
+  * `memoryview`
+  * `array.array`
+"""
+
+WriteableBuffer = Union[bytearray, memoryview, array]
+"""Classes that implement the writeable buffer protocol
+  * `bytearray`
+  * `memoryview`
+  * `array.array`
+"""

circuitpython_typing/socket.py

@@ -0,0 +1,119 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Kevin Conley
+# SPDX-License-Identifier: MIT
+"""
+`circuitpython_typing.socket`
+================================================================================
+
+Type annotation definitions for sockets. Used for `adafruit_requests` and similar libraries.
+
+* Author(s): Kevin Conley
+"""
+
+from ssl import SSLContext
+from types import ModuleType
+from typing import Any, Optional, Protocol, Tuple, Union
+
+# Based on https://github.com/python/typeshed/blob/master/stdlib/_socket.pyi
+
+
+class CommonSocketType(Protocol):
+    """Describes the common structure every socket type must have."""
+
+    def send(self, data: bytes, flags: int = ...) -> None:
+        """Send data to the socket. The meaning of the optional flags kwarg is
+        implementation-specific."""
+        ...
+
+    def settimeout(self, value: Optional[float]) -> None:
+        """Set a timeout on blocking socket operations."""
+        ...
+
+    def close(self) -> None:
+        """Close the socket."""
+        ...
+
+
+class CommonCircuitPythonSocketType(CommonSocketType, Protocol):
+    """Describes the common structure every CircuitPython socket type must have."""
+
+    def connect(
+        self,
+        address: Tuple[str, int],
+        conntype: Optional[int] = ...,
+    ) -> None:
+        """Connect to a remote socket at the provided (host, port) address. The conntype
+        kwarg optionally may indicate SSL or not, depending on the underlying interface."""
+        ...
+
+
+class LegacyCircuitPythonSocketType(CommonCircuitPythonSocketType, Protocol):
+    """Describes the structure a legacy CircuitPython socket type must have."""
+
+    def recv(self, bufsize: int = ...) -> bytes:
+        """Receive data from the socket. The return value is a bytes object representing
+        the data received. The maximum amount of data to be received at once is specified
+        by bufsize."""
+        ...
+
+
+class SupportsRecvWithFlags(Protocol):
+    """Describes a type that posseses a socket recv() method supporting the flags kwarg."""
+
+    def recv(self, bufsize: int = ..., flags: int = ...) -> bytes:
+        """Receive data from the socket. The return value is a bytes object representing
+        the data received. The maximum amount of data to be received at once is specified
+        by bufsize. The meaning of the optional flags kwarg is implementation-specific."""
+        ...
+
+
+class SupportsRecvInto(Protocol):
+    """Describes a type that possesses a socket recv_into() method."""
+
+    def recv_into(self, buffer: bytearray, nbytes: int = ..., flags: int = ...) -> int:
+        """Receive up to nbytes bytes from the socket, storing the data into the provided
+        buffer. If nbytes is not specified (or 0), receive up to the size available in the
+        given buffer. The meaning of the optional flags kwarg is implementation-specific.
+        Returns the number of bytes received."""
+        ...
+
+
+class CircuitPythonSocketType(
+    CommonCircuitPythonSocketType,
+    SupportsRecvInto,
+    SupportsRecvWithFlags,
+    Protocol,
+):  # pylint: disable=too-many-ancestors
+    """Describes the structure every modern CircuitPython socket type must have."""
+
+    ...
+
+
+class StandardPythonSocketType(
+    CommonSocketType, SupportsRecvInto, SupportsRecvWithFlags, Protocol
+):
+    """Describes the structure every standard Python socket type must have."""
+
+    def connect(self, address: Union[Tuple[Any, ...], str, bytes]) -> None:
+        """Connect to a remote socket at the provided address."""
+        ...
+
+
+SocketType = Union[
+    LegacyCircuitPythonSocketType,
+    CircuitPythonSocketType,
+    StandardPythonSocketType,
+]
+
+SocketpoolModuleType = ModuleType
+
+
+class InterfaceType(Protocol):
+    """Describes the structure every interface type must have."""
+
+    @property
+    def TLS_MODE(self) -> int:  # pylint: disable=invalid-name
+        """Constant representing that a socket's connection mode is TLS."""
+        ...
+
+
+SSLContextType = Union[SSLContext, "_FakeSSLContext"]