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 4d2e392..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: v3.1.0 + - 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..fe4faae 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: 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 67152d7..ec9f9c4 100644 --- a/adafruit_connection_manager.py +++ b/adafruit_connection_manager.py @@ -67,7 +67,7 @@ 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""" @@ -97,7 +97,7 @@ def create_fake_ssl_context( return _FakeSSLContext(iface) -class CPythonNetwork: # pylint: disable=too-few-public-methods +class CPythonNetwork: """Radio object to use when using ConnectionManager in CPython.""" @@ -127,21 +127,21 @@ def get_radio_socketpool(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_socketpool as socketpool # 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_socketpool as socketpool # pylint: disable=import-outside-toplevel + import adafruit_wiznet5k.adafruit_wiznet5k_socketpool as socketpool pool = socketpool.SocketPool(radio) @@ -157,7 +157,7 @@ def get_radio_socketpool(radio): and implementation_version >= WIZNET5K_SSL_SUPPORT_VERSION ): try: - import ssl # pylint: disable=import-outside-toplevel + import ssl ssl_context = ssl.create_default_context() except ImportError: @@ -168,8 +168,8 @@ def get_radio_socketpool(radio): ssl_context = create_fake_ssl_context(pool, radio) elif class_name == "CPythonNetwork": - import socket as pool # pylint: disable=import-outside-toplevel - import ssl # pylint: disable=import-outside-toplevel + import socket as pool + import ssl ssl_context = ssl.create_default_context() @@ -224,7 +224,7 @@ def _register_connected_socket(self, key, socket): self._key_by_managed_socket[socket] = key self._managed_socket_by_key[key] = socket - def _get_connected_socket( # pylint: disable=too-many-arguments + def _get_connected_socket( self, addr_info: List[Tuple[int, int, int, str, Tuple[str, int]]], host: str, @@ -233,7 +233,6 @@ def _get_connected_socket( # pylint: disable=too-many-arguments is_ssl: bool, ssl_context: Optional[SSLContextType] = None, ): - socket = self._socket_pool.socket(addr_info[0], addr_info[1]) if is_ssl: @@ -284,7 +283,6 @@ def free_socket(self, socket: SocketType) -> None: raise RuntimeError("Socket not managed") self._available_sockets.add(socket) - # pylint: disable=too-many-arguments def get_socket( self, host: str, @@ -320,23 +318,17 @@ def get_socket( self._available_sockets.remove(socket) return socket - raise RuntimeError( - f"An existing socket is 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 ValueError("ssl_context must be provided if using ssl") - addr_info = self._socket_pool.getaddrinfo( - host, port, 0, self._socket_pool.SOCK_STREAM - )[0] + 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 - ) + 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): @@ -374,7 +366,7 @@ 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 + connection_manager._free_sockets(force=True) if not release_references: continue 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/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 22128f9..048986c 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" Setup Tests """ +"""Setup Tests""" import sys @@ -17,22 +17,20 @@ def __init__(self, *args, **kwargs): pass @property - def __name__(self): + def __name__(self): # noqa: PLW3201 return self.name -class ESP32SPI_SocketPool(SocketPool): # pylint: disable=too-few-public-methods +class ESP32SPI_SocketPool(SocketPool): name = "adafruit_esp32spi_socketpool" -class WIZNET5K_SocketPool(SocketPool): # pylint: disable=too-few-public-methods +class WIZNET5K_SocketPool(SocketPool): name = "adafruit_wiznet5k_socketpool" SOCK_STREAM = 0x21 -class WIZNET5K_With_SSL_SocketPool( - SocketPool -): # pylint: disable=too-few-public-methods +class WIZNET5K_With_SSL_SocketPool(SocketPool): name = "adafruit_wiznet5k_socketpool" SOCK_STREAM = 0x1 @@ -52,9 +50,7 @@ def adafruit_esp32spi_socketpool_module(): 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_socketpool"] = ( - 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_socketpool"] @@ -66,9 +62,7 @@ def adafruit_wiznet5k_socketpool_module(): 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_socketpool"] = ( - wiznet5k_socketpool_module - ) + sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] = wiznet5k_socketpool_module yield del sys.modules["adafruit_wiznet5k"] del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] @@ -80,9 +74,7 @@ def adafruit_wiznet5k_with_ssl_socketpool_module(): 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_socketpool"] = ( - wiznet5k_socketpool_module - ) + sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] = wiznet5k_socketpool_module yield del sys.modules["adafruit_wiznet5k"] del sys.modules["adafruit_wiznet5k.adafruit_wiznet5k_socketpool"] diff --git a/tests/connection_manager_close_all_test.py b/tests/connection_manager_close_all_test.py index 2057be0..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,7 +79,7 @@ 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 +def test_connection_manager_close_all_single_release_references_false( circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() @@ -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,17 +108,11 @@ 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 +def test_connection_manager_close_all_single_release_references_true( circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() @@ -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 c5f7817..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,7 +18,7 @@ def test_get_connection_manager(): assert connection_manager_1 == connection_manager_2 -def test_different_connection_manager_different_pool( # pylint: disable=unused-argument +def test_different_connection_manager_different_pool( circuitpython_socketpool_module, adafruit_esp32spi_socketpool_module ): radio_wifi = mocket.MockRadio.Radio() @@ -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 022aecd..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 @@ -25,7 +25,7 @@ def test__get_radio_hash_key_not_hashable(): assert adafruit_connection_manager._get_radio_hash_key(radio) == "Radio" -def test_get_radio_socketpool_wifi( # pylint: disable=unused-argument +def test_get_radio_socketpool_wifi( circuitpython_socketpool_module, ): radio = mocket.MockRadio.Radio() @@ -34,7 +34,7 @@ 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 +def test_get_radio_socketpool_esp32spi( adafruit_esp32spi_socketpool_module, ): radio = mocket.MockRadio.ESP_SPIcontrol() @@ -43,7 +43,7 @@ def test_get_radio_socketpool_esp32spi( # pylint: disable=unused-argument assert socket_pool in adafruit_connection_manager._global_socketpools.values() -def test_get_radio_socketpool_wiznet5k( # pylint: disable=unused-argument +def test_get_radio_socketpool_wiznet5k( adafruit_wiznet5k_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K() @@ -67,7 +67,7 @@ def test_get_radio_socketpool_unsupported(): 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() @@ -77,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() @@ -86,7 +86,7 @@ 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 +def test_get_radio_ssl_context_esp32spi( adafruit_esp32spi_socketpool_module, ): radio = mocket.MockRadio.ESP_SPIcontrol() @@ -95,7 +95,7 @@ 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 +def test_get_radio_ssl_context_wiznet5k( adafruit_wiznet5k_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K() @@ -119,7 +119,7 @@ def test_get_radio_ssl_context_unsupported(): 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 f61cb26..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 @@ -217,7 +213,7 @@ def test_get_socket_runtime_error_ties_again_only_once(): free_sockets_mock.assert_called_once() -def test_fake_ssl_context_connect( # pylint: disable=unused-argument +def test_fake_ssl_context_connect( adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() @@ -236,7 +232,7 @@ 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 +def test_fake_ssl_context_connect_error( adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() @@ -249,8 +245,6 @@ def test_fake_ssl_context_connect_error( # pylint: disable=unused-argument connection_manager = adafruit_connection_manager.ConnectionManager(mock_pool) with pytest.raises(OSError) as context: - connection_manager.get_socket( - mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_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 50a071c..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 @@ -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 25e389e..666d940 100644 --- a/tests/ssl_context_test.py +++ b/tests/ssl_context_test.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: Unlicense -""" SLL Context Tests """ +"""SLL Context Tests""" import ssl from collections import namedtuple @@ -17,7 +17,7 @@ SimpleNamespace = namedtuple("SimpleNamespace", "name version") -def test_connect_esp32spi_https( # pylint: disable=unused-argument +def test_connect_esp32spi_https( adafruit_esp32spi_socketpool_module, ): mock_pool = mocket.MocketPool() @@ -42,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() @@ -50,27 +50,23 @@ 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 +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", SimpleNamespace("circuitpython", 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(ValueError) as context: - connection_manager.get_socket( - mocket.MOCK_HOST_1, 443, "https:", ssl_context=ssl_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 +def test_connect_wiznet5k_https_supported( adafruit_wiznet5k_with_ssl_socketpool_module, ): radio = mocket.MockRadio.WIZNET5K()