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 be90d8d..44bf2b1 100644 --- a/README.rst +++ b/README.rst @@ -17,9 +17,9 @@ Introduction :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff A helper library for the Adafruit MacroPad RP2040. diff --git a/adafruit_macropad.py b/adafruit_macropad.py index 91954d5..ef959d0 100644 --- a/adafruit_macropad.py +++ b/adafruit_macropad.py @@ -49,39 +49,41 @@ import array import math import time + +import adafruit_midi +import audiocore +import audiomp3 +import audiopwmio import board import digitalio -import rotaryio +import displayio import keypad import neopixel -import displayio -import audiopwmio -import audiocore -import audiomp3 +import rotaryio import usb_hid +import usb_midi +from adafruit_debouncer import Debouncer +from adafruit_hid.consumer_control import ConsumerControl +from adafruit_hid.consumer_control_code import ConsumerControlCode from adafruit_hid.keyboard import Keyboard from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS from adafruit_hid.keycode import Keycode -from adafruit_hid.consumer_control import ConsumerControl -from adafruit_hid.consumer_control_code import ConsumerControlCode from adafruit_hid.mouse import Mouse -import usb_midi -import adafruit_midi -from adafruit_midi.note_on import NoteOn +from adafruit_midi.control_change import ControlChange from adafruit_midi.note_off import NoteOff +from adafruit_midi.note_on import NoteOn from adafruit_midi.pitch_bend import PitchBend -from adafruit_midi.control_change import ControlChange from adafruit_midi.program_change import ProgramChange from adafruit_simple_text_display import SimpleTextDisplay -from adafruit_debouncer import Debouncer try: # Only used for typing - from typing import Tuple, Optional, Union, Iterator - from neopixel import NeoPixel + from typing import Iterator, Optional, Tuple, Union + + import adafruit_hid from keypad import Keys - import adafruit_hid # pylint:disable=ungrouped-imports + from neopixel import NeoPixel except ImportError: pass @@ -113,9 +115,7 @@ class _PixelMapLite: def __init__( self, pixels: NeoPixel, - order: Tuple[ - int, int, int, int, int, int, int, int, int, int, int, int - ] = ROTATED_KEYMAP_0, + order: Tuple[int, int, int, int, int, int, int, int, int, int, int, int] = ROTATED_KEYMAP_0, ): self._pixels = pixels self._order = order @@ -134,8 +134,7 @@ def __setitem__(self, index: int, val: int) -> None: def __getitem__(self, index: int) -> int: if isinstance(index, slice): return [ - self._pixels[self._order[idx]] - for idx in range(*index.indices(self._num_pixels)) + self._pixels[self._order[idx]] for idx in range(*index.indices(self._num_pixels)) ] if index < 0: index += self._num_pixels @@ -171,7 +170,6 @@ def brightness(self, value: float) -> None: self._pixels.brightness = value -# pylint: disable=too-many-lines, disable=invalid-name, too-many-instance-attributes, too-many-public-methods, too-many-arguments class MacroPad: """ Class representing a single MacroPad. @@ -283,10 +281,8 @@ def __init__( self._mouse = None self._layout_class = layout_class self.Keycode = keycode_class - # pylint:disable=global-statement global keycodes keycodes = keycode_class - # pylint:enable=global-statement # Define MIDI: try: @@ -315,13 +311,13 @@ def rotate(self, rotation): is to the left, ``180`` is when the USB port is at the bottom, and ``270`` is when the USB port is to the right. Defaults to ``0``. """ - if rotation not in (0, 90, 180, 270): + if rotation not in {0, 90, 180, 270}: raise ValueError("Only 90 degree rotations are supported.") self._rotation = rotation def _keys_and_pixels( - order: Tuple[int, int, int, int, int, int, int, int, int, int, int, int] + order: Tuple[int, int, int, int, int, int, int, int, int, int, int, int], ) -> None: """ Generate key and pixel maps based on a specified order. @@ -793,9 +789,7 @@ def PitchBend(pitch_bend: int, *, channel: Optional[int] = None) -> PitchBend: return PitchBend(pitch_bend=pitch_bend, channel=channel) @staticmethod - def ControlChange( - control: int, value: int, *, channel: Optional[int] = None - ) -> ControlChange: + def ControlChange(control: int, value: int, *, channel: Optional[int] = None) -> ControlChange: """ Control Change MIDI message. For more details, see the ``adafruit_midi.control_change`` documentation in CircuitPython MIDI: @@ -1081,7 +1075,7 @@ def play_file(self, file_name: str) -> None: if file_name.lower().endswith(".wav"): with audiopwmio.PWMAudioOut(board.SPEAKER) as audio, open( file_name, "rb" - ) as audio_file: # pylint: disable=not-callable + ) as audio_file: wavefile = audiocore.WaveFile(audio_file) audio.play(wavefile) while audio.playing: @@ -1089,7 +1083,7 @@ def play_file(self, file_name: str) -> None: elif file_name.lower().endswith(".mp3"): with audiopwmio.PWMAudioOut(board.SPEAKER) as audio, open( file_name, "rb" - ) as audio_file: # pylint: disable=not-callable + ) as audio_file: mp3file = audiomp3.MP3Decoder(audio_file) audio.play(mp3file) while audio.playing: diff --git a/docs/api.rst b/docs/api.rst index 391287c..f1cf45b 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_macropad :members: diff --git a/docs/conf.py b/docs/conf.py index 20488a9..89e71f8 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("..")) @@ -67,9 +65,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 + " Kattni Rembor" author = "Kattni Rembor" diff --git a/examples/macropad_display_image/macropad_display_image.py b/examples/macropad_display_image/macropad_display_image.py index d3fb46a..f189042 100644 --- a/examples/macropad_display_image/macropad_display_image.py +++ b/examples/macropad_display_image/macropad_display_image.py @@ -4,6 +4,7 @@ """ MacroPad display image demo. Displays a bitmap image on the built-in display. """ + from adafruit_macropad import MacroPad macropad = MacroPad() diff --git a/examples/macropad_grid_layout.py b/examples/macropad_grid_layout.py index ee8469a..16d5d85 100644 --- a/examples/macropad_grid_layout.py +++ b/examples/macropad_grid_layout.py @@ -5,10 +5,12 @@ Grid layout demo for MacroPad. Displays the key pressed in a grid matching the key layout on the built-in display. """ + import displayio import terminalio from adafruit_display_text import bitmap_label as label from adafruit_displayio_layout.layouts.grid_layout import GridLayout + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -39,6 +41,6 @@ key_event = macropad.keys.events.get() if key_event: if key_event.pressed: - labels[key_event.key_number].text = "KEY{}".format(key_event.key_number) + labels[key_event.key_number].text = f"KEY{key_event.key_number}" else: labels[key_event.key_number].text = "" diff --git a/examples/macropad_keyboard_layout.py b/examples/macropad_keyboard_layout.py index 6f42f1f..c53b528 100644 --- a/examples/macropad_keyboard_layout.py +++ b/examples/macropad_keyboard_layout.py @@ -4,9 +4,12 @@ """ International layout demo for MacroPad. """ + import time + from keyboard_layout_win_fr import KeyboardLayout from keycode_win_fr import Keycode + from adafruit_macropad import MacroPad macropad = MacroPad( @@ -39,7 +42,6 @@ macropad.keyboard.press(keycode) else: macropad.keyboard_layout.write(keycode) - else: - if isinstance(keycode, int): - macropad.keyboard.release(keycode) + elif isinstance(keycode, int): + macropad.keyboard.release(keycode) time.sleep(0.05) diff --git a/examples/macropad_keyboard_mouse.py b/examples/macropad_keyboard_mouse.py index 4900acf..ad76579 100755 --- a/examples/macropad_keyboard_mouse.py +++ b/examples/macropad_keyboard_mouse.py @@ -8,6 +8,7 @@ pressed. Finally, it moves the mouse left and right when the rotary encoder is rotated counterclockwise and clockwise respectively. """ + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -26,9 +27,7 @@ if key_event.key_number == 2: macropad.keyboard_layout.write("Hello, World!") if key_event.key_number == 3: - macropad.consumer_control.send( - macropad.ConsumerControlCode.VOLUME_DECREMENT - ) + macropad.consumer_control.send(macropad.ConsumerControlCode.VOLUME_DECREMENT) macropad.encoder_switch_debounced.update() diff --git a/examples/macropad_led_animation_example.py b/examples/macropad_led_animation_example.py index bc0c5be..fe7e539 100644 --- a/examples/macropad_led_animation_example.py +++ b/examples/macropad_led_animation_example.py @@ -5,8 +5,10 @@ This simpletest example displays the Blink animation on the MacroPad neopixels """ + from adafruit_led_animation.animation.blink import Blink from adafruit_led_animation.color import BLUE + from adafruit_macropad import MacroPad macropad = MacroPad() diff --git a/examples/macropad_mp3/macropad_mp3.py b/examples/macropad_mp3/macropad_mp3.py index d85ccb6..494d9cc 100644 --- a/examples/macropad_mp3/macropad_mp3.py +++ b/examples/macropad_mp3/macropad_mp3.py @@ -6,7 +6,9 @@ is pressed. All keys light up a color of the rainbow when pressed, but no audio is played for the rest of the keys. """ + from rainbowio import colorwheel + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -20,9 +22,7 @@ if key_event: if key_event.pressed: - macropad.pixels[key_event.key_number] = colorwheel( - int(255 / 12) * key_event.key_number - ) + macropad.pixels[key_event.key_number] = colorwheel(int(255 / 12) * key_event.key_number) if key_event.key_number < len(audio_files): macropad.play_file(audio_files[key_event.key_number]) diff --git a/examples/macropad_rainbow_keys.py b/examples/macropad_rainbow_keys.py index d13c8af..459611e 100644 --- a/examples/macropad_rainbow_keys.py +++ b/examples/macropad_rainbow_keys.py @@ -6,11 +6,13 @@ layout on the built-in display, and animates a rainbow the first time you press a key and turns it off on the next press. """ + import displayio import terminalio -from rainbowio import colorwheel from adafruit_display_text import bitmap_label as label from adafruit_displayio_layout.layouts.grid_layout import GridLayout +from rainbowio import colorwheel + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -43,7 +45,7 @@ key_event = macropad.keys.events.get() if key_event: if key_event.pressed: - labels[key_event.key_number].text = "KEY{}".format(key_event.key_number) + labels[key_event.key_number].text = f"KEY{key_event.key_number}" # Turn the LED on with the first press, and off with the second press. lit_keys[key_event.key_number] = not lit_keys[key_event.key_number] else: diff --git a/examples/macropad_rotation.py b/examples/macropad_rotation.py index 136c677..744b3d9 100644 --- a/examples/macropad_rotation.py +++ b/examples/macropad_rotation.py @@ -6,7 +6,9 @@ Lights up the associated pixel when the key is pressed. Displays the key number pressed and the rotary encoder relative position on the display. """ + from rainbowio import colorwheel + from adafruit_macropad import MacroPad macropad = MacroPad(rotation=90) @@ -17,11 +19,9 @@ key_event = macropad.keys.events.get() if key_event: if key_event.pressed: - text_lines[1].text = "Key {}!".format(key_event.key_number) - macropad.pixels[key_event.key_number] = colorwheel( - int(255 / 12) * key_event.key_number - ) + text_lines[1].text = f"Key {key_event.key_number}!" + macropad.pixels[key_event.key_number] = colorwheel(int(255 / 12) * key_event.key_number) else: macropad.pixels.fill((0, 0, 0)) - text_lines[2].text = "Encoder {}".format(macropad.encoder) + text_lines[2].text = f"Encoder {macropad.encoder}" text_lines.show() diff --git a/examples/macropad_simpletest.py b/examples/macropad_simpletest.py index 64441bc..609b925 100644 --- a/examples/macropad_simpletest.py +++ b/examples/macropad_simpletest.py @@ -5,7 +5,9 @@ Simpletest demo for MacroPad. Prints the key pressed, the relative position of the rotary encoder, and the state of the rotary encoder switch to the serial console. """ + import time + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -13,7 +15,7 @@ while True: key_event = macropad.keys.events.get() if key_event and key_event.pressed: - print("Key pressed: {}".format(key_event.key_number)) - print("Encoder: {}".format(macropad.encoder)) - print("Encoder switch: {}".format(macropad.encoder_switch)) + print(f"Key pressed: {key_event.key_number}") + print(f"Encoder: {macropad.encoder}") + print(f"Encoder switch: {macropad.encoder_switch}") time.sleep(0.4) diff --git a/examples/macropad_simpletest_display.py b/examples/macropad_simpletest_display.py index 65cd83a..faea058 100644 --- a/examples/macropad_simpletest_display.py +++ b/examples/macropad_simpletest_display.py @@ -6,6 +6,7 @@ encoder, and the state of the rotary encoder switch to the built-in display. Note that the key pressed line does not appear until a key is pressed. """ + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -15,7 +16,7 @@ while True: key_event = macropad.keys.events.get() if key_event and key_event.pressed: - text_lines[0].text = "Key {} pressed!".format(key_event.key_number) - text_lines[1].text = "Rotary encoder {}".format(macropad.encoder) - text_lines[2].text = "Encoder switch: {}".format(macropad.encoder_switch) + text_lines[0].text = f"Key {key_event.key_number} pressed!" + text_lines[1].text = f"Rotary encoder {macropad.encoder}" + text_lines[2].text = f"Encoder switch: {macropad.encoder_switch}" text_lines.show() diff --git a/examples/macropad_tone_keypad.py b/examples/macropad_tone_keypad.py index 2c25205..d8046da 100644 --- a/examples/macropad_tone_keypad.py +++ b/examples/macropad_tone_keypad.py @@ -5,7 +5,9 @@ MacroPad tone demo. Plays a different tone for each key pressed and lights up each key a different color while the key is pressed. """ + from rainbowio import colorwheel + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -17,9 +19,7 @@ if key_event: if key_event.pressed: - macropad.pixels[key_event.key_number] = colorwheel( - int(255 / 12) * key_event.key_number - ) + macropad.pixels[key_event.key_number] = colorwheel(int(255 / 12) * key_event.key_number) macropad.start_tone(tones[key_event.key_number]) else: diff --git a/examples/macropad_tone_keypad_extended.py b/examples/macropad_tone_keypad_extended.py index e3d539c..68c0c3a 100755 --- a/examples/macropad_tone_keypad_extended.py +++ b/examples/macropad_tone_keypad_extended.py @@ -9,6 +9,7 @@ """ from rainbowio import colorwheel + from adafruit_macropad import MacroPad macropad = MacroPad() @@ -79,11 +80,9 @@ def rgb_from_int(rgb): playing_index = top_index # There are no keys pressed. - else: - # If a tone was playing, stop it. - if playing_index is not None: - macropad.stop_tone() - playing_index = None + elif playing_index is not None: + macropad.stop_tone() + playing_index = None # If a key was pressed or released, update the pixels for the pressed keys. if update_pixels: diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..d4a4777 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,109 @@ +# 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 + "PLW0603", # global statement +] + +[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