diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 77ed663..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,47 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 24.2.0 - hooks: - - id: black - - repo: https://github.com/PyCQA/isort - rev: 5.13.2 - hooks: - - id: isort - args: ["--profile", "black", "--filter-files"] - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 + hooks: + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=consider-using-f-string,duplicate-code,missing-docstring,invalid-name - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=consider-using-f-string,duplicate-code,missing-docstring,invalid-name,protected-access + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b79ec5b..ee38fa0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,11 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" diff --git a/README.rst b/README.rst index 430b784..f9af7b3 100644 --- a/README.rst +++ b/README.rst @@ -17,9 +17,9 @@ Introduction :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff A urllib3.poolmanager/urllib3.connectionpool-like library for managing sockets and connections diff --git a/adafruit_connection_manager.py b/adafruit_connection_manager.py index 9dc8f51..ec9f9c4 100644 --- a/adafruit_connection_manager.py +++ b/adafruit_connection_manager.py @@ -21,8 +21,6 @@ """ -# imports - __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager.git" @@ -31,9 +29,6 @@ WIZNET5K_SSL_SUPPORT_VERSION = (9, 1) -# typing - - if not sys.implementation.name == "circuitpython": from typing import List, Optional, Tuple @@ -46,9 +41,6 @@ ) -# ssl and pool helpers - - class _FakeSSLSocket: def __init__(self, socket: CircuitPythonSocketType, tls_mode: int) -> None: self._socket = socket @@ -58,6 +50,10 @@ def __init__(self, socket: CircuitPythonSocketType, tls_mode: int) -> None: self.recv = socket.recv self.close = socket.close self.recv_into = socket.recv_into + # For sockets that come from software socketpools (like the esp32api), they track + # the interface and socket pool. We need to make sure the clones do as well + self._interface = getattr(socket, "_interface", None) + self._socket_pool = getattr(socket, "_socket_pool", None) def connect(self, address: Tuple[str, int]) -> None: """Connect wrapper to add non-standard mode parameter""" @@ -71,14 +67,14 @@ class _FakeSSLContext: def __init__(self, iface: InterfaceType) -> None: self._iface = iface - def wrap_socket( # pylint: disable=unused-argument + def wrap_socket( self, socket: CircuitPythonSocketType, server_hostname: Optional[str] = None ) -> _FakeSSLSocket: """Return the same socket""" if hasattr(self._iface, "TLS_MODE"): return _FakeSSLSocket(socket, self._iface.TLS_MODE) - raise AttributeError("This radio does not support TLS/HTTPS") + raise ValueError("This radio does not support TLS/HTTPS") def create_fake_ssl_context( @@ -94,17 +90,32 @@ def create_fake_ssl_context( * `Adafruit AirLift FeatherWing – ESP32 WiFi Co-Processor `_ """ - socket_pool.set_interface(iface) + if hasattr(socket_pool, "set_interface"): + # this is to manually support legacy hardware like the fona + socket_pool.set_interface(iface) + return _FakeSSLContext(iface) +class CPythonNetwork: + """Radio object to use when using ConnectionManager in CPython.""" + + _global_connection_managers = {} +_global_key_by_socketpool = {} _global_socketpools = {} _global_ssl_contexts = {} +def _get_radio_hash_key(radio): + try: + return hash(radio) + except TypeError: + return radio.__class__.__name__ + + def get_radio_socketpool(radio): - """Helper to get a socket pool for common boards + """Helper to get a socket pool for common boards. Currently supported: @@ -112,35 +123,43 @@ def get_radio_socketpool(radio): * Using the ESP32 WiFi Co-Processor (like the Adafruit AirLift) * Using a WIZ5500 (Like the Adafruit Ethernet FeatherWing) """ - class_name = radio.__class__.__name__ - if class_name not in _global_socketpools: + key = _get_radio_hash_key(radio) + if key not in _global_socketpools: + class_name = radio.__class__.__name__ if class_name == "Radio": - import ssl # pylint: disable=import-outside-toplevel + import ssl - import socketpool # pylint: disable=import-outside-toplevel + import socketpool pool = socketpool.SocketPool(radio) ssl_context = ssl.create_default_context() elif class_name == "ESP_SPIcontrol": - import adafruit_esp32spi.adafruit_esp32spi_socket as pool # pylint: disable=import-outside-toplevel + import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool + pool = socketpool.SocketPool(radio) ssl_context = create_fake_ssl_context(pool, radio) elif class_name == "WIZNET5K": - import adafruit_wiznet5k.adafruit_wiznet5k_socket as pool # pylint: disable=import-outside-toplevel + import adafruit_wiznet5k.adafruit_wiznet5k_socketpool as socketpool + + pool = socketpool.SocketPool(radio) # Note: At this time, SSL/TLS connections are not supported by older # versions of the Wiznet5k library or on boards withouut the ssl module # see https://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html ssl_context = None - cp_version = sys.implementation[1] - if pool.SOCK_STREAM == 1 and cp_version >= WIZNET5K_SSL_SUPPORT_VERSION: + implementation_name = sys.implementation.name + implementation_version = sys.implementation.version + if ( + pool.SOCK_STREAM == 1 + and implementation_name == "circuitpython" + and implementation_version >= WIZNET5K_SSL_SUPPORT_VERSION + ): try: - import ssl # pylint: disable=import-outside-toplevel + import ssl ssl_context = ssl.create_default_context() - pool.set_interface(radio) except ImportError: # if SSL not on board, default to fake_ssl_context pass @@ -148,17 +167,24 @@ def get_radio_socketpool(radio): if ssl_context is None: ssl_context = create_fake_ssl_context(pool, radio) + elif class_name == "CPythonNetwork": + import socket as pool + import ssl + + ssl_context = ssl.create_default_context() + else: - raise AttributeError(f"Unsupported radio class: {class_name}") + raise ValueError(f"Unsupported radio class: {class_name}") - _global_socketpools[class_name] = pool - _global_ssl_contexts[class_name] = ssl_context + _global_key_by_socketpool[pool] = key + _global_socketpools[key] = pool + _global_ssl_contexts[key] = ssl_context - return _global_socketpools[class_name] + return _global_socketpools[key] def get_radio_ssl_context(radio): - """Helper to get ssl_contexts for common boards + """Helper to get ssl_contexts for common boards. Currently supported: @@ -166,16 +192,12 @@ def get_radio_ssl_context(radio): * Using the ESP32 WiFi Co-Processor (like the Adafruit AirLift) * Using a WIZ5500 (Like the Adafruit Ethernet FeatherWing) """ - class_name = radio.__class__.__name__ get_radio_socketpool(radio) - return _global_ssl_contexts[class_name] - - -# main class + return _global_ssl_contexts[_get_radio_hash_key(radio)] class ConnectionManager: - """Connection manager for sharing open sockets (aka connections).""" + """A library for managing sockets across multiple hardware platforms and libraries.""" def __init__( self, @@ -197,7 +219,12 @@ def _free_sockets(self, force: bool = False) -> None: for socket in open_sockets: self.close_socket(socket) - def _get_connected_socket( # pylint: disable=too-many-arguments + def _register_connected_socket(self, key, socket): + """Register a socket as managed.""" + self._key_by_managed_socket[socket] = key + self._managed_socket_by_key[key] = socket + + def _get_connected_socket( self, addr_info: List[Tuple[int, int, int, str, Tuple[str, int]]], host: str, @@ -206,38 +233,42 @@ def _get_connected_socket( # pylint: disable=too-many-arguments is_ssl: bool, ssl_context: Optional[SSLContextType] = None, ): - try: - socket = self._socket_pool.socket(addr_info[0], addr_info[1]) - except (OSError, RuntimeError) as exc: - return exc + socket = self._socket_pool.socket(addr_info[0], addr_info[1]) if is_ssl: socket = ssl_context.wrap_socket(socket, server_hostname=host) connect_host = host else: connect_host = addr_info[-1][0] - socket.settimeout(timeout) # socket read timeout + + # Set socket read and connect timeout. + socket.settimeout(timeout) try: socket.connect((connect_host, port)) - except (MemoryError, OSError) as exc: + except (MemoryError, OSError): + # If any connect problems, clean up and re-raise the problem exception. socket.close() - return exc + raise return socket @property def available_socket_count(self) -> int: - """Get the count of freeable open sockets""" + """Get the count of available (freed) managed sockets.""" return len(self._available_sockets) @property def managed_socket_count(self) -> int: - """Get the count of open sockets""" + """Get the count of managed sockets.""" return len(self._managed_socket_by_key) def close_socket(self, socket: SocketType) -> None: - """Close a previously opened socket.""" + """ + Close a previously managed and connected socket. + + - **socket_pool** *(SocketType)* – The socket you want to close + """ if socket not in self._managed_socket_by_key.values(): raise RuntimeError("Socket not managed") socket.close() @@ -247,7 +278,7 @@ def close_socket(self, socket: SocketType) -> None: self._available_sockets.remove(socket) def free_socket(self, socket: SocketType) -> None: - """Mark a previously opened socket as available so it can be reused if needed.""" + """Mark a managed socket as available so it can be reused. The socket is not closed.""" if socket not in self._managed_socket_by_key.values(): raise RuntimeError("Socket not managed") self._available_sockets.add(socket) @@ -259,63 +290,72 @@ def get_socket( proto: str, session_id: Optional[str] = None, *, - timeout: float = 1, + timeout: float = 1.0, is_ssl: bool = False, ssl_context: Optional[SSLContextType] = None, ) -> CircuitPythonSocketType: - """Get a new socket and connect""" + """ + Get a new socket and connect to the given host. + + :param str host: host to connect to, such as ``"www.example.org"`` + :param int port: port to use for connection, such as ``80`` or ``443`` + :param str proto: connection protocol: ``"http:"``, ``"https:"``, etc. + :param Optional[str]: unique session ID, + used for multiple simultaneous connections to the same host + :param float timeout: how long to wait to connect + :param bool is_ssl: ``True`` If the connection is to be over SSL; + automatically set when ``proto`` is ``"https:"`` + :param Optional[SSLContextType]: SSL context to use when making SSL requests + """ if session_id: session_id = str(session_id) key = (host, port, proto, session_id) + + # Do we have already have a socket available for the requested connection? if key in self._managed_socket_by_key: socket = self._managed_socket_by_key[key] if socket in self._available_sockets: self._available_sockets.remove(socket) return socket - raise RuntimeError(f"Socket already connected to {proto}//{host}:{port}") + raise RuntimeError(f"An existing socket is already connected to {proto}//{host}:{port}") if proto == "https:": is_ssl = True if is_ssl and not ssl_context: - raise AttributeError( - "ssl_context must be set before using adafruit_requests for https" - ) - - addr_info = self._socket_pool.getaddrinfo( - host, port, 0, self._socket_pool.SOCK_STREAM - )[0] - - first_exception = None - result = self._get_connected_socket( - addr_info, host, port, timeout, is_ssl, ssl_context - ) - if isinstance(result, Exception): - # Got an error, if there are any available sockets, free them and try again + raise ValueError("ssl_context must be provided if using ssl") + + addr_info = self._socket_pool.getaddrinfo(host, port, 0, self._socket_pool.SOCK_STREAM)[0] + + try: + socket = self._get_connected_socket(addr_info, host, port, timeout, is_ssl, ssl_context) + self._register_connected_socket(key, socket) + return socket + except (MemoryError, OSError, RuntimeError): + # Could not get a new socket (or two, if SSL). + # If there are any available sockets, free them all and try again. if self.available_socket_count: - first_exception = result self._free_sockets() - result = self._get_connected_socket( + socket = self._get_connected_socket( addr_info, host, port, timeout, is_ssl, ssl_context ) - if isinstance(result, Exception): - last_result = f", first error: {first_exception}" if first_exception else "" - raise RuntimeError( - f"Error connecting socket: {result}{last_result}" - ) from result - - self._key_by_managed_socket[result] = key - self._managed_socket_by_key[key] = result - return result - - -# global helpers + self._register_connected_socket(key, socket) + return socket + # Re-raise exception if no sockets could be freed. + raise def connection_manager_close_all( socket_pool: Optional[SocketpoolModuleType] = None, release_references: bool = False ) -> None: - """Close all open sockets for pool""" + """ + Close all open sockets for pool, optionally release references. + + :param Optional[SocketpoolModuleType] socket_pool: + a specific socket pool whose sockets you want to close; ``None`` means all socket pools + :param bool release_references: ``True`` if you also want the `ConnectionManager` to forget + all the socket pools and SSL contexts it knows about + """ if socket_pool: socket_pools = [socket_pool] else: @@ -326,28 +366,23 @@ def connection_manager_close_all( if connection_manager is None: raise RuntimeError("SocketPool not managed") - connection_manager._free_sockets(force=True) # pylint: disable=protected-access - - if release_references: - radio_key = None - for radio_check, pool_check in _global_socketpools.items(): - if pool == pool_check: - radio_key = radio_check - break + connection_manager._free_sockets(force=True) - if radio_key: - if radio_key in _global_socketpools: - del _global_socketpools[radio_key] + if not release_references: + continue - if radio_key in _global_ssl_contexts: - del _global_ssl_contexts[radio_key] + key = _global_key_by_socketpool.pop(pool) + if key: + _global_socketpools.pop(key, None) + _global_ssl_contexts.pop(key, None) - if pool in _global_connection_managers: - del _global_connection_managers[pool] + _global_connection_managers.pop(pool, None) def get_connection_manager(socket_pool: SocketpoolModuleType) -> ConnectionManager: - """Get the ConnectionManager singleton for the given pool""" + """ + Get or create the ConnectionManager singleton for the given pool. + """ if socket_pool not in _global_connection_managers: _global_connection_managers[socket_pool] = ConnectionManager(socket_pool) return _global_connection_managers[socket_pool] diff --git a/docs/api.rst b/docs/api.rst index 1112255..1ebb602 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_connection_manager :members: diff --git a/docs/conf.py b/docs/conf.py index b184b10..3df7f0c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT @@ -53,9 +51,7 @@ creation_year = "2024" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Justin Myers" author = "Justin Myers" @@ -115,7 +111,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/examples/connectionmanager_helpers.py b/examples/connectionmanager_helpers.py index e9fb842..d4bb916 100644 --- a/examples/connectionmanager_helpers.py +++ b/examples/connectionmanager_helpers.py @@ -27,8 +27,8 @@ connection_manager = adafruit_connection_manager.get_connection_manager(pool) print("-" * 40) print("Nothing yet opened") -print(f"Open Sockets: {connection_manager.managed_socket_count}") -print(f"Freeable Open Sockets: {connection_manager.available_socket_count}") +print(f"Managed Sockets: {connection_manager.managed_socket_count}") +print(f"Available Managed Sockets: {connection_manager.available_socket_count}") # make request print("-" * 40) @@ -38,18 +38,18 @@ print(f"Text Response {response_text}") print("-" * 40) -print("1 request, opened and freed") -print(f"Open Sockets: {connection_manager.managed_socket_count}") -print(f"Freeable Open Sockets: {connection_manager.available_socket_count}") +print("1 request, opened and closed") +print(f"Managed Sockets: {connection_manager.managed_socket_count}") +print(f"Available Managed Sockets: {connection_manager.available_socket_count}") print("-" * 40) print(f"Fetching from {TEXT_URL} not in a context handler") response = requests.get(TEXT_URL) print("-" * 40) -print("1 request, opened but not freed") -print(f"Open Sockets: {connection_manager.managed_socket_count}") -print(f"Freeable Open Sockets: {connection_manager.available_socket_count}") +print("1 request, opened but not closed") +print(f"Managed Sockets: {connection_manager.managed_socket_count}") +print(f"Available Managed Sockets: {connection_manager.available_socket_count}") print("-" * 40) print("Closing everything in the pool") @@ -57,5 +57,5 @@ print("-" * 40) print("Everything closed") -print(f"Open Sockets: {connection_manager.managed_socket_count}") -print(f"Freeable Open Sockets: {connection_manager.available_socket_count}") +print(f"Managed Sockets: {connection_manager.managed_socket_count}") +print(f"Available Managed Sockets: {connection_manager.available_socket_count}") diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..73e9efc --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "PLC2701", # private import +] + +[format] +line-ending = "lf" diff --git a/tests/close_socket_test.py b/tests/close_socket_test.py index 3927181..1153a0a 100644 --- a/tests/close_socket_test.py +++ b/tests/close_socket_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Close Socket Tests """ +"""Close Socket Tests""" import mocket import pytest diff --git a/tests/conftest.py b/tests/conftest.py index ef6c96d..048986c 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Setup Tests """ +"""Setup Tests""" import sys @@ -10,9 +10,29 @@ import pytest -# pylint: disable=unused-argument -def set_interface(iface): - """Helper to set the global internet interface""" +class SocketPool: + name = None + + def __init__(self, *args, **kwargs): + pass + + @property + def __name__(self): # noqa: PLW3201 + return self.name + + +class ESP32SPI_SocketPool(SocketPool): + name = "adafruit_esp32spi_socketpool" + + +class WIZNET5K_SocketPool(SocketPool): + name = "adafruit_wiznet5k_socketpool" + SOCK_STREAM = 0x21 + + +class WIZNET5K_With_SSL_SocketPool(SocketPool): + name = "adafruit_wiznet5k_socketpool" + SOCK_STREAM = 0x1 @pytest.fixture @@ -25,41 +45,39 @@ def circuitpython_socketpool_module(): @pytest.fixture -def adafruit_esp32spi_socket_module(): +def adafruit_esp32spi_socketpool_module(): esp32spi_module = type(sys)("adafruit_esp32spi") - esp32spi_socket_module = type(sys)("adafruit_esp32spi_socket") - esp32spi_socket_module.set_interface = set_interface + esp32spi_socket_module = type(sys)("adafruit_esp32spi_socketpool") + esp32spi_socket_module.SocketPool = ESP32SPI_SocketPool sys.modules["adafruit_esp32spi"] = esp32spi_module - sys.modules["adafruit_esp32spi.adafruit_esp32spi_socket"] = esp32spi_socket_module + sys.modules["adafruit_esp32spi.adafruit_esp32spi_socketpool"] = esp32spi_socket_module yield del sys.modules["adafruit_esp32spi"] - del sys.modules["adafruit_esp32spi.adafruit_esp32spi_socket"] + del sys.modules["adafruit_esp32spi.adafruit_esp32spi_socketpool"] @pytest.fixture -def adafruit_wiznet5k_socket_module(): +def adafruit_wiznet5k_socketpool_module(): wiznet5k_module = type(sys)("adafruit_wiznet5k") - wiznet5k_socket_module = type(sys)("adafruit_wiznet5k_socket") - wiznet5k_socket_module.set_interface = set_interface - wiznet5k_socket_module.SOCK_STREAM = 0x21 + wiznet5k_socketpool_module = type(sys)("adafruit_wiznet5k_socketpool") + wiznet5k_socketpool_module.SocketPool = WIZNET5K_SocketPool sys.modules["adafruit_wiznet5k"] = wiznet5k_module - sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socket"] = wiznet5k_socket_module + sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] = wiznet5k_socketpool_module yield del sys.modules["adafruit_wiznet5k"] - del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socket"] + del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] @pytest.fixture -def adafruit_wiznet5k_with_ssl_socket_module(): +def adafruit_wiznet5k_with_ssl_socketpool_module(): wiznet5k_module = type(sys)("adafruit_wiznet5k") - wiznet5k_socket_module = type(sys)("adafruit_wiznet5k_socket") - wiznet5k_socket_module.set_interface = set_interface - wiznet5k_socket_module.SOCK_STREAM = 1 + wiznet5k_socketpool_module = type(sys)("adafruit_wiznet5k_socketpool") + wiznet5k_socketpool_module.SocketPool = WIZNET5K_With_SSL_SocketPool sys.modules["adafruit_wiznet5k"] = wiznet5k_module - sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socket"] = wiznet5k_socket_module + sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] = wiznet5k_socketpool_module yield del sys.modules["adafruit_wiznet5k"] - del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socket"] + del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] @pytest.fixture(autouse=True) diff --git a/tests/connection_manager_close_all_test.py b/tests/connection_manager_close_all_test.py index c0fa498..0dcd908 100644 --- a/tests/connection_manager_close_all_test.py +++ b/tests/connection_manager_close_all_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Get Connection Manager Tests """ +"""Get Connection Manager Tests""" import mocket import pytest @@ -15,14 +15,10 @@ def test_connection_manager_close_all_all(): mock_pool_2 = mocket.MocketPool() assert mock_pool_1 != mock_pool_2 - connection_manager_1 = adafruit_connection_manager.get_connection_manager( - mock_pool_1 - ) + connection_manager_1 = adafruit_connection_manager.get_connection_manager(mock_pool_1) assert connection_manager_1.managed_socket_count == 0 assert connection_manager_1.available_socket_count == 0 - connection_manager_2 = adafruit_connection_manager.get_connection_manager( - mock_pool_2 - ) + connection_manager_2 = adafruit_connection_manager.get_connection_manager(mock_pool_2) assert connection_manager_2.managed_socket_count == 0 assert connection_manager_2.available_socket_count == 0 assert len(adafruit_connection_manager._global_connection_managers) == 2 @@ -50,14 +46,10 @@ def test_connection_manager_close_all_single(): mock_pool_2 = mocket.MocketPool() assert mock_pool_1 != mock_pool_2 - connection_manager_1 = adafruit_connection_manager.get_connection_manager( - mock_pool_1 - ) + connection_manager_1 = adafruit_connection_manager.get_connection_manager(mock_pool_1) assert connection_manager_1.managed_socket_count == 0 assert connection_manager_1.available_socket_count == 0 - connection_manager_2 = adafruit_connection_manager.get_connection_manager( - mock_pool_2 - ) + connection_manager_2 = adafruit_connection_manager.get_connection_manager(mock_pool_2) assert connection_manager_2.managed_socket_count == 0 assert connection_manager_2.available_socket_count == 0 assert len(adafruit_connection_manager._global_connection_managers) == 2 @@ -87,8 +79,8 @@ def test_connection_manager_close_all_untracked(): assert "SocketPool not managed" in str(context) -def test_connection_manager_close_all_single_release_references_false( # pylint: disable=unused-argument - circuitpython_socketpool_module, adafruit_esp32spi_socket_module +def test_connection_manager_close_all_single_release_references_false( + circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() radio_esp = mocket.MockRadio.ESP_SPIcontrol() @@ -99,12 +91,8 @@ def test_connection_manager_close_all_single_release_references_false( # pylint ssl_context_wifi = adafruit_connection_manager.get_radio_ssl_context(radio_wifi) ssl_context_esp = adafruit_connection_manager.get_radio_ssl_context(radio_esp) - connection_manager_wifi = adafruit_connection_manager.get_connection_manager( - socket_pool_wifi - ) - connection_manager_esp = adafruit_connection_manager.get_connection_manager( - socket_pool_esp - ) + connection_manager_wifi = adafruit_connection_manager.get_connection_manager(socket_pool_wifi) + connection_manager_esp = adafruit_connection_manager.get_connection_manager(socket_pool_esp) assert socket_pool_wifi != socket_pool_esp assert ssl_context_wifi != ssl_context_esp @@ -120,18 +108,12 @@ def test_connection_manager_close_all_single_release_references_false( # pylint assert ssl_context_wifi in adafruit_connection_manager._global_ssl_contexts.values() assert ssl_context_esp in adafruit_connection_manager._global_ssl_contexts.values() - assert ( - socket_pool_wifi - in adafruit_connection_manager._global_connection_managers.keys() - ) - assert ( - socket_pool_esp - in adafruit_connection_manager._global_connection_managers.keys() - ) + assert socket_pool_wifi in adafruit_connection_manager._global_connection_managers.keys() + assert socket_pool_esp in adafruit_connection_manager._global_connection_managers.keys() -def test_connection_manager_close_all_single_release_references_true( # pylint: disable=unused-argument - circuitpython_socketpool_module, adafruit_esp32spi_socket_module +def test_connection_manager_close_all_single_release_references_true( + circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() radio_esp = mocket.MockRadio.ESP_SPIcontrol() @@ -142,12 +124,8 @@ def test_connection_manager_close_all_single_release_references_true( # pylint: ssl_context_wifi = adafruit_connection_manager.get_radio_ssl_context(radio_wifi) ssl_context_esp = adafruit_connection_manager.get_radio_ssl_context(radio_esp) - connection_manager_wifi = adafruit_connection_manager.get_connection_manager( - socket_pool_wifi - ) - connection_manager_esp = adafruit_connection_manager.get_connection_manager( - socket_pool_esp - ) + connection_manager_wifi = adafruit_connection_manager.get_connection_manager(socket_pool_wifi) + connection_manager_esp = adafruit_connection_manager.get_connection_manager(socket_pool_esp) assert socket_pool_wifi != socket_pool_esp assert ssl_context_wifi != ssl_context_esp @@ -157,22 +135,11 @@ def test_connection_manager_close_all_single_release_references_true( # pylint: socket_pool_wifi, release_references=True ) - assert ( - socket_pool_wifi not in adafruit_connection_manager._global_socketpools.values() - ) + assert socket_pool_wifi not in adafruit_connection_manager._global_socketpools.values() assert socket_pool_esp in adafruit_connection_manager._global_socketpools.values() - assert ( - ssl_context_wifi - not in adafruit_connection_manager._global_ssl_contexts.values() - ) + assert ssl_context_wifi not in adafruit_connection_manager._global_ssl_contexts.values() assert ssl_context_esp in adafruit_connection_manager._global_ssl_contexts.values() - assert ( - socket_pool_wifi - not in adafruit_connection_manager._global_connection_managers.keys() - ) - assert ( - socket_pool_esp - in adafruit_connection_manager._global_connection_managers.keys() - ) + assert socket_pool_wifi not in adafruit_connection_manager._global_connection_managers.keys() + assert socket_pool_esp in adafruit_connection_manager._global_connection_managers.keys() diff --git a/tests/free_socket_test.py b/tests/free_socket_test.py index 666a072..5ab9197 100644 --- a/tests/free_socket_test.py +++ b/tests/free_socket_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Free Socket Tests """ +"""Free Socket Tests""" import mocket import pytest diff --git a/tests/get_connection_manager_test.py b/tests/get_connection_manager_test.py index 324d032..0439013 100644 --- a/tests/get_connection_manager_test.py +++ b/tests/get_connection_manager_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Get Connection Manager Tests """ +"""Get Connection Manager Tests""" import mocket @@ -18,8 +18,8 @@ def test_get_connection_manager(): assert connection_manager_1 == connection_manager_2 -def test_different_connection_manager_different_pool( # pylint: disable=unused-argument - circuitpython_socketpool_module, adafruit_esp32spi_socket_module +def test_different_connection_manager_different_pool( + circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() radio_esp = mocket.MockRadio.ESP_SPIcontrol() @@ -27,11 +27,7 @@ def test_different_connection_manager_different_pool( # pylint: disable=unused- socket_pool_wifi = adafruit_connection_manager.get_radio_socketpool(radio_wifi) socket_pool_esp = adafruit_connection_manager.get_radio_socketpool(radio_esp) - connection_manager_wifi = adafruit_connection_manager.get_connection_manager( - socket_pool_wifi - ) - connection_manager_esp = adafruit_connection_manager.get_connection_manager( - socket_pool_esp - ) + connection_manager_wifi = adafruit_connection_manager.get_connection_manager(socket_pool_wifi) + connection_manager_esp = adafruit_connection_manager.get_connection_manager(socket_pool_esp) assert connection_manager_wifi != connection_manager_esp diff --git a/tests/get_radio_test.py b/tests/get_radio_test.py index 5c43ad1..3857a46 100644 --- a/tests/get_radio_test.py +++ b/tests/get_radio_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Get socketpool and ssl_context Tests """ +"""Get socketpool and ssl_context Tests""" import ssl from unittest import mock @@ -13,7 +13,19 @@ import adafruit_connection_manager -def test_get_radio_socketpool_wifi( # pylint: disable=unused-argument +def test__get_radio_hash_key(): + radio = mocket.MockRadio.Radio() + assert adafruit_connection_manager._get_radio_hash_key(radio) == hash(radio) + + +def test__get_radio_hash_key_not_hashable(): + radio = mocket.MockRadio.Radio() + + with mock.patch("builtins.hash", side_effect=TypeError()): + assert adafruit_connection_manager._get_radio_hash_key(radio) == "Radio" + + +def test_get_radio_socketpool_wifi( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() @@ -22,33 +34,40 @@ def test_get_radio_socketpool_wifi( # pylint: disable=unused-argument assert socket_pool in adafruit_connection_manager._global_socketpools.values() -def test_get_radio_socketpool_esp32spi( # pylint: disable=unused-argument - adafruit_esp32spi_socket_module, +def test_get_radio_socketpool_esp32spi( + adafruit_esp32spi_socketpool_module, ): radio = mocket.MockRadio.ESP_SPIcontrol() socket_pool = adafruit_connection_manager.get_radio_socketpool(radio) - assert socket_pool.__name__ == "adafruit_esp32spi_socket" + assert socket_pool.__name__ == "adafruit_esp32spi_socketpool" assert socket_pool in adafruit_connection_manager._global_socketpools.values() -def test_get_radio_socketpool_wiznet5k( # pylint: disable=unused-argument - adafruit_wiznet5k_socket_module, +def test_get_radio_socketpool_wiznet5k( + adafruit_wiznet5k_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K() with mock.patch("sys.implementation", return_value=[9, 0, 0]): socket_pool = adafruit_connection_manager.get_radio_socketpool(radio) - assert socket_pool.__name__ == "adafruit_wiznet5k_socket" + assert socket_pool.__name__ == "adafruit_wiznet5k_socketpool" + assert socket_pool in adafruit_connection_manager._global_socketpools.values() + + +def test_get_radio_socketpool_cpython(): + radio = adafruit_connection_manager.CPythonNetwork() + socket_pool = adafruit_connection_manager.get_radio_socketpool(radio) + assert socket_pool.__name__ == "socket" assert socket_pool in adafruit_connection_manager._global_socketpools.values() def test_get_radio_socketpool_unsupported(): radio = mocket.MockRadio.Unsupported() - with pytest.raises(AttributeError) as context: + with pytest.raises(ValueError) as context: adafruit_connection_manager.get_radio_socketpool(radio) assert "Unsupported radio class" in str(context) -def test_get_radio_socketpool_returns_same_one( # pylint: disable=unused-argument +def test_get_radio_socketpool_returns_same_one( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() @@ -58,7 +77,7 @@ def test_get_radio_socketpool_returns_same_one( # pylint: disable=unused-argume assert socket_pool_1 in adafruit_connection_manager._global_socketpools.values() -def test_get_radio_ssl_context_wifi( # pylint: disable=unused-argument +def test_get_radio_ssl_context_wifi( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() @@ -67,8 +86,8 @@ def test_get_radio_ssl_context_wifi( # pylint: disable=unused-argument assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values() -def test_get_radio_ssl_context_esp32spi( # pylint: disable=unused-argument - adafruit_esp32spi_socket_module, +def test_get_radio_ssl_context_esp32spi( + adafruit_esp32spi_socketpool_module, ): radio = mocket.MockRadio.ESP_SPIcontrol() ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio) @@ -76,8 +95,8 @@ def test_get_radio_ssl_context_esp32spi( # pylint: disable=unused-argument assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values() -def test_get_radio_ssl_context_wiznet5k( # pylint: disable=unused-argument - adafruit_wiznet5k_socket_module, +def test_get_radio_ssl_context_wiznet5k( + adafruit_wiznet5k_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K() with mock.patch("sys.implementation", return_value=[9, 0, 0]): @@ -86,14 +105,21 @@ def test_get_radio_ssl_context_wiznet5k( # pylint: disable=unused-argument assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values() +def test_get_radio_ssl_context_cpython(): + radio = adafruit_connection_manager.CPythonNetwork() + ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio) + assert isinstance(ssl_context, ssl.SSLContext) + assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values() + + def test_get_radio_ssl_context_unsupported(): radio = mocket.MockRadio.Unsupported() - with pytest.raises(AttributeError) as context: + with pytest.raises(ValueError) as context: adafruit_connection_manager.get_radio_ssl_context(radio) assert "Unsupported radio class" in str(context) -def test_get_radio_ssl_context_returns_same_one( # pylint: disable=unused-argument +def test_get_radio_ssl_context_returns_same_one( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() diff --git a/tests/get_socket_test.py b/tests/get_socket_test.py index 6be48f0..7b966f8 100644 --- a/tests/get_socket_test.py +++ b/tests/get_socket_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Get Socket Tests """ +"""Get Socket Tests""" from unittest import mock @@ -40,15 +40,11 @@ def test_get_socket_different_session(): connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # get socket - socket = connection_manager.get_socket( - mocket.MOCK_HOST_1, 80, "http:", session_id="1" - ) + socket = connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:", session_id="1") assert socket == mock_socket_1 # get socket on different session - socket = connection_manager.get_socket( - mocket.MOCK_HOST_1, 80, "http:", session_id="2" - ) + socket = connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:", session_id="2") assert socket == mock_socket_2 @@ -91,30 +87,30 @@ def test_get_socket_not_flagged_free(): # get a socket for the same host, should be a different one with pytest.raises(RuntimeError) as context: socket = connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:") - assert "Socket already connected" in str(context) + assert "An existing socket is already connected" in str(context) def test_get_socket_os_error(): mock_pool = mocket.MocketPool() mock_socket_1 = mocket.Mocket() mock_pool.socket.side_effect = [ - OSError("OSError"), + OSError("OSError 1"), mock_socket_1, ] connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # try to get a socket that returns a OSError - with pytest.raises(RuntimeError) as context: + with pytest.raises(OSError) as context: connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:") - assert "Error connecting socket: OSError" in str(context) + assert "OSError 1" in str(context) def test_get_socket_runtime_error(): mock_pool = mocket.MocketPool() mock_socket_1 = mocket.Mocket() mock_pool.socket.side_effect = [ - RuntimeError("RuntimeError"), + RuntimeError("RuntimeError 1"), mock_socket_1, ] @@ -123,7 +119,7 @@ def test_get_socket_runtime_error(): # try to get a socket that returns a RuntimeError with pytest.raises(RuntimeError) as context: connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:") - assert "Error connecting socket: RuntimeError" in str(context) + assert "RuntimeError 1" in str(context) def test_get_socket_connect_memory_error(): @@ -134,14 +130,14 @@ def test_get_socket_connect_memory_error(): mock_socket_1, mock_socket_2, ] - mock_socket_1.connect.side_effect = MemoryError("MemoryError") + mock_socket_1.connect.side_effect = MemoryError("MemoryError 1") connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # try to connect a socket that returns a MemoryError - with pytest.raises(RuntimeError) as context: + with pytest.raises(MemoryError) as context: connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:") - assert "Error connecting socket: MemoryError" in str(context) + assert "MemoryError 1" in str(context) def test_get_socket_connect_os_error(): @@ -152,14 +148,14 @@ def test_get_socket_connect_os_error(): mock_socket_1, mock_socket_2, ] - mock_socket_1.connect.side_effect = OSError("OSError") + mock_socket_1.connect.side_effect = OSError("OSError 1") connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # try to connect a socket that returns a OSError - with pytest.raises(RuntimeError) as context: + with pytest.raises(OSError) as context: connection_manager.get_socket(mocket.MOCK_HOST_1, 80, "http:") - assert "Error connecting socket: OSError" in str(context) + assert "OSError 1" in str(context) def test_get_socket_runtime_error_ties_again_at_least_one_free(): @@ -194,9 +190,9 @@ def test_get_socket_runtime_error_ties_again_only_once(): mock_socket_2 = mocket.Mocket() mock_pool.socket.side_effect = [ mock_socket_1, - RuntimeError("error 1"), - RuntimeError("error 2"), - RuntimeError("error 3"), + RuntimeError("RuntimeError 1"), + RuntimeError("RuntimeError 2"), + RuntimeError("RuntimeError 3"), mock_socket_2, ] @@ -213,12 +209,12 @@ def test_get_socket_runtime_error_ties_again_only_once(): # try to get a socket that returns a RuntimeError twice with pytest.raises(RuntimeError) as context: connection_manager.get_socket(mocket.MOCK_HOST_2, 80, "http:") - assert "Error connecting socket: error 2, first error: error 1" in str(context) + assert "RuntimeError 2" in str(context) free_sockets_mock.assert_called_once() -def test_fake_ssl_context_connect( # pylint: disable=unused-argument - adafruit_esp32spi_socket_module, +def test_fake_ssl_context_connect( + adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() mock_socket_1 = mocket.Mocket() @@ -236,20 +232,19 @@ def test_fake_ssl_context_connect( # pylint: disable=unused-argument socket._socket.connect.assert_called_once() -def test_fake_ssl_context_connect_error( # pylint: disable=unused-argument - adafruit_esp32spi_socket_module, +def test_fake_ssl_context_connect_error( + adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() mock_socket_1 = mocket.Mocket() mock_pool.socket.return_value = mock_socket_1 - mock_socket_1.connect.side_effect = RuntimeError("RuntimeError") + mock_socket_1.connect.side_effect = RuntimeError("RuntimeError 1") radio = mocket.MockRadio.ESP_SPIcontrol() ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio) connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) - with pytest.raises(RuntimeError) as context: - connection_manager.get_socket( - mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_context - ) - assert "Error connecting socket: [Errno 12] RuntimeError" in str(context) + with pytest.raises(OSError) as context: + connection_manager.get_socket(mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_context) + assert "12" in str(context) + assert "RuntimeError 1" in str(context) diff --git a/tests/mocket.py b/tests/mocket.py index 3155231..5541b49 100644 --- a/tests/mocket.py +++ b/tests/mocket.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: Unlicense -""" Mock Socket """ +"""Mock Socket""" from unittest import mock @@ -13,25 +13,22 @@ MOCK_PATH_1 = "/testwifi/index.html" MOCK_ENDPOINT_1 = MOCK_HOST_1 + MOCK_PATH_1 MOCK_ENDPOINT_2 = MOCK_HOST_2 + MOCK_PATH_1 -MOCK_RESPONSE_TEXT = ( - b"This is a test of Adafruit WiFi!\r\nIf you can read this, its working :)" -) +MOCK_RESPONSE_TEXT = b"This is a test of Adafruit WiFi!\r\nIf you can read this, its working :)" MOCK_RESPONSE = b"HTTP/1.0 200 OK\r\nContent-Length: 70\r\n\r\n" + MOCK_RESPONSE_TEXT -class MocketPool: # pylint: disable=too-few-public-methods +class MocketPool: """Mock SocketPool""" SOCK_STREAM = 0 - # pylint: disable=unused-argument def __init__(self, radio=None): self.getaddrinfo = mock.Mock() self.getaddrinfo.return_value = ((None, None, None, None, (MOCK_POOL_IP, 80)),) self.socket = mock.Mock() -class Mocket: # pylint: disable=too-few-public-methods +class Mocket: """Mock Socket""" def __init__(self, response=MOCK_RESPONSE): @@ -78,19 +75,16 @@ def _recv_into(self, buf, nbytes=0): return read -class SSLContext: # pylint: disable=too-few-public-methods +class SSLContext: """Mock SSL Context""" def __init__(self): self.wrap_socket = mock.Mock(side_effect=self._wrap_socket) - def _wrap_socket( - self, sock, server_hostname=None - ): # pylint: disable=no-self-use,unused-argument + def _wrap_socket(self, sock, server_hostname=None): return sock -# pylint: disable=too-few-public-methods class MockRadio: class Radio: pass diff --git a/tests/protocol_test.py b/tests/protocol_test.py index 98b5296..967206e 100644 --- a/tests/protocol_test.py +++ b/tests/protocol_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Protocol Tests """ +"""Protocol Tests""" import mocket import pytest @@ -18,9 +18,9 @@ def test_get_https_no_ssl(): connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # verify not sending in a SSL context for a HTTPS call errors - with pytest.raises(AttributeError) as context: + with pytest.raises(ValueError) as context: connection_manager.get_socket(mocket.MOCK_HOST_1, 443, "https:") - assert "ssl_context must be set" in str(context) + assert "ssl_context must be provided if using ssl" in str(context) def test_connect_https(): @@ -32,9 +32,7 @@ def test_connect_https(): connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # verify a HTTPS call changes the port to 443 - connection_manager.get_socket( - mocket.MOCK_HOST_1, 443, "https:", ssl_context=mock_ssl_context - ) + connection_manager.get_socket(mocket.MOCK_HOST_1, 443, "https:", ssl_context=mock_ssl_context) mock_socket_1.connect.assert_called_once_with((mocket.MOCK_HOST_1, 443)) mock_ssl_context.wrap_socket.assert_called_once() diff --git a/tests/ssl_context_test.py b/tests/ssl_context_test.py index de6d4f1..666d940 100644 --- a/tests/ssl_context_test.py +++ b/tests/ssl_context_test.py @@ -2,9 +2,10 @@ # # SPDX-License-Identifier: Unlicense -""" SLL Context Tests """ +"""SLL Context Tests""" import ssl +from collections import namedtuple from unittest import mock import mocket @@ -13,9 +14,11 @@ import adafruit_connection_manager from adafruit_connection_manager import WIZNET5K_SSL_SUPPORT_VERSION +SimpleNamespace = namedtuple("SimpleNamespace", "name version") -def test_connect_esp32spi_https( # pylint: disable=unused-argument - adafruit_esp32spi_socket_module, + +def test_connect_esp32spi_https( + adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() mock_socket_1 = mocket.Mocket() @@ -39,7 +42,7 @@ def test_connect_esp32spi_https( # pylint: disable=unused-argument assert isinstance(socket, adafruit_connection_manager._FakeSSLSocket) -def test_connect_wifi_https( # pylint: disable=unused-argument +def test_connect_wifi_https( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() @@ -47,28 +50,29 @@ def test_connect_wifi_https( # pylint: disable=unused-argument assert isinstance(ssl_context, ssl.SSLContext) -def test_connect_wiznet5k_https_not_supported( # pylint: disable=unused-argument - adafruit_wiznet5k_socket_module, +def test_connect_wiznet5k_https_not_supported( + adafruit_wiznet5k_socketpool_module, ): mock_pool = mocket.MocketPool() radio = mocket.MockRadio.WIZNET5K() old_version = (WIZNET5K_SSL_SUPPORT_VERSION[0] - 1, 0, 0) - with mock.patch("sys.implementation", (None, old_version)): + with mock.patch("sys.implementation", SimpleNamespace("circuitpython", old_version)): ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio) connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) # verify a HTTPS call for a board without built in WiFi and SSL support errors - with pytest.raises(AttributeError) as context: - connection_manager.get_socket( - mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_context - ) + with pytest.raises(ValueError) as context: + connection_manager.get_socket(mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_context) assert "This radio does not support TLS/HTTPS" in str(context) -def test_connect_wiznet5k_https_supported( # pylint: disable=unused-argument - adafruit_wiznet5k_with_ssl_socket_module, +def test_connect_wiznet5k_https_supported( + adafruit_wiznet5k_with_ssl_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K() - with mock.patch("sys.implementation", (None, WIZNET5K_SSL_SUPPORT_VERSION)): + with mock.patch( + "sys.implementation", + SimpleNamespace("circuitpython", WIZNET5K_SSL_SUPPORT_VERSION), + ): ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio) assert isinstance(ssl_context, ssl.SSLContext)