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/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 6d0015a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 9647e71..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 43d1385..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: 20.8b1 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: v2.11.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string,duplicate-code - 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: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index cfd1c41..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. 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= - -# 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,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,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 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# 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=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([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 - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-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 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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 - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-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 - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..255dafd --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-lts-latest + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt diff --git a/README.rst b/README.rst index 8520452..c931674 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/cursorcontrol/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/cursorcontrol/en/latest/ + :target: https://docs.circuitpython.org/projects/cursorcontrol/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_CursorControl/actions :alt: Build Status +.. 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 + Mouse cursor for interaction with CircuitPython UI elements such as `buttons `_. @@ -46,8 +50,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-cursorcontrol Usage Example @@ -58,7 +62,9 @@ See examples in examples/ folder. Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -66,8 +72,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. diff --git a/adafruit_cursorcontrol/__init__.py b/adafruit_cursorcontrol/__init__.py index e69de29..13e6291 100644 --- a/adafruit_cursorcontrol/__init__.py +++ b/adafruit_cursorcontrol/__init__.py @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2019 Brent Rubell for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +`adafruit_cursorcontrol.cursorcontrol_cursormanager` +================================================================================ +Mouse cursor for interaction with CircuitPython UI elements + +* Author(s): Brent Rubell + +""" + +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git" diff --git a/adafruit_cursorcontrol/cursorcontrol.py b/adafruit_cursorcontrol/cursorcontrol.py index 2e6e6a3..d4404b0 100644 --- a/adafruit_cursorcontrol/cursorcontrol.py +++ b/adafruit_cursorcontrol/cursorcontrol.py @@ -20,20 +20,30 @@ https://github.com/adafruit/circuitpython/releases """ + import displayio -__version__ = "0.0.0-auto.0" +try: + from types import TracebackType + from typing import Optional, Type + + from circuitpython_typing.displayio import AnyDisplay +except ImportError: + pass + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git" class Cursor: """Mouse cursor interaction for CircuitPython. - :param ~displayio.Display display: CircuitPython display object. + :param ~AnyDisplay display: CircuitPython display object. :param ~displayio.Group display_group: CircuitPython group object to append the cursor to. + :param ~displayio.Bitmap bmp: CircuitPython bitmap object to use as the cursor + :param bool is_hidden: Cursor is hidden on init. :param int cursor_speed: Speed of the cursor, in pixels. :param int scale: Scale amount for the cursor in both directions. - :param bool is_hidden: Cursor is hidden on init. Example for creating a cursor layer @@ -50,15 +60,14 @@ class Cursor: mouse_cursor = Cursor(display, display_group=splash) """ - # pylint: disable=too-many-arguments,line-too-long def __init__( self, - display=None, - display_group=None, - bmp=None, - is_hidden=False, - cursor_speed=5, - scale=1, + display: Optional[AnyDisplay] = None, + display_group: Optional[displayio.Group] = None, + bmp: Optional[displayio.Bitmap] = None, + is_hidden: bool = False, + cursor_speed: int = 5, + scale: int = 1, ): self._display = display self._scale = scale @@ -73,21 +82,24 @@ def __init__( self._cursor_bitmap = bmp self.generate_cursor(self._cursor_bitmap) - # pylint: enable=too-many-arguments,line-too-long - - def __enter__(self): + def __enter__(self) -> "Cursor": return self - def __exit__(self, exception_type, exception_value, traceback): + def __exit__( + self, + exception_type: Optional[Type[type]], + exception_value: Optional[BaseException], + traceback: Optional[TracebackType], + ) -> None: self.deinit() - def deinit(self): + def deinit(self) -> None: """deinitializes the cursor object.""" self._is_deinited() self._scale = None self._display_grp.remove(self._cursor_grp) - def _is_deinited(self): + def _is_deinited(self) -> None: """checks cursor deinitialization""" if self._scale is None: raise ValueError( @@ -96,12 +108,12 @@ def _is_deinited(self): ) @property - def scale(self): + def scale(self) -> int: """Returns the cursor's scale amount as an integer.""" return self._scale @scale.setter - def scale(self, scale_value): + def scale(self, scale_value: int) -> None: """Scales the cursor by scale_value in both directions. :param int scale_value: Amount to scale the cursor by. """ @@ -111,12 +123,12 @@ def scale(self, scale_value): self._cursor_grp.scale = scale_value @property - def speed(self): + def speed(self) -> int: """Returns the cursor's speed, in pixels.""" return self._speed @speed.setter - def speed(self, speed): + def speed(self, speed: int) -> None: """Sets the speed of the cursor. :param int speed: Cursor movement speed, in pixels. """ @@ -125,12 +137,12 @@ def speed(self, speed): self._speed = speed @property - def x(self): + def x(self) -> int: """Returns the cursor's x-coordinate.""" return self._cursor_grp.x @x.setter - def x(self, x_val): + def x(self, x_val: int) -> None: """Sets the x-value of the cursor. :param int x_val: cursor x-position, in pixels. """ @@ -143,12 +155,12 @@ def x(self, x_val): self._cursor_grp.x = x_val @property - def y(self): + def y(self) -> int: """Returns the cursor's y-coordinate.""" return self._cursor_grp.y @y.setter - def y(self, y_val): + def y(self, y_val: int) -> None: """Sets the y-value of the cursor. :param int y_val: cursor y-position, in pixels. """ @@ -161,12 +173,12 @@ def y(self, y_val): self._cursor_grp.y = y_val @property - def hidden(self): + def hidden(self) -> bool: """Returns True if the cursor is hidden or visible on the display.""" return self._is_hidden @hidden.setter - def hidden(self, is_hidden): + def hidden(self, is_hidden: bool) -> None: self._is_deinited() if is_hidden: self._is_hidden = True @@ -175,16 +187,16 @@ def hidden(self, is_hidden): self._is_hidden = False self._display_grp.append(self._cursor_grp) - def hide(self): + def hide(self) -> None: """Hide the cursor.""" self.hidden = True - def show(self): + def show(self) -> None: """Show the cursor.""" self.hidden = False # pylint:disable=no-self-use - def _default_cursor_bitmap(self): + def _default_cursor_bitmap(self) -> displayio.Bitmap: bmp = displayio.Bitmap(20, 20, 3) # left edge, outline for i in range(0, bmp.height): @@ -209,23 +221,26 @@ def _default_cursor_bitmap(self): # pylint:enable=no-self-use @property - def cursor_bitmap(self): + def cursor_bitmap(self) -> displayio.Bitmap: """Return the cursor bitmap.""" return self._cursor_bitmap @cursor_bitmap.setter - def cursor_bitmap(self, bmp): + def cursor_bitmap(self, bmp: displayio.Bitmap) -> None: """Set a new cursor bitmap. - :param bmp: A Bitmap to use for the cursor + :param ~displayio.Bitmap bmp: A Bitmap to use for the cursor """ self._cursor_bitmap = bmp self._cursor_grp.remove(self._cur_sprite) self._cur_sprite = displayio.TileGrid(bmp, pixel_shader=self._cur_palette) self._cursor_grp.append(self._cur_sprite) - def generate_cursor(self, bmp): - """Generates a cursor icon""" + def generate_cursor(self, bmp: displayio.Bitmap) -> None: + """Generates a cursor icon + + :param ~displayio.Bitmap bmp: A Bitmap to use for the cursor + """ self._is_deinited() self._cursor_grp = displayio.Group(scale=self._scale) self._cur_palette = displayio.Palette(3) diff --git a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py old mode 100755 new mode 100644 index 1b4cbcf..79acfb2 --- a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py @@ -8,47 +8,77 @@ Simple interaction user interface interaction for Adafruit_CursorControl. * Author(s): Brent Rubell """ -import board -import digitalio -from micropython import const + import analogio -from gamepadshift import GamePadShift +import board from adafruit_debouncer import Debouncer +from keypad import Event, ShiftRegisterKeys +from micropython import const + +try: + from types import TracebackType + from typing import Optional, Type + + from adafruit_cursorcontrol.cursorcontrol import Cursor +except ImportError: + pass + +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git" # PyBadge -PYBADGE_BUTTON_LEFT = const(128) -PYBADGE_BUTTON_UP = const(64) -PYBADGE_BUTTON_DOWN = const(32) -PYBADGE_BUTTON_RIGHT = const(16) +PYBADGE_BUTTON_LEFT = const(7) +PYBADGE_BUTTON_UP = const(6) +PYBADGE_BUTTON_DOWN = const(5) +PYBADGE_BUTTON_RIGHT = const(4) # PyBadge & PyGamer -PYBADGE_BUTTON_A = const(2) +PYBADGE_BUTTON_SELECT = const(3) +PYBADGE_BUTTON_START = const(2) +PYBADGE_BUTTON_A = const(1) +PYBADGE_BUTTON_B = const(0) class CursorManager: """Simple interaction user interface interaction for Adafruit_CursorControl. - :param adafruit_cursorcontrol cursor: The cursor object we are using. + :param Cursor cursor: The cursor object we are using. + :param ShiftRegisterKeys shift_register_keys: Optional initialized ShiftRegisterKeys object + to use instead of having CursorManager initialize and control it. """ - def __init__(self, cursor): + def __init__( + self, cursor: Cursor, shift_register_keys: Optional[ShiftRegisterKeys] = None + ) -> None: self._cursor = cursor self._is_clicked = False + self._is_alt_clicked = False + self._is_select_clicked = False + self._is_start_clicked = False + self._pad_states = 0 + self._event = Event() + self._pad = shift_register_keys self._init_hardware() - def __enter__(self): + def __enter__(self) -> "CursorManager": return self - def __exit__(self, exception_type, exception_value, traceback): + def __exit__( + self, + exception_type: Optional[Type[type]], + exception_value: Optional[BaseException], + traceback: Optional[TracebackType], + ) -> None: self.deinit() - def deinit(self): + def deinit(self) -> None: """Deinitializes a CursorManager object.""" self._is_deinited() self._pad.deinit() self._cursor.deinit() self._cursor = None + self._event = None - def _is_deinited(self): + def _is_deinited(self) -> None: """Checks if CursorManager object has been deinitd.""" if self._cursor is None: raise ValueError( @@ -56,7 +86,7 @@ def _is_deinited(self): "be used. Create a new CursorManager object." ) - def _init_hardware(self): + def _init_hardware(self) -> None: """Initializes PyBadge or PyGamer hardware.""" if hasattr(board, "BUTTON_CLOCK") and not hasattr(board, "JOYSTICK_X"): self._pad_btns = { @@ -65,77 +95,129 @@ def _init_hardware(self): "btn_up": PYBADGE_BUTTON_UP, "btn_down": PYBADGE_BUTTON_DOWN, "btn_a": PYBADGE_BUTTON_A, + "btn_b": PYBADGE_BUTTON_B, + "btn_select": PYBADGE_BUTTON_SELECT, + "btn_start": PYBADGE_BUTTON_START, } + self._pad_states = 0 elif hasattr(board, "JOYSTICK_X"): self._joystick_x = analogio.AnalogIn(board.JOYSTICK_X) self._joystick_y = analogio.AnalogIn(board.JOYSTICK_Y) - self._pad_btns = {"btn_a": PYBADGE_BUTTON_A} + self._pad_btns = { + "btn_a": PYBADGE_BUTTON_A, + "btn_b": PYBADGE_BUTTON_B, + "btn_select": PYBADGE_BUTTON_SELECT, + "btn_start": PYBADGE_BUTTON_START, + } # Sample the center points of the joystick self._center_x = self._joystick_x.value self._center_y = self._joystick_y.value else: - raise AttributeError( - "Board must have a D-Pad or Joystick for use with CursorManager!" + raise AttributeError("Board must have a D-Pad or Joystick for use with CursorManager!") + if self._pad is None: + self._pad = ShiftRegisterKeys( + clock=board.BUTTON_CLOCK, + data=board.BUTTON_OUT, + latch=board.BUTTON_LATCH, + key_count=8, + value_when_pressed=True, ) - self._pad = GamePadShift( - digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH), - ) @property - def is_clicked(self): - """Returns True if the cursor button was pressed + def is_clicked(self) -> bool: + """Returns True if the cursor A button was pressed during previous call to update() """ return self._is_clicked - def update(self): + @property + def is_alt_clicked(self) -> bool: + """Returns True if the cursor B button was pressed + during previous call to update() + """ + return self._is_alt_clicked + + @property + def is_select_clicked(self) -> bool: + """Returns True if the Select button was pressed + during previous call to update() + """ + return self._is_select_clicked + + @property + def is_start_clicked(self) -> bool: + """Returns True if the Start button was pressed + during previous call to update() + """ + return self._is_start_clicked + + def update(self) -> None: """Updates the cursor object.""" - pressed = self._pad.get_pressed() - self._check_cursor_movement(pressed) + if self._pad.events.get_into(self._event): + self._store_button_states() + self._check_cursor_movement() if self._is_clicked: self._is_clicked = False - elif pressed & self._pad_btns["btn_a"]: + elif self._pad_states & (1 << self._pad_btns["btn_a"]): self._is_clicked = True - def _read_joystick_x(self, samples=3): + if self._is_alt_clicked: + self._is_alt_clicked = False + elif self._pad_states & (1 << self._pad_btns["btn_b"]): + self._is_alt_clicked = True + + if self._is_select_clicked: + self._is_select_clicked = False + elif self._pad_states & (1 << self._pad_btns["btn_select"]): + self._is_select_clicked = True + + if self._is_start_clicked: + self._is_start_clicked = False + elif self._pad_states & (1 << self._pad_btns["btn_start"]): + self._is_start_clicked = True + + def _read_joystick_x(self, samples: int = 3) -> float: """Read the X analog joystick on the PyGamer. :param int samples: How many samples to read and average. """ reading = 0 - # pylint: disable=unused-variable if hasattr(board, "JOYSTICK_X"): - for sample in range(0, samples): + for _ in range(0, samples): reading += self._joystick_x.value reading /= samples return reading - def _read_joystick_y(self, samples=3): + def _read_joystick_y(self, samples: int = 3) -> float: """Read the Y analog joystick on the PyGamer. :param int samples: How many samples to read and average. """ reading = 0 - # pylint: disable=unused-variable if hasattr(board, "JOYSTICK_Y"): - for sample in range(0, samples): + for _ in range(0, samples): reading += self._joystick_y.value reading /= samples return reading - def _check_cursor_movement(self, pressed=None): - """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. - :param int pressed: 8-bit number with bits that correspond to buttons - which have been pressed down since the last call to get_pressed(). + def _store_button_states(self) -> None: + """Stores the state of the PyBadge's D-Pad or the PyGamer's Joystick + into a byte """ + bit_index = self._event.key_number + current_state = (self._pad_states >> bit_index) & 1 + if current_state != self._event.pressed: + self._pad_states = (1 << bit_index) ^ self._pad_states + + def _check_cursor_movement(self) -> None: + """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement.""" if hasattr(board, "BUTTON_CLOCK") and not hasattr(board, "JOYSTICK_X"): - if pressed & self._pad_btns["btn_right"]: + if self._pad_states & (1 << self._pad_btns["btn_right"]): self._cursor.x += self._cursor.speed - elif pressed & self._pad_btns["btn_left"]: + elif self._pad_states & (1 << self._pad_btns["btn_left"]): self._cursor.x -= self._cursor.speed - if pressed & self._pad_btns["btn_up"]: + + if self._pad_states & (1 << self._pad_btns["btn_up"]): self._cursor.y -= self._cursor.speed - elif pressed & self._pad_btns["btn_down"]: + elif self._pad_states & (1 << self._pad_btns["btn_down"]): self._cursor.y += self._cursor.speed elif hasattr(board, "JOYSTICK_X"): joy_x = self._read_joystick_x() @@ -149,51 +231,107 @@ def _check_cursor_movement(self, pressed=None): elif joy_y < self._center_y - 1000: self._cursor.y -= self._cursor.speed else: - raise AttributeError( - "Board must have a D-Pad or Joystick for use with CursorManager!" - ) + raise AttributeError("Board must have a D-Pad or Joystick for use with CursorManager!") class DebouncedCursorManager(CursorManager): - """Simple interaction user interface interaction for Adafruit_CursorControl. - This subclass provide a debounced version on the A button and provides queries for when - the button is just pressed, and just released, as well it's current state. "Just" in this - context means "since the previous call to update." + """Simple user interface interaction for Adafruit_CursorControl. + This subclass provide a debounced version on the A, B, Start or Select buttons + and provides queries for when the buttons are just pressed, and just released, + as well their current state. "Just" in this context means "since the previous call to update." - :param adafruit_cursorcontrol cursor: The cursor object we are using. + :param Cursor cursor: The cursor object we are using. """ - def __init__(self, cursor, debounce_interval=0.01): + def __init__(self, cursor: Cursor, debounce_interval: float = 0.01) -> None: CursorManager.__init__(self, cursor) - self._pressed = 0 - self._debouncer = Debouncer( - lambda: bool(self._pressed & self._pad_btns["btn_a"]), - interval=debounce_interval, - ) + self._debouncers = {} + for btn in self._pad_btns: + self._debouncers[btn] = Debouncer( + lambda btn=btn: bool(self._pad_states & (1 << self._pad_btns[btn])), + interval=debounce_interval, + ) + + @property + def is_clicked(self) -> bool: + """Returns True if the cursor A button was pressed + during previous call to update() + """ + return self._debouncers["btn_a"].rose + + @property + def is_alt_clicked(self) -> bool: + """Returns True if the cursor B button was pressed + during previous call to update() + """ + return self._debouncers["btn_b"].rose + + @property + def is_select_clicked(self) -> bool: + """Returns True if the Select button was pressed + during previous call to update() + """ + return self._debouncers["btn_select"].rose + + @property + def is_start_clicked(self) -> bool: + """Returns True if the Start button was pressed + during previous call to update() + """ + return self._debouncers["btn_start"].rose @property - def is_clicked(self): - """Returns True if the cursor button was pressed + def released(self) -> bool: + """Returns True if the cursor A button was released during previous call to update() """ - return self._debouncer.rose + return self._debouncers["btn_a"].fell - pressed = is_clicked + @property + def alt_released(self) -> bool: + """Returns True if the cursor B button was released + during previous call to update() + """ + return self._debouncers["btn_b"].fell @property - def released(self): - """Returns True if the cursor button was released + def start_released(self) -> bool: + """Returns True if the cursor Start button was released during previous call to update() """ - return self._debouncer.fell + return self._debouncers["btn_start"].fell + + @property + def select_released(self) -> bool: + """Returns True if the cursor Select button was released + during previous call to update() + """ + return self._debouncers["btn_select"].fell + + @property + def held(self) -> bool: + """Returns True if the cursor A button is currently being held""" + return self._debouncers["btn_a"].value + + @property + def alt_held(self) -> bool: + """Returns True if the cursor B button is currently being held""" + return self._debouncers["btn_b"].value + + @property + def start_held(self) -> bool: + """Returns True if the cursor Start button is currently being held""" + return self._debouncers["btn_start"].value @property - def held(self): - """Returns True if the cursor button is currently being held""" - return self._debouncer.value + def select_held(self) -> bool: + """Returns True if the cursor Select is currently being held""" + return self._debouncers["btn_select"].value - def update(self): + def update(self) -> None: """Updates the cursor object.""" - self._pressed = self._pad.get_pressed() - self._check_cursor_movement(self._pressed) - self._debouncer.update() + if self._pad.events.get_into(self._event): + self._store_button_states() + self._check_cursor_movement() + for debouncer in self._debouncers.values(): + debouncer.update() diff --git a/docs/api.rst b/docs/api.rst index 5981c96..36ad4d7 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,3 +1,6 @@ +API Reference +############# + .. automodule:: adafruit_cursorcontrol.cursorcontrol :members: diff --git a/docs/conf.py b/docs/conf.py index 46dc049..1303dba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys @@ -16,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -25,12 +25,12 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["displayio", "gamepadshift"] +autodoc_mock_imports = ["displayio"] intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -43,7 +43,12 @@ # General information about the project. project = "Adafruit CursorControl Library" -copyright = "2019 Brent Rubell" +creation_year = "2019" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Brent Rubell" author = "Brent Rubell" # The version info for the project you're documenting, acts as replacement for @@ -60,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -92,19 +97,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index fd29c85..45d268e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,8 +29,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/cursorcontrol_buttons_debounced.py b/examples/cursorcontrol_buttons_debounced.py new file mode 100644 index 0000000..b718c3a --- /dev/null +++ b/examples/cursorcontrol_buttons_debounced.py @@ -0,0 +1,159 @@ +# SPDX-FileCopyrightText: 2022 flom84 for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time + +import board +import displayio +import terminalio +from adafruit_button import Button + +from adafruit_cursorcontrol.cursorcontrol import Cursor +from adafruit_cursorcontrol.cursorcontrol_cursormanager import DebouncedCursorManager + +SELECT_BUTTON_X = 0 +SELECT_BUTTON_Y = 103 +SELECT_BUTTON_WIDTH = 60 +SELECT_BUTTON_HEIGHT = 25 +SELECT_BUTTON_STYLE = Button.ROUNDRECT +SELECT_BUTTON_OUTLINE_COLOR = 0xFFFFFF +SELECT_BUTTON_LABEL = "Select" +SELECT_BUTTON_LABEL_COLOR = 0xFFFFFF + +START_BUTTON_X = 100 +START_BUTTON_Y = 103 +START_BUTTON_WIDTH = 60 +START_BUTTON_HEIGHT = 25 +START_BUTTON_STYLE = Button.ROUNDRECT +START_BUTTON_OUTLINE_COLOR = 0xFFFFFF +START_BUTTON_LABEL = "Start" +START_BUTTON_LABEL_COLOR = 0xFFFFFF + +A_BUTTON_X = 120 +A_BUTTON_Y = 20 +A_BUTTON_WIDTH = 30 +A_BUTTON_HEIGHT = 30 +A_BUTTON_STYLE = Button.ROUNDRECT +A_BUTTON_OUTLINE_COLOR = 0xFFFFFF +A_BUTTON_LABEL = "A" +A_BUTTON_LABEL_COLOR = 0xFFFFFF + +B_BUTTON_X = 80 +B_BUTTON_Y = 30 +B_BUTTON_WIDTH = 30 +B_BUTTON_HEIGHT = 30 +B_BUTTON_STYLE = Button.ROUNDRECT +B_BUTTON_OUTLINE_COLOR = 0xFFFFFF +B_BUTTON_LABEL = "B" +B_BUTTON_LABEL_COLOR = 0xFFFFFF + +BUTTON_FILL_PURPLE = 0xB400FF +BUTTON_FILL_BLACK = 0x000000 + +start_button = Button( + x=START_BUTTON_X, + y=START_BUTTON_Y, + width=START_BUTTON_WIDTH, + height=START_BUTTON_HEIGHT, + style=START_BUTTON_STYLE, + fill_color=BUTTON_FILL_BLACK, + outline_color=START_BUTTON_OUTLINE_COLOR, + label=START_BUTTON_LABEL, + label_font=terminalio.FONT, + label_color=START_BUTTON_LABEL_COLOR, +) + +select_button = Button( + x=SELECT_BUTTON_X, + y=SELECT_BUTTON_Y, + width=SELECT_BUTTON_WIDTH, + height=SELECT_BUTTON_HEIGHT, + style=SELECT_BUTTON_STYLE, + fill_color=BUTTON_FILL_BLACK, + outline_color=SELECT_BUTTON_OUTLINE_COLOR, + label=SELECT_BUTTON_LABEL, + label_font=terminalio.FONT, + label_color=SELECT_BUTTON_LABEL_COLOR, +) + +a_button = Button( + x=A_BUTTON_X, + y=A_BUTTON_Y, + width=A_BUTTON_WIDTH, + height=A_BUTTON_HEIGHT, + style=A_BUTTON_STYLE, + fill_color=BUTTON_FILL_BLACK, + outline_color=A_BUTTON_OUTLINE_COLOR, + label=A_BUTTON_LABEL, + label_font=terminalio.FONT, + label_color=A_BUTTON_LABEL_COLOR, +) + +b_button = Button( + x=B_BUTTON_X, + y=B_BUTTON_Y, + width=B_BUTTON_WIDTH, + height=B_BUTTON_HEIGHT, + style=B_BUTTON_STYLE, + fill_color=BUTTON_FILL_BLACK, + outline_color=B_BUTTON_OUTLINE_COLOR, + label=B_BUTTON_LABEL, + label_font=terminalio.FONT, + label_color=B_BUTTON_LABEL_COLOR, +) + +# Create the display +display = board.DISPLAY + +# Create the display context +splash = displayio.Group() + +# initialize the mouse cursor object +mouse_cursor = Cursor(display, display_group=splash) + +# initialize the debounced cursor manager +debounced_cursor = DebouncedCursorManager(mouse_cursor) + +# create displayio group +splash.append(start_button) +splash.append(select_button) +splash.append(a_button) +splash.append(b_button) +display.root_group = splash + +while True: + debounced_cursor.update() + + if debounced_cursor.is_clicked: + a_button.fill_color = BUTTON_FILL_PURPLE + print("A pressed: " + str(debounced_cursor.held)) + + if debounced_cursor.released: + a_button.fill_color = BUTTON_FILL_BLACK + print("A pressed: " + str(debounced_cursor.held)) + + if debounced_cursor.is_alt_clicked: + b_button.fill_color = BUTTON_FILL_PURPLE + print("B pressed: " + str(debounced_cursor.alt_held)) + + if debounced_cursor.alt_released: + b_button.fill_color = BUTTON_FILL_BLACK + print("B pressed: " + str(debounced_cursor.alt_held)) + + if debounced_cursor.is_start_clicked: + start_button.fill_color = BUTTON_FILL_PURPLE + print("Start pressed: " + str(debounced_cursor.start_held)) + + if debounced_cursor.start_released: + start_button.fill_color = BUTTON_FILL_BLACK + print("Start pressed: " + str(debounced_cursor.start_held)) + + if debounced_cursor.is_select_clicked: + select_button.fill_color = BUTTON_FILL_PURPLE + print("Select pressed: " + str(debounced_cursor.select_held)) + + if debounced_cursor.select_released: + select_button.fill_color = BUTTON_FILL_BLACK + print("Select pressed: " + str(debounced_cursor.select_held)) + + time.sleep(0.01) diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py index 57520c0..53dc566 100644 --- a/examples/cursorcontrol_buttons_text.py +++ b/examples/cursorcontrol_buttons_text.py @@ -2,11 +2,13 @@ # SPDX-License-Identifier: MIT import time + import board import displayio +import terminalio from adafruit_button import Button from adafruit_display_text import label -import terminalio + from adafruit_cursorcontrol.cursorcontrol import Cursor from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager @@ -115,7 +117,7 @@ cursor = CursorManager(mouse_cursor) # show displayio group -display.show(splash) +display.root_group = splash prev_btn = None while True: @@ -136,6 +138,6 @@ prev_btn = b elif prev_btn is not None: prev_btn.selected = False - text_speed.text = "Speed: {0}px".format(mouse_cursor.speed) - text_scale.text = "Scale: {0}px".format(mouse_cursor.scale) + text_speed.text = f"Speed: {mouse_cursor.speed}px" + text_scale.text = f"Scale: {mouse_cursor.scale}px" time.sleep(0.1) diff --git a/examples/cursorcontrol_custom_cursor.py b/examples/cursorcontrol_custom_cursor.py index 83091e2..6386e3d 100644 --- a/examples/cursorcontrol_custom_cursor.py +++ b/examples/cursorcontrol_custom_cursor.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board import displayio + from adafruit_cursorcontrol.cursorcontrol import Cursor from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager @@ -28,7 +30,7 @@ cursor = CursorManager(mouse_cursor) # show displayio group -display.show(splash) +display.root_group = splash while True: cursor.update() diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py index aa50208..953f221 100644 --- a/examples/cursorcontrol_simpletest.py +++ b/examples/cursorcontrol_simpletest.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board import displayio + from adafruit_cursorcontrol.cursorcontrol import Cursor from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager @@ -20,7 +22,7 @@ cursor = CursorManager(mouse_cursor) # show displayio group -display.show(splash) +display.root_group = splash while True: cursor.update() diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a7bb191 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-cursorcontrol" +description = "Mouse cursor for interaction with CircuitPython UI elements." +version = "0.0.0+auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "cursorcontrol", + "mouse,", + "cursor,", + "ui", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_cursorcontrol"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 40ae99f..81629c3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,8 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka +Adafruit-Blinka-Displayio adafruit-circuitpython-debouncer +adafruit-circuitpython-typing diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..73e9efc --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "PLC2701", # private import +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 96da48e..0000000 --- a/setup.py +++ /dev/null @@ -1,57 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-cursorcontrol", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Mouse cursor for interaction with CircuitPython UI elements.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_CursorControl", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-debouncer"], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython cursorcontrol mouse, cursor, ui", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_cursorcontrol"], -)