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/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,11 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" diff --git a/README.rst b/README.rst index dafc32c..995c096 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 Helper library for the Adafruit FunHouse board @@ -120,7 +120,7 @@ Usage Example pres_label = funhouse.add_text( text="Pres:", text_position=(50, 60), text_color=0xFF00FF ) - funhouse.display.root_group = funhouse.splash + funhouse.display.root_group = funhouse.root_group while True: funhouse.set_text("Temp %0.1F" % dps310.temperature, temp_label) diff --git a/adafruit_funhouse/__init__.py b/adafruit_funhouse/__init__.py index c3bd624..ccc7528 100755 --- a/adafruit_funhouse/__init__.py +++ b/adafruit_funhouse/__init__.py @@ -29,13 +29,16 @@ import gc import time + from adafruit_portalbase import PortalBase -from adafruit_funhouse.network import Network + from adafruit_funhouse.graphics import Graphics +from adafruit_funhouse.network import Network from adafruit_funhouse.peripherals import Peripherals try: - from typing import Optional, Dict, Union, Callable, Sequence, List + from typing import Callable, Dict, List, Optional, Sequence, Union + from adafruit_dotstar import DotStar except ImportError: pass @@ -67,7 +70,6 @@ class FunHouse(PortalBase): """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements def __init__( self, *, diff --git a/adafruit_funhouse/graphics.py b/adafruit_funhouse/graphics.py index d93f4e5..873a551 100755 --- a/adafruit_funhouse/graphics.py +++ b/adafruit_funhouse/graphics.py @@ -44,14 +44,8 @@ class Graphics(GraphicsBase): """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements, too-few-public-methods def __init__( - self, - *, - default_bg: int = 0, - rotation: int = 270, - scale: int = 1, - debug: bool = False + self, *, default_bg: int = 0, rotation: int = 270, scale: int = 1, debug: bool = False ) -> None: self._debug = debug self.display = board.DISPLAY diff --git a/adafruit_funhouse/network.py b/adafruit_funhouse/network.py index 2bacf1c..ed17b9d 100755 --- a/adafruit_funhouse/network.py +++ b/adafruit_funhouse/network.py @@ -28,13 +28,15 @@ """ import ssl + import adafruit_minimqtt.adafruit_minimqtt as MQTT from adafruit_io.adafruit_io import IO_MQTT from adafruit_portalbase.network import NetworkBase from adafruit_portalbase.wifi_esp32s2 import WiFi try: - from typing import Optional, Union, Callable + from typing import Callable, Optional, Union + from adafruit_dotstar import DotStar except ImportError: pass @@ -56,7 +58,6 @@ class Network(NetworkBase): """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements def __init__( self, *, @@ -73,17 +74,15 @@ def __init__( def init_io_mqtt(self) -> IO_MQTT: """Initialize MQTT for Adafruit IO""" - try: - aio_username = self._secrets["aio_username"] - aio_key = self._secrets["aio_key"] - except KeyError: - raise KeyError( - "Adafruit IO secrets are kept in secrets.py, please add them there!\n\n" - ) from KeyError + aio_username = self._get_setting["ADAFRUIT_AIO_USERNAME"] + aio_key = self._get_setting["ADAFRUIT_AIO_KEY"] + if None in {aio_username, aio_key}: + raise AttributeError( + "Adafruit IO keys are kept in settings.toml, please add them there." + ) return self.init_mqtt(IO_MQTT_BROKER, 8883, aio_username, aio_key, True) - # pylint: disable=too-many-arguments def init_mqtt( self, broker: str, @@ -114,9 +113,7 @@ def _get_mqtt_client(self) -> Union[MQTT.MQTT, IO_MQTT]: return self._mqtt_client raise RuntimeError("Please initialize MQTT before using") - def mqtt_loop( - self, *args: int, suppress_mqtt_errors: bool = True, **kwargs: int - ) -> None: + def mqtt_loop(self, *args: int, suppress_mqtt_errors: bool = True, **kwargs: int) -> None: """Run the MQTT Loop""" self._get_mqtt_client() if suppress_mqtt_errors: @@ -124,12 +121,11 @@ def mqtt_loop( if self._mqtt_client is not None: self._mqtt_client.loop(*args, **kwargs) except MQTT.MMQTTException as err: - print("MMQTTException: {0}".format(err)) + print(f"MMQTTException: {err}") except OSError as err: - print("OSError: {0}".format(err)) - else: - if self._mqtt_client is not None: - self._mqtt_client.loop(*args, **kwargs) + print(f"OSError: {err}") + elif self._mqtt_client is not None: + self._mqtt_client.loop(*args, **kwargs) def mqtt_publish( self, @@ -144,14 +140,11 @@ def mqtt_publish( if self._mqtt_client is not None: self._mqtt_client.publish(*args, **kwargs) except OSError as err: - print("OSError: {0}".format(err)) - else: - if self._mqtt_client is not None: - self._mqtt_client.publish(*args, **kwargs) + print(f"OSError: {err}") + elif self._mqtt_client is not None: + self._mqtt_client.publish(*args, **kwargs) - def mqtt_connect( - self, *args: Union[bool, str, int], **kwargs: Union[bool, str, int] - ) -> None: + def mqtt_connect(self, *args: Union[bool, str, int], **kwargs: Union[bool, str, int]) -> None: """Connect to MQTT""" self._get_mqtt_client() if self._mqtt_client is not None: diff --git a/adafruit_funhouse/peripherals.py b/adafruit_funhouse/peripherals.py index d759449..f36eb35 100755 --- a/adafruit_funhouse/peripherals.py +++ b/adafruit_funhouse/peripherals.py @@ -27,14 +27,14 @@ """ -import board -from digitalio import DigitalInOut, Direction, Pull -from analogio import AnalogIn -import touchio -import simpleio -import adafruit_dps310 import adafruit_ahtx0 import adafruit_dotstar +import adafruit_dps310 +import board +import simpleio +import touchio +from analogio import AnalogIn +from digitalio import DigitalInOut, Direction, Pull try: from typing import Optional @@ -54,7 +54,6 @@ class Peripherals: See https://circuitpython.readthedocs.io/projects/dotstar/en/latest/api.html """ - # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements def __init__(self) -> None: # Dotstars self.dotstars = adafruit_dotstar.DotStar( diff --git a/docs/api.rst b/docs/api.rst index a069a94..e01376c 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_funhouse :members: diff --git a/docs/conf.py b/docs/conf.py index de4a500..6ad4dc5 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("..")) @@ -33,7 +31,6 @@ "ssl", "wifi", "socketpool", - "secrets", "analogio", "touchio", "bitmaptools", @@ -60,9 +57,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 + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" diff --git a/examples/funhouse_adafruit_io_mqtt.py b/examples/funhouse_adafruit_io_mqtt.py index b10fc4e..db2ec66 100755 --- a/examples/funhouse_adafruit_io_mqtt.py +++ b/examples/funhouse_adafruit_io_mqtt.py @@ -3,13 +3,13 @@ # # SPDX-License-Identifier: MIT import time + from adafruit_funhouse import FunHouse funhouse = FunHouse(default_bg=None) funhouse.peripherals.set_dotstars(0x800000, 0x808000, 0x008000, 0x000080, 0x800080) -# pylint: disable=unused-argument def connected(client): print("Connected to Adafruit IO! Subscribing...") client.subscribe("buzzer") @@ -17,7 +17,7 @@ def connected(client): def subscribe(client, userdata, topic, granted_qos): - print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + print(f"Subscribed to {topic} with QOS level {granted_qos}") def disconnected(client): @@ -25,7 +25,7 @@ def disconnected(client): 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}") if feed_id == "buzzer": if int(payload) == 1: funhouse.peripherals.play_tone(2000, 0.25) @@ -35,8 +35,6 @@ def message(client, feed_id, payload): funhouse.peripherals.dotstars.fill(color) -# pylint: enable=unused-argument - # Initialize a new MQTT Client object funhouse.network.init_io_mqtt() funhouse.network.on_mqtt_connect = connected @@ -60,9 +58,7 @@ def message(client, feed_id, payload): funhouse.peripherals.led = True print("Sending data to adafruit IO!") funhouse.network.mqtt_publish("temperature", funhouse.peripherals.temperature) - funhouse.network.mqtt_publish( - "humidity", int(funhouse.peripherals.relative_humidity) - ) + funhouse.network.mqtt_publish("humidity", int(funhouse.peripherals.relative_humidity)) funhouse.network.mqtt_publish("pressure", int(funhouse.peripherals.pressure)) sensorwrite_timestamp = time.monotonic() # Send PIR only if changed! diff --git a/examples/funhouse_simpletest.py b/examples/funhouse_simpletest.py index 57cdde4..f34a0a2 100644 --- a/examples/funhouse_simpletest.py +++ b/examples/funhouse_simpletest.py @@ -4,6 +4,7 @@ # SPDX-License-Identifier: Unlicense import board from digitalio import DigitalInOut, Direction, Pull + from adafruit_funhouse import FunHouse funhouse = FunHouse( @@ -31,38 +32,20 @@ def set_label_color(conditional, index, on_color): # Create the labels funhouse.display.root_group = None -slider_label = funhouse.add_text( - text="Slider:", text_position=(50, 30), text_color=0x606060 -) -capright_label = funhouse.add_text( - text="Touch", text_position=(85, 10), text_color=0x606060 -) +slider_label = funhouse.add_text(text="Slider:", text_position=(50, 30), text_color=0x606060) +capright_label = funhouse.add_text(text="Touch", text_position=(85, 10), text_color=0x606060) pir_label = funhouse.add_text(text="PIR", text_position=(60, 10), text_color=0x606060) -capleft_label = funhouse.add_text( - text="Touch", text_position=(25, 10), text_color=0x606060 -) +capleft_label = funhouse.add_text(text="Touch", text_position=(25, 10), text_color=0x606060) onoff_label = funhouse.add_text(text="OFF", text_position=(10, 25), text_color=0x606060) up_label = funhouse.add_text(text="UP", text_position=(10, 10), text_color=0x606060) sel_label = funhouse.add_text(text="SEL", text_position=(10, 60), text_color=0x606060) -down_label = funhouse.add_text( - text="DOWN", text_position=(10, 100), text_color=0x606060 -) -jst1_label = funhouse.add_text( - text="SENSOR 1", text_position=(40, 80), text_color=0x606060 -) -jst2_label = funhouse.add_text( - text="SENSOR 2", text_position=(40, 95), text_color=0x606060 -) -jst3_label = funhouse.add_text( - text="SENSOR 3", text_position=(40, 110), text_color=0x606060 -) -temp_label = funhouse.add_text( - text="Temp:", text_position=(50, 45), text_color=0xFF00FF -) -pres_label = funhouse.add_text( - text="Pres:", text_position=(50, 60), text_color=0xFF00FF -) -funhouse.display.root_group = funhouse.splash +down_label = funhouse.add_text(text="DOWN", text_position=(10, 100), text_color=0x606060) +jst1_label = funhouse.add_text(text="SENSOR 1", text_position=(40, 80), text_color=0x606060) +jst2_label = funhouse.add_text(text="SENSOR 2", text_position=(40, 95), text_color=0x606060) +jst3_label = funhouse.add_text(text="SENSOR 3", text_position=(40, 110), text_color=0x606060) +temp_label = funhouse.add_text(text="Temp:", text_position=(50, 45), text_color=0xFF00FF) +pres_label = funhouse.add_text(text="Pres:", text_position=(50, 60), text_color=0xFF00FF) +funhouse.display.root_group = funhouse.root_group while True: funhouse.set_text("Temp %0.1F" % funhouse.peripherals.temperature, temp_label) diff --git a/examples/funhouse_temperature_logger.py b/examples/funhouse_temperature_logger.py index 00dee9a..0133dc9 100755 --- a/examples/funhouse_temperature_logger.py +++ b/examples/funhouse_temperature_logger.py @@ -16,9 +16,7 @@ DELAY = 180 FEED = "temperature" -TEMPERATURE_OFFSET = ( - 3 # Degrees C to adjust the temperature to compensate for board produced heat -) +TEMPERATURE_OFFSET = 3 # Degrees C to adjust the temperature to compensate for board produced heat # Turn things off funhouse.peripherals.dotstars.fill(0) @@ -41,5 +39,5 @@ def log_data(): while True: log_data() - print("Sleeping for {} seconds...".format(DELAY)) + print(f"Sleeping for {DELAY} seconds...") funhouse.enter_light_sleep(DELAY) 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" pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy