From be5546c661ed5f6abd0456996a1f43d86350b7bb Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 07:52:54 -0700 Subject: [PATCH 01/11] Add ruff formatter --- .gitattributes | 5 ++++ .pre-commit-config.yaml | 41 +++++++------------------------ adafruit_portalbase/__init__.py | 1 + adafruit_portalbase/graphics.py | 4 +-- examples/portalbase_simpletest.py | 1 - pyproject.toml | 6 +++++ 6 files changed, 22 insertions(+), 36 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d54c593 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +* text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..0981ef3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,19 @@ -# 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: 23.3.0 - hooks: - - id: black - - 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: 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=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/adafruit_portalbase/__init__.py b/adafruit_portalbase/__init__.py index d3f6133..2f5bbff 100644 --- a/adafruit_portalbase/__init__.py +++ b/adafruit_portalbase/__init__.py @@ -20,6 +20,7 @@ https://github.com/adafruit/circuitpython/releases """ + import gc import time import terminalio diff --git a/adafruit_portalbase/graphics.py b/adafruit_portalbase/graphics.py index c9bbb0d..c22e854 100644 --- a/adafruit_portalbase/graphics.py +++ b/adafruit_portalbase/graphics.py @@ -100,9 +100,7 @@ def set_background(self, file_or_color, position=None): self._bg_group.append(self._bg_sprite) gc.collect() - def qrcode( - self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000 - ): # pylint: disable=invalid-name + def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # pylint: disable=invalid-name """Display a QR code :param qr_data: The data for the QR code, None to remove. diff --git a/examples/portalbase_simpletest.py b/examples/portalbase_simpletest.py index 1454c0f..20b126c 100644 --- a/examples/portalbase_simpletest.py +++ b/examples/portalbase_simpletest.py @@ -9,7 +9,6 @@ # NOTE: Make sure you've created your secrets.py file before running this example # https://learn.adafruit.com/adafruit-pyportal/internet-connect#whats-a-secrets-file-17-2 - import board import displayio from adafruit_pyportal import PyPortal diff --git a/pyproject.toml b/pyproject.toml index 885661c..df67233 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,6 +41,12 @@ classifiers = [ ] dynamic = ["dependencies", "optional-dependencies"] +[tool.ruff] +target-version = "py38" + +[tool.ruff.format] +line-ending = "lf" + [tool.setuptools] packages = ["adafruit_portalbase"] From f80941a068f17f1a9973d404e740b48c6a47db15 Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 08:08:43 -0700 Subject: [PATCH 02/11] Add ruff isort --- .pre-commit-config.yaml | 2 ++ adafruit_portalbase/__init__.py | 3 ++- adafruit_portalbase/graphics.py | 1 + adafruit_portalbase/network.py | 7 ++++--- adafruit_portalbase/wifi_coprocessor.py | 7 ++++--- adafruit_portalbase/wifi_esp32s2.py | 5 +++-- docs/conf.py | 2 +- pyproject.toml | 3 +++ 8 files changed, 20 insertions(+), 10 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0981ef3..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,6 +13,8 @@ repos: rev: v0.3.4 hooks: - id: ruff-format + - id: ruff + args: ["--fix"] - repo: https://github.com/fsfe/reuse-tool rev: v3.0.1 hooks: diff --git a/adafruit_portalbase/__init__.py b/adafruit_portalbase/__init__.py index 2f5bbff..25b1e14 100644 --- a/adafruit_portalbase/__init__.py +++ b/adafruit_portalbase/__init__.py @@ -23,10 +23,11 @@ import gc import time + import terminalio from adafruit_bitmap_font import bitmap_font -from adafruit_display_text.bitmap_label import Label from adafruit_display_text import wrap_text_to_lines +from adafruit_display_text.bitmap_label import Label __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase.git" diff --git a/adafruit_portalbase/graphics.py b/adafruit_portalbase/graphics.py index c22e854..cfd4b13 100644 --- a/adafruit_portalbase/graphics.py +++ b/adafruit_portalbase/graphics.py @@ -22,6 +22,7 @@ """ import gc + import displayio __version__ = "0.0.0+auto.0" diff --git a/adafruit_portalbase/network.py b/adafruit_portalbase/network.py index 57a6369..49fc42d 100755 --- a/adafruit_portalbase/network.py +++ b/adafruit_portalbase/network.py @@ -21,12 +21,13 @@ """ +import gc import os import time -import gc -from micropython import const -from adafruit_io.adafruit_io import IO_HTTP, AdafruitIO_RequestError + from adafruit_fakerequests import Fake_Requests +from adafruit_io.adafruit_io import IO_HTTP, AdafruitIO_RequestError +from micropython import const try: import rtc diff --git a/adafruit_portalbase/wifi_coprocessor.py b/adafruit_portalbase/wifi_coprocessor.py index 85eb096..ab3b912 100644 --- a/adafruit_portalbase/wifi_coprocessor.py +++ b/adafruit_portalbase/wifi_coprocessor.py @@ -21,11 +21,12 @@ """ import gc -import board -from digitalio import DigitalInOut -from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + import adafruit_connection_manager import adafruit_requests +import board +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager +from digitalio import DigitalInOut __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase.git" diff --git a/adafruit_portalbase/wifi_esp32s2.py b/adafruit_portalbase/wifi_esp32s2.py index c1601ee..1e0daa1 100644 --- a/adafruit_portalbase/wifi_esp32s2.py +++ b/adafruit_portalbase/wifi_esp32s2.py @@ -23,9 +23,10 @@ import gc import ssl -import wifi -import socketpool + import adafruit_requests +import socketpool +import wifi __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase.git" diff --git a/docs/conf.py b/docs/conf.py index c49fcf5..63d7702 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,9 +4,9 @@ # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) diff --git a/pyproject.toml b/pyproject.toml index df67233..6851d8f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,6 +44,9 @@ dynamic = ["dependencies", "optional-dependencies"] [tool.ruff] target-version = "py38" +[tool.ruff.lint] +select = ["I"] + [tool.ruff.format] line-ending = "lf" From 95168b0a272736ef391d8321475eaaf85419654d Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 09:13:40 -0700 Subject: [PATCH 03/11] Add ruff lint --- .pylintrc | 399 -------------------------------- adafruit_portalbase/__init__.py | 16 +- adafruit_portalbase/graphics.py | 8 +- adafruit_portalbase/network.py | 21 +- pyproject.toml | 3 +- 5 files changed, 18 insertions(+), 429 deletions(-) delete mode 100644 .pylintrc 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/adafruit_portalbase/__init__.py b/adafruit_portalbase/__init__.py index 25b1e14..ea016ed 100644 --- a/adafruit_portalbase/__init__.py +++ b/adafruit_portalbase/__init__.py @@ -57,8 +57,7 @@ class PortalBase: """ - # pylint: disable=too-many-instance-attributes, too-many-branches, too-many-public-methods - def __init__( + def __init__( # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in function definition self, network, graphics, @@ -86,7 +85,7 @@ def __init__( self._text = [] try: - import alarm # pylint: disable=import-outside-toplevel + import alarm self._alarm = alarm except ImportError: @@ -158,8 +157,7 @@ def wrap_nicely(string, max_chars): """ return wrap_text_to_lines(string, max_chars) - # pylint: disable=too-many-arguments - def add_text( + def add_text( # noqa: PLR0913 Too many arguments in function definition self, text_position=(0, 0), text_font=terminalio.FONT, @@ -237,8 +235,6 @@ def add_text( return text_index - # pylint: enable=too-many-arguments - def remove_all_text(self, clear_font_cache=False): """Remove all added text and labels. @@ -254,7 +250,7 @@ def remove_all_text(self, clear_font_cache=False): self._fonts = {} gc.collect() - def set_text(self, val, index=0): + def set_text(self, val, index=0): # noqa: PLR0912 Too many branches """Display text, with indexing into our list of text boxes. :param str val: The text to be displayed @@ -311,13 +307,11 @@ def set_text(self, val, index=0): gc.collect() def preload_font(self, glyphs=None, index=0): - # pylint: disable=line-too-long """Preload font. :param glyphs: The font glyphs to load. Defaults to ``None``, uses alphanumeric glyphs if None. """ - # pylint: enable=line-too-long if not glyphs: glyphs = b"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-!,. \"'?!" print("Preloading font glyphs:", glyphs) @@ -471,7 +465,7 @@ def _fill_text_labels(self, values): # fill out all the text blocks if self._text: value_index = 0 # In case values and text is not the same - for i in range(len(self._text)): # pylint: disable=consider-using-enumerate + for i in range(len(self._text)): if (not self._text[i]["is_data"]) or (value_index > (len(values) - 1)): continue string = None diff --git a/adafruit_portalbase/graphics.py b/adafruit_portalbase/graphics.py index cfd4b13..1e668b1 100644 --- a/adafruit_portalbase/graphics.py +++ b/adafruit_portalbase/graphics.py @@ -41,8 +41,7 @@ class GraphicsBase: """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements - def __init__(self, display, *, default_bg=0x000000, scale=1, debug=False): + def __init__(self, display, *, default_bg=0x000000, scale=1, debug=False): # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in function definition self._debug = debug self.display = display @@ -101,7 +100,7 @@ def set_background(self, file_or_color, position=None): self._bg_group.append(self._bg_sprite) gc.collect() - def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # pylint: disable=invalid-name + def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in function definition """Display a QR code :param qr_data: The data for the QR code, None to remove. @@ -117,7 +116,7 @@ def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # pylint: gc.collect() return - import adafruit_miniqr # pylint: disable=import-outside-toplevel + import adafruit_miniqr # generate the QR code for qrtype in range(1, 6): @@ -136,7 +135,6 @@ def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # pylint: palette[0] = 0xFFFFFF palette[1] = qr_color - # pylint: disable=invalid-name # bitmap the size of the matrix, plus border, monochrome (2 colors) qr_bitmap = displayio.Bitmap( qrcode.matrix.width + 2, qrcode.matrix.height + 2, 2 diff --git a/adafruit_portalbase/network.py b/adafruit_portalbase/network.py index 49fc42d..501bb83 100755 --- a/adafruit_portalbase/network.py +++ b/adafruit_portalbase/network.py @@ -37,7 +37,6 @@ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase.git" -# pylint: disable=line-too-long, too-many-lines, too-many-public-methods # you'll need to pass in an io username and key TIME_SERVICE = ( "https://io.adafruit.com/api/v2/%s/integrations/time/strftime?x-aio-key=%s" @@ -46,7 +45,6 @@ # See https://apidock.com/ruby/DateTime/strftime for full options TIME_SERVICE_FORMAT = "%Y-%m-%d %H:%M:%S.%L %j %u %z %Z" LOCALFILE = "local.txt" -# pylint: enable=line-too-long STATUS_NO_CONNECTION = (100, 0, 0) # Red STATUS_CONNECTING = (0, 0, 100) # Blue @@ -91,8 +89,7 @@ class NetworkBase: """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements - def __init__( + def __init__( # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in function definition self, wifi_module, *, extract_values=True, debug=False, secrets_data=None ): self._wifi = wifi_module @@ -109,7 +106,7 @@ def __init__( if secrets_data is not None: for key, value in secrets_data.items(): if key in OLD_SETTINGS: - key = OLD_SETTINGS.get(key) + key = OLD_SETTINGS.get(key) # noqa: PLW2901 `for` loop variable `value` overwritten by assignment target self._settings[key] = value self._wifi_credentials = None @@ -135,7 +132,7 @@ def _get_setting(self, setting_name, show_error=True): if os.getenv(setting_name) is not None: return os.getenv(setting_name) try: - from secrets import secrets # pylint: disable=import-outside-toplevel + from secrets import secrets except ImportError: secrets = {} if old_setting_name in secrets.keys(): @@ -211,7 +208,6 @@ def get_strftime(self, time_format, location=None): :param str location: Your city and country, e.g. ``"America/New_York"``. """ - # pylint: disable=line-too-long self.connect() api_url = None reply = None @@ -220,7 +216,7 @@ def get_strftime(self, time_format, location=None): aio_key = self._get_setting("AIO_KEY") except KeyError: raise KeyError( - "\n\nOur time service requires a login/password to rate-limit. Please register for a free adafruit.io account and place the user/key in your secrets file under 'AIO_USERNAME' and 'AIO_KEY'" # pylint: disable=line-too-long + "\n\nOur time service requires a login/password to rate-limit. Please register for a free adafruit.io account and place the user/key in your secrets file under 'AIO_USERNAME' and 'AIO_KEY'" ) from KeyError if location is None: @@ -251,7 +247,7 @@ def get_strftime(self, time_format, location=None): reply = response.text except KeyError: raise KeyError( - "Was unable to lookup the time, try setting secrets['timezone'] according to http://worldtimeapi.org/timezones" # pylint: disable=line-too-long + "Was unable to lookup the time, try setting secrets['timezone'] according to http://worldtimeapi.org/timezones" ) from KeyError # now clean up response.close() @@ -261,7 +257,6 @@ def get_strftime(self, time_format, location=None): return reply def get_local_time(self, location=None): - # pylint: disable=line-too-long """ Fetch and "set" the local time of this microcontroller to the local time at the location, using an internet time API. @@ -624,7 +619,7 @@ def _get_headers(response): gc.collect() return headers - def fetch_data( + def fetch_data( # noqa: PLR0913 Too many arguments in function definition self, url, *, @@ -704,7 +699,7 @@ def process_text(text, regexp_path): """ values = [] if regexp_path: - import re # pylint: disable=import-outside-toplevel + import re for regexp in regexp_path: values.append(re.search(regexp, text).group(1)) @@ -741,7 +736,7 @@ def process_json(self, json_data, json_path): raise else: # No path given, so return JSON as string for compatibility - import json # pylint: disable=import-outside-toplevel + import json values = json.dumps(json_data) return values diff --git a/pyproject.toml b/pyproject.toml index 6851d8f..3fa0343 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,8 @@ dynamic = ["dependencies", "optional-dependencies"] target-version = "py38" [tool.ruff.lint] -select = ["I"] +select = ["I", "PL"] +ignore = ["PLR2004"] [tool.ruff.format] line-ending = "lf" From 76e5276bbce4fb56dbe8fbd958055a021d5a5da3 Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 09:32:42 -0700 Subject: [PATCH 04/11] Add ruff upgrade --- adafruit_portalbase/network.py | 4 ++-- docs/conf.py | 2 -- pyproject.toml | 4 ++-- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/adafruit_portalbase/network.py b/adafruit_portalbase/network.py index 501bb83..99f2383 100755 --- a/adafruit_portalbase/network.py +++ b/adafruit_portalbase/network.py @@ -271,9 +271,9 @@ def get_local_time(self, location=None): year_day = int(times[2]) week_day = int(times[3]) is_dst = None # no way to know yet - year, month, mday = [int(x) for x in the_date.split("-")] + year, month, mday = (int(x) for x in the_date.split("-")) the_time = the_time.split(".")[0] - hours, minutes, seconds = [int(x) for x in the_time.split(":")] + hours, minutes, seconds = (int(x) for x in the_time.split(":")) now = time.struct_time( (year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst) ) diff --git a/docs/conf.py b/docs/conf.py index 63d7702..241b83e 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 diff --git a/pyproject.toml b/pyproject.toml index 3fa0343..b54dd3e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,8 +45,8 @@ dynamic = ["dependencies", "optional-dependencies"] target-version = "py38" [tool.ruff.lint] -select = ["I", "PL"] -ignore = ["PLR2004"] +select = ["I", "PL", "UP"] +ignore = ["PLR2004", "UP028", "UP030", "UP031", "UP032"] [tool.ruff.format] line-ending = "lf" From ea4852401d537d86cab4b119d1be4a98bc1fa196 Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 09:47:59 -0700 Subject: [PATCH 05/11] remove upgrade UP028 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index b54dd3e..fdbdf5b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,7 @@ target-version = "py38" [tool.ruff.lint] select = ["I", "PL", "UP"] -ignore = ["PLR2004", "UP028", "UP030", "UP031", "UP032"] +ignore = ["PLR2004", "UP030", "UP031", "UP032"] [tool.ruff.format] line-ending = "lf" From b038cc7f1c0753c4c07f24039578045c136b6e2b Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 09:52:53 -0700 Subject: [PATCH 06/11] remove upgrade UP031 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index fdbdf5b..98a9376 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,7 @@ target-version = "py38" [tool.ruff.lint] select = ["I", "PL", "UP"] -ignore = ["PLR2004", "UP030", "UP031", "UP032"] +ignore = ["PLR2004", "UP030", "UP032"] [tool.ruff.format] line-ending = "lf" From d7293e08e1b83328b494bfe973af65a377ae0aea Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sat, 23 Mar 2024 09:58:31 -0700 Subject: [PATCH 07/11] remove upgrade UP032 --- adafruit_portalbase/__init__.py | 2 +- adafruit_portalbase/network.py | 4 +--- pyproject.toml | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/adafruit_portalbase/__init__.py b/adafruit_portalbase/__init__.py index ea016ed..38b9352 100644 --- a/adafruit_portalbase/__init__.py +++ b/adafruit_portalbase/__init__.py @@ -474,7 +474,7 @@ def _fill_text_labels(self, values): string = func(values[value_index]) else: try: - string = "{:,d}".format(int(values[value_index])) + string = f"{int(values[value_index]):,d}" except (TypeError, ValueError): string = values[value_index] # ok it's a string self._fetch_set_text(string, index=i) diff --git a/adafruit_portalbase/network.py b/adafruit_portalbase/network.py index 99f2383..288aa3d 100755 --- a/adafruit_portalbase/network.py +++ b/adafruit_portalbase/network.py @@ -668,9 +668,7 @@ def _parse_data( print("Couldn't parse json: ", response.text) raise except MemoryError as error: - raise MemoryError( - "{} (data is likely too large)".format(error) - ) from error + raise MemoryError(f"{error} (data is likely too large)") from error if content_type == CONTENT_JSON: values = self.process_json(json_out, json_path) diff --git a/pyproject.toml b/pyproject.toml index 98a9376..731228b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,7 @@ target-version = "py38" [tool.ruff.lint] select = ["I", "PL", "UP"] -ignore = ["PLR2004", "UP030", "UP032"] +ignore = ["PLR2004", "UP030"] [tool.ruff.format] line-ending = "lf" From 94ff9c0b51d6b8ab4728448e072c00b2a2f96181 Mon Sep 17 00:00:00 2001 From: Justin Myers Date: Sun, 24 Mar 2024 07:42:47 -0700 Subject: [PATCH 08/11] Update README badge --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 1a12c96..6ceac59 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PortalBase/actions :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 Base Library for the Portal-style libraries. This library only contains base classes and is not intended to be run on its own. From 7e70257a283665bed1c035849302946f268a93b6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 29 Jul 2024 10:36:45 -0500 Subject: [PATCH 09/11] ruff config file. Merge main. remove duplicate 'of'. --- adafruit_portalbase/__init__.py | 4 +- adafruit_portalbase/graphics.py | 4 +- adafruit_portalbase/network.py | 70 +++++++------------- adafruit_portalbase/wifi_esp32s2.py | 4 +- docs/conf.py | 4 +- ruff.toml | 99 +++++++++++++++++++++++++++++ 6 files changed, 125 insertions(+), 60 deletions(-) create mode 100644 ruff.toml diff --git a/adafruit_portalbase/__init__.py b/adafruit_portalbase/__init__.py index 953163d..457af08 100644 --- a/adafruit_portalbase/__init__.py +++ b/adafruit_portalbase/__init__.py @@ -355,9 +355,7 @@ def create_time_alarm(self, sleep_time): """ if self._alarm: - return self._alarm.time.TimeAlarm( - monotonic_time=time.monotonic() + sleep_time - ) + return self._alarm.time.TimeAlarm(monotonic_time=time.monotonic() + sleep_time) raise NotImplementedError( "Alarms not supported. Make sure you have the latest CircuitPython." ) diff --git a/adafruit_portalbase/graphics.py b/adafruit_portalbase/graphics.py index 1e668b1..711c7cc 100644 --- a/adafruit_portalbase/graphics.py +++ b/adafruit_portalbase/graphics.py @@ -136,9 +136,7 @@ def qrcode(self, qr_data, *, qr_size=1, x=0, y=0, qr_color=0x000000): # noqa: P palette[1] = qr_color # bitmap the size of the matrix, plus border, monochrome (2 colors) - qr_bitmap = displayio.Bitmap( - qrcode.matrix.width + 2, qrcode.matrix.height + 2, 2 - ) + qr_bitmap = displayio.Bitmap(qrcode.matrix.width + 2, qrcode.matrix.height + 2, 2) for i in range(qr_bitmap.width * qr_bitmap.height): qr_bitmap[i] = 0 diff --git a/adafruit_portalbase/network.py b/adafruit_portalbase/network.py index 33937e7..9d4390d 100755 --- a/adafruit_portalbase/network.py +++ b/adafruit_portalbase/network.py @@ -38,9 +38,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase.git" # you'll need to pass in an io username and key -TIME_SERVICE = ( - "https://io.adafruit.com/api/v2/%s/integrations/time/strftime?x-aio-key=%s" -) +TIME_SERVICE = "https://io.adafruit.com/api/v2/%s/integrations/time/strftime?x-aio-key=%s" # our strftime is %Y-%m-%d %H:%M:%S.%L %j %u %z %Z see http://strftime.net/ for decoding details # See https://apidock.com/ruby/DateTime/strftime for full options TIME_SERVICE_FORMAT = "%Y-%m-%d %H:%M:%S.%L %j %u %z %Z" @@ -146,9 +144,7 @@ def _get_setting(self, setting_name, show_error=True): at a minimum in order to use network related features""" ) else: - print( - f"{setting_name} not found. Please add this setting to settings.toml." - ) + print(f"{setting_name} not found. Please add this setting to settings.toml.") return None def neo_status(self, value): @@ -170,16 +166,12 @@ def json_traverse(json, path): """ value = json if not isinstance(path, (list, tuple)): - raise ValueError( - "The json_path parameter should be enclosed in a list or tuple." - ) + raise ValueError("The json_path parameter should be enclosed in a list or tuple.") for x in path: try: value = value[x] except (TypeError, KeyError, IndexError) as error: - raise ValueError( - "The specified json_path was not found in the results." - ) from error + raise ValueError("The specified json_path was not found in the results.") from error gc.collect() return value @@ -206,7 +198,7 @@ def get_strftime(self, time_format, location=None, max_attempts=10): Fetch a custom strftime relative to your location. :param str location: Your city and country, e.g. ``"America/New_York"``. - :param max_attempts: The maximum number of of attempts to connect to WiFi before + :param max_attempts: The maximum number of attempts to connect to WiFi before failing or use None to disable. Defaults to 10. """ @@ -218,7 +210,9 @@ def get_strftime(self, time_format, location=None, max_attempts=10): aio_key = self._get_setting("AIO_KEY") except KeyError: raise KeyError( - "\n\nOur time service requires a login/password to rate-limit. Please register for a free adafruit.io account and place the user/key in your secrets file under 'AIO_USERNAME' and 'AIO_KEY'" + "\n\nOur time service requires a login/password to rate-limit. " + "Please register for a free adafruit.io account and place the user/key " + "in your secrets file under 'AIO_USERNAME' and 'AIO_KEY'" ) from KeyError if location is None: @@ -238,8 +232,7 @@ def get_strftime(self, time_format, location=None, max_attempts=10): if response.status_code != 200: print(response) error_message = ( - "Error connecting to Adafruit IO. The response was: " - + response.text + "Error connecting to Adafruit IO. The response was: " + response.text ) self.neo_status(STATUS_HTTP_ERROR) raise RuntimeError(error_message) @@ -260,16 +253,15 @@ def get_strftime(self, time_format, location=None, max_attempts=10): def get_local_time(self, location=None, max_attempts=10): """ - Fetch and "set" the local time of this microcontroller to the local time at the location, using an internet time API. + Fetch and "set" the local time of this microcontroller to the local time at the location, + using an internet time API. :param str location: Your city and country, e.g. ``"America/New_York"``. - :param max_attempts: The maximum number of of attempts to connect to WiFi before + :param max_attempts: The maximum number of attempts to connect to WiFi before failing or use None to disable. Defaults to 10. """ - reply = self.get_strftime( - TIME_SERVICE_FORMAT, location=location, max_attempts=max_attempts - ) + reply = self.get_strftime(TIME_SERVICE_FORMAT, location=location, max_attempts=max_attempts) if reply: times = reply.split(" ") the_date = times[0] @@ -319,9 +311,7 @@ def wget(self, url, filename, *, chunk_size=12000, headers=None): print("Date: {}".format(headers["date"])) self.neo_status(STATUS_HTTP_ERROR) # red = http error raise HttpError( - "Code {}: {}".format( - response.status_code, response.reason.decode("utf-8") - ), + "Code {}: {}".format(response.status_code, response.reason.decode("utf-8")), response, ) @@ -340,10 +330,7 @@ def wget(self, url, filename, *, chunk_size=12000, headers=None): remaining -= len(i) file.write(i) if self._debug: - print( - "Read %d bytes, %d remaining" - % (content_length - remaining, remaining) - ) + print("Read %d bytes, %d remaining" % (content_length - remaining, remaining)) else: print(".", end="") if not remaining: @@ -352,9 +339,7 @@ def wget(self, url, filename, *, chunk_size=12000, headers=None): response.close() stamp = time.monotonic() - stamp - print( - "Created file of %d bytes in %0.1f seconds" % (os.stat(filename)[6], stamp) - ) + print("Created file of %d bytes in %0.1f seconds" % (os.stat(filename)[6], stamp)) self.neo_status(STATUS_OFF) if not content_length == os.stat(filename)[6]: raise RuntimeError @@ -363,7 +348,7 @@ def connect(self, max_attempts=10): """ Connect to WiFi using the settings found in secrets.py - :param max_attempts: The maximum number of of attempts to connect to WiFi before + :param max_attempts: The maximum number of attempts to connect to WiFi before failing or use None to disable. Defaults to 10. """ @@ -392,19 +377,12 @@ def connect(self, max_attempts=10): while not self._wifi.is_connected: # secrets dictionary must contain 'ssid' and 'password' at a minimum print("Connecting to AP", secret_entry["ssid"]) - if ( - secret_entry["ssid"] == "CHANGE ME" - or secret_entry["password"] == "CHANGE ME" - ): + if secret_entry["ssid"] == "CHANGE ME" or secret_entry["password"] == "CHANGE ME": change_me = "\n" + "*" * 45 change_me += "\nPlease update the 'settings.toml' file on your\n" change_me += "CIRCUITPY drive to include your local WiFi\n" - change_me += ( - "access point SSID name in 'CIRCUITPY_WIFI_SSID' and SSID\n" - ) - change_me += ( - "password in 'CIRCUITPY_WIFI_PASSWORD'. Then save to reload!\n" - ) + change_me += "access point SSID name in 'CIRCUITPY_WIFI_SSID' and SSID\n" + change_me += "password in 'CIRCUITPY_WIFI_PASSWORD'. Then save to reload!\n" change_me += "*" * 45 raise OSError(change_me) self._wifi.neo_status(STATUS_NO_CONNECTION) # red = not connected @@ -425,9 +403,7 @@ def connect(self, max_attempts=10): if self._wifi.is_connected: return - raise OSError( - "Maximum number of attempts reached when trying to connect to WiFi" - ) + raise OSError("Maximum number of attempts reached when trying to connect to WiFi") def _get_io_client(self): if self._io_client is not None: @@ -609,9 +585,7 @@ def check_response(self, response): print("Date: {}".format(headers["date"])) self.neo_status((100, 0, 0)) # red = http error raise HttpError( - "Code {}: {}".format( - response.status_code, response.reason.decode("utf-8") - ), + "Code {}: {}".format(response.status_code, response.reason.decode("utf-8")), response, ) diff --git a/adafruit_portalbase/wifi_esp32s2.py b/adafruit_portalbase/wifi_esp32s2.py index 1e0daa1..94ab14c 100644 --- a/adafruit_portalbase/wifi_esp32s2.py +++ b/adafruit_portalbase/wifi_esp32s2.py @@ -62,9 +62,7 @@ def connect(self, ssid, password): """ wifi.radio.connect(ssid, password) self.pool = socketpool.SocketPool(wifi.radio) - self.requests = adafruit_requests.Session( - self.pool, ssl.create_default_context() - ) + self.requests = adafruit_requests.Session(self.pool, ssl.create_default_context()) self._connected = True def neo_status(self, value): diff --git a/docs/conf.py b/docs/conf.py index 241b83e..3ef6e06 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,9 +58,7 @@ creation_year = "2020" 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 + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..db37c83 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,99 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +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 + +] + +[format] +line-ending = "lf" From 5ae0842942d811a4932b518947f5051f30ae9409 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 29 Jul 2024 11:08:54 -0500 Subject: [PATCH 10/11] remove ruff config in pyproject.toml, use ruff.toml --- pyproject.toml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 731228b..885661c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,16 +41,6 @@ classifiers = [ ] dynamic = ["dependencies", "optional-dependencies"] -[tool.ruff] -target-version = "py38" - -[tool.ruff.lint] -select = ["I", "PL", "UP"] -ignore = ["PLR2004", "UP030"] - -[tool.ruff.format] -line-ending = "lf" - [tool.setuptools] packages = ["adafruit_portalbase"] From 7a0a537c086c919b778139fa9bcfc3c8e97a2b7c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 29 Jul 2024 11:23:26 -0500 Subject: [PATCH 11/11] pre-commit config copyright --- .pre-commit-config.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ff19dde..f27b786 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,4 +1,5 @@ -# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers # # SPDX-License-Identifier: Unlicense