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 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +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: 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 + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - 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/README.rst b/README.rst index e1d339d..fa5faf0 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 CircuitPython library for creating Adafruit IO dashboards. @@ -99,7 +99,7 @@ Usage Example def pub_lamp(lamp): if type(lamp) == str: - lamp = eval(lamp) # pylint: disable=eval-used + lamp = eval(lamp) iot.publish("lamp", str(not lamp)) # funhouse.set_text(f"Lamp: {not lamp}", 0) time.sleep(0.3) diff --git a/adafruit_dash_display.py b/adafruit_dash_display.py index 189d669..73f9935 100644 --- a/adafruit_dash_display.py +++ b/adafruit_dash_display.py @@ -22,8 +22,10 @@ https://github.com/adafruit/circuitpython/releases """ + try: - from typing import Tuple, Callable, Optional, Any + from typing import Any, Callable, Optional, Tuple + from adafruit_io.adafruit_io import IO_MQTT from digitalio import DigitalInOut except ImportError: @@ -31,6 +33,7 @@ import time from collections import OrderedDict + import displayio import terminalio from adafruit_display_shapes.rect import Rect @@ -62,7 +65,7 @@ def __init__( color: Optional[int], pub: Optional[Callable], index: int, - ): # pylint: disable=too-many-arguments + ): self._key = key self.default_text = default_text self._text = formatted_text @@ -149,7 +152,7 @@ def last_val(self, value: str) -> None: self._last_val = value -class Hub: # pylint: disable=too-many-instance-attributes +class Hub: """ Object that lets you make an IOT dashboard @@ -193,7 +196,6 @@ def __init__( self.display.root_group = self.splash def simple_text_callback( - # pylint: disable=unused-argument self, client: IO_MQTT, feed_id: str, @@ -239,7 +241,7 @@ def add_device( color_callback: Optional[int] = None, callback: Optional[Callable] = None, pub_method: Optional[Callable] = None, - ): # pylint: disable=too-many-arguments + ): """Adds a feed/device to the UI :param feed_key: The Adafruit IO feed key. @@ -305,7 +307,6 @@ def get(self) -> None: time.sleep(0.1) self.io_mqtt.loop() - # pylint: disable=unused-argument @staticmethod def connected(client: IO_MQTT) -> None: """Callback for when the device is connected to Adafruit IO diff --git a/docs/api.rst b/docs/api.rst index 3c4b23d..c074fde 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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_dash_display :members: :member-order: bysource diff --git a/docs/conf.py b/docs/conf.py index 6cb1028..a3f0497 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -57,9 +55,7 @@ creation_year = "2021" 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 + " Eva Herrada for Adafruit Industries" author = "Eva Herrada" diff --git a/examples/dash_display_advancedtest.py b/examples/dash_display_advancedtest.py index 259689b..2a5af86 100644 --- a/examples/dash_display_advancedtest.py +++ b/examples/dash_display_advancedtest.py @@ -3,16 +3,18 @@ import time from os import getenv -import displayio + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board -from digitalio import DigitalInOut, Direction, Pull -from adafruit_display_text.label import Label +import displayio import terminalio import touchio import wifi -import adafruit_connection_manager -import adafruit_minimqtt.adafruit_minimqtt as MQTT +from adafruit_display_text.label import Label from adafruit_io.adafruit_io import IO_MQTT +from digitalio import DigitalInOut, Direction, Pull + from adafruit_dash_display import Hub up = DigitalInOut(board.BUTTON_UP) @@ -93,8 +95,6 @@ rgb_group.append(G) rgb_group.append(B) -# pylint: disable=unused-argument - def rgb(last): display.root_group = None @@ -131,7 +131,7 @@ def rgb(last): continue if submit.value: - color = ["{:02x}".format(colors[i]) for i in range(len(colors))] + color = [f"{colors[i]:02x}" for i in range(len(colors))] color = "#" + "".join(color) iot.publish("neopixel", color) break @@ -144,15 +144,15 @@ def rgb(last): time.sleep(0.1) -def rgb_set_color(message): # pylint: disable=unused-argument +def rgb_set_color(message): return int(message[1:], 16) def door_color(message): door = bool(int(message)) if door: - return int(0x00FF00) - return int(0xFF0000) + return 0x00FF00 + return 0xFF0000 def on_door(client, feed_id, message): @@ -164,7 +164,7 @@ def on_door(client, feed_id, message): def pub_lamp(lamp): if isinstance(lamp, str): - lamp = eval(lamp) # pylint: disable=eval-used + lamp = eval(lamp) iot.publish("lamp", str(not lamp)) # funhouse.set_text(f"Lamp: {not lamp}", 0) time.sleep(0.3) @@ -205,9 +205,7 @@ def pub_lamp(lamp): default_text="Temperature: ", formatted_text="Temperature: {:.1f} C", ) -iot.add_device( - feed_key="humidity", default_text="Humidity: ", formatted_text="Humidity: {:.2f}%" -) +iot.add_device(feed_key="humidity", default_text="Humidity: ", formatted_text="Humidity: {:.2f}%") iot.add_device( feed_key="neopixel", default_text="LED: ", diff --git a/examples/dash_display_client_examples/battery_daughter.py b/examples/dash_display_client_examples/battery_daughter.py index 51a340e..5e41794 100644 --- a/examples/dash_display_client_examples/battery_daughter.py +++ b/examples/dash_display_client_examples/battery_daughter.py @@ -3,21 +3,20 @@ import time from os import getenv -import board -from adafruit_lc709203f import LC709203F -import busio -from digitalio import DigitalInOut + import adafruit_connection_manager -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi import adafruit_esp32spi_wifimanager -import neopixel +import adafruit_displayio_ssd1306 import adafruit_minimqtt.adafruit_minimqtt as MQTT -from adafruit_io.adafruit_io import IO_MQTT - +import board +import busio import displayio +import neopixel import terminalio from adafruit_display_text import label -import adafruit_displayio_ssd1306 +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager +from adafruit_io.adafruit_io import IO_MQTT +from adafruit_lc709203f import LC709203F +from digitalio import DigitalInOut displayio.release_displays() @@ -59,24 +58,21 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Define callback functions which will be called when certain events happen. -# pylint: disable=unused-argument def connected(client): client.subscribe("battery") def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new feed. - print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + print(f"Subscribed to {topic} with QOS level {granted_qos}") def message(client, feed_id, payload): - print("Feed {0} received new value: {1}".format(feed_id, payload)) + print(f"Feed {feed_id} received new value: {payload}") # Connect to WiFi @@ -119,9 +115,7 @@ def message(client, feed_id, payload): splash = displayio.Group() display.root_group = splash -digital_label = label.Label( - terminalio.FONT, text="Battery Percent: ", color=0xFFFFFF, x=4, y=4 -) +digital_label = label.Label(terminalio.FONT, text="Battery Percent: ", color=0xFFFFFF, x=4, y=4) splash.append(digital_label) alarm_label = label.Label(terminalio.FONT, text="Voltage: ", color=0xFFFFFF, x=4, y=14) splash.append(alarm_label) diff --git a/examples/dash_display_client_examples/door_daughter.py b/examples/dash_display_client_examples/door_daughter.py index 01b3966..874f3ce 100644 --- a/examples/dash_display_client_examples/door_daughter.py +++ b/examples/dash_display_client_examples/door_daughter.py @@ -2,16 +2,16 @@ # SPDX-License-Identifier: MIT from os import getenv + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board import busio -import adafruit_connection_manager -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi import adafruit_esp32spi_wifimanager import neopixel -import adafruit_minimqtt.adafruit_minimqtt as MQTT +from adafruit_debouncer import Debouncer +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager from adafruit_io.adafruit_io import IO_MQTT from digitalio import DigitalInOut, Direction, Pull -from adafruit_debouncer import Debouncer # Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml # (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.) @@ -56,9 +56,7 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Connect to WiFi print("Connecting to WiFi...") diff --git a/examples/dash_display_client_examples/neopixel_daughter.py b/examples/dash_display_client_examples/neopixel_daughter.py index 33a73a3..73a1803 100644 --- a/examples/dash_display_client_examples/neopixel_daughter.py +++ b/examples/dash_display_client_examples/neopixel_daughter.py @@ -2,13 +2,13 @@ # SPDX-License-Identifier: MIT from os import getenv + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board import busio -import adafruit_connection_manager -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi import adafruit_esp32spi_wifimanager import neopixel -import adafruit_minimqtt.adafruit_minimqtt as MQTT +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager from adafruit_io.adafruit_io import IO_MQTT from digitalio import DigitalInOut @@ -52,27 +52,22 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Define callback functions which will be called when certain events happen. -# pylint: disable=unused-argument def connected(client): client.subscribe("neopixel") def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new feed. - print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + print(f"Subscribed to {topic} with QOS level {granted_qos}") def on_neopixel(client, topic, message): print(message) - colors = [ - int(message.split("#")[1][i : i + 2], 16) for i in range(0, len(message) - 1, 2) - ] + colors = [int(message.split("#")[1][i : i + 2], 16) for i in range(0, len(message) - 1, 2)] print(colors) pixels.fill(colors) diff --git a/examples/dash_display_client_examples/neopixel_setter.py b/examples/dash_display_client_examples/neopixel_setter.py index ea86897..cc9a8d9 100644 --- a/examples/dash_display_client_examples/neopixel_setter.py +++ b/examples/dash_display_client_examples/neopixel_setter.py @@ -2,8 +2,9 @@ # SPDX-License-Identifier: MIT import time -from adafruit_funhouse import FunHouse + from adafruit_display_shapes.rect import Rect +from adafruit_funhouse import FunHouse funhouse = FunHouse(default_bg=None) @@ -19,15 +20,9 @@ B_label = funhouse.add_text( text=" +\nB:\n -", text_position=(175, 120), text_scale=2, text_color=0xFFFFFF ) -R = funhouse.add_text( - text="00", text_position=(35, 120), text_scale=2, text_color=0x000000 -) -G = funhouse.add_text( - text="00", text_position=(120, 120), text_scale=2, text_color=0x000000 -) -B = funhouse.add_text( - text="00", text_position=(205, 120), text_scale=2, text_color=0x000000 -) +R = funhouse.add_text(text="00", text_position=(35, 120), text_scale=2, text_color=0x000000) +G = funhouse.add_text(text="00", text_position=(120, 120), text_scale=2, text_color=0x000000) +B = funhouse.add_text(text="00", text_position=(205, 120), text_scale=2, text_color=0x000000) funhouse.display.root_group = funhouse.splash index = 0 @@ -52,7 +47,7 @@ funhouse.set_text(hex(colors[index])[2:], index + 3) if funhouse.peripherals.captouch8: - color = ["{:02x}".format(colors[i]) for i in range(len(colors))] + color = [f"{colors[i]:02x}" for i in range(len(colors))] color = "#" + "".join(color) break diff --git a/examples/dash_display_client_examples/neopixel_setter_daughter.py b/examples/dash_display_client_examples/neopixel_setter_daughter.py index 0d6c749..6dc5e83 100644 --- a/examples/dash_display_client_examples/neopixel_setter_daughter.py +++ b/examples/dash_display_client_examples/neopixel_setter_daughter.py @@ -1,25 +1,26 @@ # SPDX-FileCopyrightText: 2021 Eva Herrada for Adafruit Industries # SPDX-License-Identifier: MIT -import time import math +import time from os import getenv + +import adafruit_imageload +import adafruit_touchscreen import board import busio -from digitalio import DigitalInOut import displayio + +# Import NeoPixel Library +import neopixel from adafruit_display_shapes.rect import Rect -import adafruit_imageload -import adafruit_touchscreen # ESP32 SPI from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager -# Import NeoPixel Library -import neopixel - # Import Adafruit IO HTTP Client from adafruit_io.adafruit_io import IO_HTTP, AdafruitIO_RequestError +from digitalio import DigitalInOut ts = adafruit_touchscreen.Touchscreen( board.TOUCH_XL, @@ -123,9 +124,7 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Create an instance of the Adafruit IO HTTP client io = IO_HTTP(aio_username, aio_key, wifi) @@ -152,7 +151,7 @@ if colors[index]: group[1].fill = color if last_color != color: - color_str = "#{:06x}".format(color) + color_str = f"#{color:06x}" print(color_str) io.send_data(neopixel_feed["key"], color_str) last_color = color diff --git a/examples/dash_display_client_examples/relay_daughter.py b/examples/dash_display_client_examples/relay_daughter.py index b3e6706..ec999df 100644 --- a/examples/dash_display_client_examples/relay_daughter.py +++ b/examples/dash_display_client_examples/relay_daughter.py @@ -2,13 +2,13 @@ # SPDX-License-Identifier: MIT from os import getenv + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board import busio -import adafruit_connection_manager -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi import adafruit_esp32spi_wifimanager import neopixel -import adafruit_minimqtt.adafruit_minimqtt as MQTT +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager from adafruit_io.adafruit_io import IO_MQTT from digitalio import DigitalInOut, Direction @@ -54,24 +54,21 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Define callback functions which will be called when certain events happen. -# pylint: disable=unused-argument def connected(client): client.subscribe("lamp") def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new feed. - print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + print(f"Subscribed to {topic} with QOS level {granted_qos}") def on_lamp(client, topic, message): - RELAY.value = eval(message) # pylint: disable=eval-used + RELAY.value = eval(message) # Connect to WiFi diff --git a/examples/dash_display_client_examples/relay_hi_daughter.py b/examples/dash_display_client_examples/relay_hi_daughter.py index 9d8c0a5..8185796 100644 --- a/examples/dash_display_client_examples/relay_hi_daughter.py +++ b/examples/dash_display_client_examples/relay_hi_daughter.py @@ -2,13 +2,13 @@ # SPDX-License-Identifier: MIT from os import getenv + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board import busio -import adafruit_connection_manager -from adafruit_esp32spi import adafruit_esp32spi -from adafruit_esp32spi import adafruit_esp32spi_wifimanager import neopixel -import adafruit_minimqtt.adafruit_minimqtt as MQTT +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager from adafruit_io.adafruit_io import IO_MQTT from digitalio import DigitalInOut, Direction @@ -54,20 +54,17 @@ # BLUE_LED = PWMOut.PWMOut(esp, 25) # status_pixel = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -wifi = adafruit_esp32spi_wifimanager.WiFiManager( - esp, ssid, password, status_pixel=status_pixel -) +wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel) # Define callback functions which will be called when certain events happen. -# pylint: disable=unused-argument def connected(client): client.subscribe("heatindex") def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new feed. - print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + print(f"Subscribed to {topic} with QOS level {granted_qos}") def on_hi(client, topic, message): diff --git a/examples/dash_display_client_examples/temp_humid_daughter.py b/examples/dash_display_client_examples/temp_humid_daughter.py index f69ad2b..89caefb 100644 --- a/examples/dash_display_client_examples/temp_humid_daughter.py +++ b/examples/dash_display_client_examples/temp_humid_daughter.py @@ -2,20 +2,19 @@ # SPDX-License-Identifier: MIT from os import getenv -import wifi + import adafruit_connection_manager import adafruit_minimqtt.adafruit_minimqtt as MQTT +import adafruit_sht4x +import board +import busio +import wifi from adafruit_io.adafruit_io import IO_MQTT - from adafruit_magtag.magtag import MagTag -import busio -import board -import adafruit_sht4x # Add a settings.toml to your filesystem that has token variables "CIRCUITPY_WIFI_SSID" and # "CIRCUITPY_WIFI_PASSWORD" with your WiFi credentials. DO NOT share that file or commit it # into Git or other source control. -# pylint: disable=no-name-in-module,wrong-import-order magtag = MagTag() diff --git a/examples/dash_display_simpletest.py b/examples/dash_display_simpletest.py index ec0a25e..34f4a2c 100644 --- a/examples/dash_display_simpletest.py +++ b/examples/dash_display_simpletest.py @@ -3,13 +3,15 @@ import time from os import getenv + +import adafruit_connection_manager +import adafruit_minimqtt.adafruit_minimqtt as MQTT import board -from digitalio import DigitalInOut, Direction, Pull import touchio import wifi -import adafruit_connection_manager -import adafruit_minimqtt.adafruit_minimqtt as MQTT from adafruit_io.adafruit_io import IO_MQTT +from digitalio import DigitalInOut, Direction, Pull + from adafruit_dash_display import Hub up = DigitalInOut(board.BUTTON_UP) @@ -59,7 +61,7 @@ def pub_lamp(lamp): if isinstance(lamp, str): - lamp = eval(lamp) # pylint: disable=eval-used + lamp = eval(lamp) iot.publish("lamp", str(not lamp)) # funhouse.set_text(f"Lamp: {not lamp}", 0) time.sleep(0.3) @@ -78,9 +80,7 @@ def pub_lamp(lamp): default_text="Temperature: ", formatted_text="Temperature: {:.1f} C", ) -iot.add_device( - feed_key="humidity", default_text="Humidity: ", formatted_text="Humidity: {:.2f}%" -) +iot.add_device(feed_key="humidity", default_text="Humidity: ", formatted_text="Humidity: {:.2f}%") iot.get() 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"