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 5e66017..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +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 -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense +# 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 1b9fadc..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 - 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 5efe7da..0000000 --- a/.pylintrc +++ /dev/null @@ -1,440 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -# 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 - -# 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 24a1921..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,11 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -# 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 ceca24a..eecf292 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-logging/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/logging/en/latest/ + :target: https://docs.circuitpython.org/projects/logging/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_Logger :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 + Logging module for CircuitPython @@ -43,7 +47,9 @@ Usage Example 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 ============ @@ -51,8 +57,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_logging.py b/adafruit_logging.py new file mode 100644 index 0000000..0b135aa --- /dev/null +++ b/adafruit_logging.py @@ -0,0 +1,675 @@ +# SPDX-FileCopyrightText: 2019 Dave Astels for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Pat Satyshur +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_logging` +================== + +Logging module for CircuitPython + + +* Author(s): Dave Astels, Alec Delaney + +Implementation Notes +-------------------- + +**Hardware:** + + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +.. note:: + + This module has a few key differences compared to its CPython counterpart, notably + that loggers do not form a hierarchy that allows record propagation. + Additionally, the default formatting for handlers is different. + +Attributes +---------- + LEVELS: list + A list of tuples representing the valid logging levels used by + this module. Each tuple contains exactly two elements: one int and one + str. The int in each tuple represents the relative severity of that + level (00 to 50). The str in each tuple is the string representation of + that logging level ("NOTSET" to "CRITICAL"; see below). + NOTSET: int + The NOTSET logging level can be used to indicate that a `Logger` should + process any logging messages, regardless of how severe those messages are. + DEBUG: int + The DEBUG logging level, which is the lowest (least severe) real level. + INFO: int + The INFO logging level for informative/informational messages. + WARNING: int + The WARNING logging level, which is the default logging level, for warnings + that should be addressed/fixed. + ERROR: int + The ERROR logging level for Python exceptions that occur during runtime. + CRITICAL: int + The CRITICAL logging level, which is the highest (most severe) level for + unrecoverable errors that have caused the code to halt and exit. + +""" + +import os +import sys +import time +from collections import namedtuple + +try: + from typing import Dict, Hashable, Optional + + from typing_extensions import Protocol + + class WriteableStream(Protocol): + """Any stream that can ``write`` strings""" + + def write(self, buf: str) -> int: + """Write to the stream + + :param str buf: The string data to write to the stream + """ + +except ImportError: + pass + +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" + +__all__ = [ + "LEVELS", + "NOTSET", + "DEBUG", + "INFO", + "WARNING", + "ERROR", + "CRITICAL", + "Handler", + "StreamHandler", + "logger_cache", + "getLogger", + "Logger", + "NullHandler", + "FileHandler", + "LogRecord", +] + +# The level module-global variables get created when loaded + +LEVELS = [ + (00, "NOTSET"), + (10, "DEBUG"), + (20, "INFO"), + (30, "WARNING"), + (40, "ERROR"), + (50, "CRITICAL"), +] + +for __value, __name in LEVELS: + globals()[__name] = __value + + +def _level_for(value: int) -> str: + """Convert a numeric level to the most appropriate name. + + :param int value: a numeric level + """ + for i, level in enumerate(LEVELS): + if value == level[0]: + return level[1] + if value < level[0]: + return LEVELS[i - 1][1] + return LEVELS[0][1] + + +LogRecord = namedtuple("_LogRecord", ("name", "levelno", "levelname", "msg", "created", "args")) +"""An object used to hold the contents of a log record. The following attributes can +be retrieved from it: + +- ``name`` - The name of the logger +- ``levelno`` - The log level number +- ``levelname`` - The log level name +- ``msg`` - The log message +- ``created`` - When the log record was created +- ``args`` - The additional positional arguments provided +""" + + +def _logRecordFactory(name, level, msg, args): + return LogRecord(name, level, _level_for(level), msg, time.monotonic(), args) + + +class Formatter: + """ + Responsible for converting a LogRecord to an output string to be + interpreted by a human or external system. + + Only implements a sub-set of CPython logging.Formatter behavior, + but retains all the same arguments in order to match the API. + + The only init arguments currently supported are: fmt, defaults and + style. All others are currently ignored + + The only two styles currently supported are '%' and '{'. The default + style is '{' + """ + + def __init__( + self, + fmt: Optional[str] = None, + datefmt: Optional[str] = None, + style: str = "%", + validate: bool = True, + defaults: Dict = None, + ): + self.fmt = fmt + self.datefmt = datefmt + self.style = style + if self.style not in {"{", "%"}: + raise ValueError("Only '%' and '{' formatting style are supported at this time.") + + self.validate = validate + self.defaults = defaults + + def format(self, record: LogRecord) -> str: + """ + Format the given LogRecord into an output string + """ + if self.fmt is None: + return record.msg + + vals = { + "name": record.name, + "levelno": record.levelno, + "levelname": record.levelname, + "message": record.msg, + "created": record.created, + "args": record.args, + } + if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt: + now = time.localtime() + vals["asctime"] = ( + f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}" # noqa: E501 + ) + + if self.defaults: + for key, val in self.defaults.items(): + if key not in vals: + vals[key] = val + + if self.style not in {"{", "%"}: + raise ValueError("Only '%' and '{' formatting style are supported at this time.") + + if self.style == "%": + return self.fmt % vals + + return self.fmt.format(**vals) + + +class Handler: + """Base logging message handler.""" + + def __init__(self, level: int = NOTSET) -> None: + """Create Handler instance""" + self.level = level + self.formatter = None + + def setLevel(self, level: int) -> None: + """ + Set the logging level of this handler. + """ + self.level = level + + def format(self, record: LogRecord) -> str: + """Generate a timestamped message. + + :param record: The record (message object) to be logged + """ + if self.formatter: + return self.formatter.format(record) + return f"{record.created:<0.3f}: {record.levelname} - {record.msg}" + + def emit(self, record: LogRecord) -> None: + """Send a message where it should go. + Placeholder for subclass implementations. + + :param record: The record (message object) to be logged + """ + + raise NotImplementedError() + + def flush(self) -> None: + """Placeholder for flush function in subclasses.""" + + def setFormatter(self, formatter: Formatter) -> None: + """ + Set the Formatter to be used by this Handler. + """ + self.formatter = formatter + + +class StreamHandler(Handler): + """Send logging messages to a stream, `sys.stderr` (typically + the serial console) by default. + + :param stream: The stream to log to, default is `sys.stderr`; + can accept any stream that implements ``stream.write()`` + with string inputs + """ + + terminator = "\n" + + def __init__(self, stream: Optional[WriteableStream] = None) -> None: + super().__init__() + if stream is None: + stream = sys.stderr + self.stream = stream + """The stream to log to""" + + def format(self, record: LogRecord) -> str: + """Generate a string to log + + :param record: The record (message object) to be logged + """ + text = super().format(record) + lines = text.splitlines() + return self.terminator.join(lines) + + def emit(self, record: LogRecord) -> None: + """Send a message to the console. + + :param record: The record (message object) to be logged + """ + self.stream.write(self.format(record) + self.terminator) + + def flush(self) -> None: + """flush the stream. You might need to call this if your messages + are not appearing in the log file. + """ + self.stream.flush() + + +class FileHandler(StreamHandler): + """File handler for working with log files off of the microcontroller (like + an SD card) + + :param str filename: The filename of the log file + :param str mode: Whether to write ('w') or append ('a'); default is to append + """ + + terminator = "\r\n" + + def __init__(self, filename: str, mode: str = "a") -> None: + if mode == "r": + raise ValueError("Can't write to a read only file") + super().__init__(open(filename, mode=mode)) + + def close(self) -> None: + """Closes the file""" + self.stream.flush() + self.stream.close() + + def emit(self, record: LogRecord) -> None: + """Generate the message and write it to the file. + + :param record: The record (message object) to be logged + """ + super().emit(record) + self.stream.flush() + + +class RotatingFileHandler(FileHandler): + """File handler for writing log files to flash memory or external memory such as an SD card. + This handler implements a very simple log rotating system similar to the python function of the + same name (https://docs.python.org/3/library/logging.handlers.html#rotatingfilehandler) + + If maxBytes is set, the handler will check to see if the log file is larger than the given + limit. If the log file is larger than the limit, it is renamed and a new file is started. + The old log file will be renamed with a numerical appendix '.1', '.2', etc... The variable + backupCount controls how many old log files to keep. For example, if the filename is 'log.txt' + and backupCount is 5, you will end up with six log files: 'log.txt', 'log.txt.1', 'log.txt.3', + up to 'log.txt.5' Therefore, the maximum amount of disk space the logs can use is + maxBytes*(backupCount+1). + + If either maxBytes or backupCount is not set, or set to zero, the log rotation is disabled. + This will result in a single log file with a name `filename` that will grow without bound. + + :param str filename: The filename of the log file + :param str mode: Whether to write ('w') or append ('a'); default is to append + :param int maxBytes: The max allowable size of the log file in bytes. + :param int backupCount: The number of old log files to keep. + """ + + def __init__( + self, + filename: str, + mode: str = "a", + maxBytes: int = 0, + backupCount: int = 0, + ) -> None: + if maxBytes < 0: + raise ValueError("maxBytes must be a positive number") + if backupCount < 0: + raise ValueError("backupCount must be a positive number") + + self._LogFileName = filename + self._WriteMode = mode + self._maxBytes = maxBytes + self._backupCount = backupCount + + # Open the file and save the handle to self.stream + super().__init__(self._LogFileName, mode=self._WriteMode) + + def doRollover(self) -> None: + """Roll over the log files. This should not need to be called directly""" + # At this point, we have already determined that we need to roll the log files. + # Close the log file. Probably needed if we want to delete/rename files. + self.close() + + for i in range(self._backupCount, 0, -1): + CurrentFileName = self._LogFileName + "." + str(i) + CurrentFileNamePlus = self._LogFileName + "." + str(i + 1) + try: + if i == self._backupCount: + # This is the oldest log file. Delete this one. + os.remove(CurrentFileName) + else: + # Rename the current file to the next number in the sequence. + os.rename(CurrentFileName, CurrentFileNamePlus) + except OSError as e: + if e.args[0] == 2: + # File does not exsist. This is okay. + pass + else: + raise e + + # Rename the current log to the first backup + os.rename(self._LogFileName, CurrentFileName) + + # Reopen the file. + self.stream = open(self._LogFileName, mode=self._WriteMode) + + def GetLogSize(self) -> int: + """Check the size of the log file.""" + try: + self.stream.flush() # We need to call this or the file size is always zero. + LogFileSize = os.stat(self._LogFileName)[6] + except OSError as e: + if e.args[0] == 2: + # Log file does not exsist. This is okay. + LogFileSize = None + else: + raise e + return LogFileSize + + def emit(self, record: LogRecord) -> None: + """Generate the message and write it to the file. + + :param record: The record (message object) to be logged + """ + if ( + (self.GetLogSize() >= self._maxBytes) + and (self._maxBytes > 0) + and (self._backupCount > 0) + ): + self.doRollover() + super().emit(record) + + +class NullHandler(Handler): + """Provide an empty log handler. + + This can be used in place of a real log handler to more efficiently disable + logging. + """ + + def emit(self, record: LogRecord) -> None: + """Dummy implementation""" + + +logger_cache = {} +_default_handler = StreamHandler() + + +def _addLogger(logger_name: Hashable) -> None: + """Adds the logger if it doesn't already exist""" + if logger_name not in logger_cache: + new_logger = Logger(logger_name) + logger_cache[logger_name] = new_logger + + +def getLogger(logger_name: Hashable = "") -> "Logger": + """Create or retrieve a logger by name; only retrieves loggers + made using this function; if a Logger with this name does not + exist it is created + + :param Hashable logger_name: The name of the `Logger` to create/retrieve, this + is typically a ``str``. If none is provided, the single root logger will + be created/retrieved. Note that unlike CPython, a blank string will also + access the root logger. + """ + _addLogger(logger_name) + return logger_cache[logger_name] + + +class Logger: + """The actual logger that will provide the logging API. + + :param Hashable name: The name of the logger, typically assigned by the + value from `getLogger`; this is typically a ``str`` + :param int level: (optional) The log level, default is ``WARNING`` + """ + + def __init__(self, name: Hashable, level: int = WARNING) -> None: + """Create an instance.""" + self._level = level + self.name = name + """The name of the logger, this should be unique for proper + functionality of `getLogger()`""" + self._handlers = [] + self.emittedNoHandlerWarning = False + + def setLevel(self, log_level: int) -> None: + """Set the logging cutoff level. + + :param int log_level: the lowest level to output + """ + + self._level = log_level + + def getEffectiveLevel(self) -> int: + """Get the effective level for this logger. + + :return: the lowest level to output + """ + + return self._level + + def addHandler(self, hdlr: Handler) -> None: + """Adds the handler to this logger. + + :param Handler hdlr: The handler to add + """ + self._handlers.append(hdlr) + + def removeHandler(self, hdlr: Handler) -> None: + """Remove handler from this logger. + + :param Handler hdlr: The handler to remove + """ + self._handlers.remove(hdlr) + + def hasHandlers(self) -> bool: + """Whether any handlers have been set for this logger""" + return len(self._handlers) > 0 + + def _log(self, level: int, msg: str, *args) -> None: + record = _logRecordFactory(self.name, level, (msg % args) if args else msg, args) + self.handle(record) + + def handle(self, record: LogRecord) -> None: + """Pass the record to all handlers registered with this logger. + + :param LogRecord record: log record + """ + if _default_handler is None and not self.hasHandlers() and not self.emittedNoHandlerWarning: + sys.stderr.write(f"Logger '{self.name}' has no handlers and default handler is None\n") + self.emittedNoHandlerWarning = True + return + + emitted = False + if record.levelno >= self._level: + for handler in self._handlers: + if record.levelno >= handler.level: + handler.emit(record) + emitted = True + + if not emitted and _default_handler and record.levelno >= _default_handler.level: + _default_handler.emit(record) + + def log(self, level: int, msg: str, *args) -> None: + """Log a message. + + :param int level: the priority level at which to log + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + + self._log(level, msg, *args) + + def debug(self, msg: str, *args) -> None: + """Log a debug message. + + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + self._log(DEBUG, msg, *args) + + def info(self, msg: str, *args) -> None: + """Log a info message. + + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + + self._log(INFO, msg, *args) + + def warning(self, msg: str, *args) -> None: + """Log a warning message. + + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + + self._log(WARNING, msg, *args) + + def error(self, msg: str, *args) -> None: + """Log a error message. + + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + + self._log(ERROR, msg, *args) + + def critical(self, msg: str, *args) -> None: + """Log a critical message. + + :param str msg: the core message string with embedded + formatting directives + :param args: arguments to ``msg % args``; + can be empty + """ + self._log(CRITICAL, msg, *args) + + def exception(self, err: Exception) -> None: + """Convenience method for logging an ERROR with exception information. + + :param Exception err: the exception to be logged + """ + try: + import traceback + except ImportError: + self._log( + ERROR, + "%s: %s (No traceback on this board)", + err.__class__.__name__, + str(err), + ) + else: + lines = [str(err)] + traceback.format_exception(err) + lines = str(err) + "".join(lines) + # some of the returned strings from format_exception already have newlines in them, + # so we can't add the indent in the above line - needs to be done separately + lines = lines.replace("\n", "\n ") + self._log(ERROR, lines) + + +def critical(msg, *args, **kwargs): + """ + Log a message with severity 'CRITICAL' on the root logger. + """ + getLogger().critical(msg, *args, **kwargs) + + +def fatal(msg, *args, **kwargs): + """ + Don't use this function, use critical() instead. + """ + critical(msg, *args, **kwargs) + + +def error(msg, *args, **kwargs): + """ + Log a message with severity 'ERROR' on the root logger. + """ + getLogger().error(msg, *args, **kwargs) + + +def warning(msg, *args, **kwargs): + """ + Log a message with severity 'WARNING' on the root logger. + """ + getLogger().warning(msg, *args, **kwargs) + + +def warn(msg, *args, **kwargs): + """ + Don't use this function, use warning() instead. + """ + warning(msg, *args, **kwargs) + + +def info(msg, *args, **kwargs): + """ + Log a message with severity 'INFO' on the root logger. + """ + getLogger().info(msg, *args, **kwargs) + + +def debug(msg, *args, **kwargs): + """ + Log a message with severity 'DEBUG' on the root logger. + """ + getLogger().debug(msg, *args, **kwargs) + + +def log(level, msg, *args, **kwargs): + """ + Log 'msg % args' with the integer severity 'level' on the root logger. + """ + getLogger().log(level, msg, *args, **kwargs) diff --git a/adafruit_logging/__init__.py b/adafruit_logging/__init__.py deleted file mode 100644 index 2a7ce59..0000000 --- a/adafruit_logging/__init__.py +++ /dev/null @@ -1,246 +0,0 @@ -# SPDX-FileCopyrightText: 2019 Dave Astels for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -""" -`adafruit_logging` -================================================================================ - -Logging module for CircuitPython - - -* Author(s): Dave Astels - -Implementation Notes --------------------- - -**Hardware:** - - -**Software and Dependencies:** - -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases - -""" -# pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use -# pylint:disable=invalid-name - -import time - -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" - - -LEVELS = [ - (00, "NOTSET"), - (10, "DEBUG"), - (20, "INFO"), - (30, "WARNING"), - (40, "ERROR"), - (50, "CRITICAL"), -] - -for value, name in LEVELS: - globals()[name] = value - - -def level_for(value: int) -> str: - """Convert a numberic level to the most appropriate name. - - :param value: a numeric level - - """ - for i in range(len(LEVELS)): - if value == LEVELS[i][0]: - return LEVELS[i][1] - if value < LEVELS[i][0]: - return LEVELS[i - 1][1] - return LEVELS[0][1] - - -class LoggingHandler: - """Abstract logging message handler.""" - - def format(self, level: int, msg: str) -> str: - """Generate a timestamped message. - - :param level: the logging level - :param msg: the message to log - - """ - return "{0}: {1} - {2}".format(time.monotonic(), level_for(level), msg) - - def emit(self, level: int, msg: str): - """Send a message where it should go. - Place holder for subclass implementations. - """ - raise NotImplementedError() - - -class PrintHandler(LoggingHandler): - """Send logging messages to the console by using print.""" - - def emit(self, level: int, msg: str): - """Send a message to the console. - - :param level: the logging level - :param msg: the message to log - - """ - print(self.format(level, msg)) - - -# The level module-global variables get created when loaded -# pylint:disable=undefined-variable - -logger_cache = {} -null_logger = None - -# pylint:disable=global-statement -def getLogger(name: str) -> "Logger": - """Create or retrieve a logger by name. - - :param name: the name of the logger to create/retrieve None will cause the - NullLogger instance to be returned. - - """ - global null_logger - if not name or name == "": - if not null_logger: - null_logger = NullLogger() - return null_logger - - if name not in logger_cache: - logger_cache[name] = Logger() - return logger_cache[name] - - -# pylint:enable=global-statement - - -class Logger: - """Provide a logging api.""" - - def __init__(self): - """Create an instance.""" - self._level = NOTSET - self._handler = PrintHandler() - - def setLevel(self, value: int): - """Set the logging cuttoff level. - - :param value: the lowest level to output - - """ - self._level = value - - def getEffectiveLevel(self) -> int: - """Get the effective level for this logger. - - :return: the lowest level to output - - """ - return self._level - - def addHandler(self, hldr: LoggingHandler): - """Sets the handler of this logger to the specified handler. - *NOTE* this is slightly different from the CPython equivalent which adds - the handler rather than replaceing it. - - :param hldr: the handler - - """ - self._handler = hldr - - def log(self, level: int, format_string: str, *args): - """Log a message. - - :param level: the priority level at which to log - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - if level >= self._level: - self._handler.emit(level, format_string % args) - - def debug(self, format_string: str, *args): - """Log a debug message. - - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - self.log(DEBUG, format_string, *args) - - def info(self, format_string: str, *args): - """Log a info message. - - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - self.log(INFO, format_string, *args) - - def warning(self, format_string: str, *args): - """Log a warning message. - - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - self.log(WARNING, format_string, *args) - - def error(self, format_string: str, *args): - """Log a error message. - - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - self.log(ERROR, format_string, *args) - - def critical(self, format_string: str, *args): - """Log a critical message. - - :param format_string: the core message string with embedded formatting directives - :param args: arguments to ``format_string.format()``, can be empty - - """ - self.log(CRITICAL, format_string, *args) - - -class NullLogger: - """Provide an empty logger. - This can be used in place of a real logger to more efficiently disable logging.""" - - def __init__(self): - """Dummy implementation.""" - - def setLevel(self, value: int): - """Dummy implementation.""" - - def getEffectiveLevel(self) -> int: - """Dummy implementation.""" - return NOTSET - - def addHandler(self, hldr: LoggingHandler): - """Dummy implementation.""" - - def log(self, level: int, format_string: str, *args): - """Dummy implementation.""" - - def debug(self, format_string: str, *args): - """Dummy implementation.""" - - def info(self, format_string: str, *args): - """Dummy implementation.""" - - def warning(self, format_string: str, *args): - """Dummy implementation.""" - - def error(self, format_string: str, *args): - """Dummy implementation.""" - - def critical(self, format_string: str, *args): - """Dummy implementation.""" diff --git a/adafruit_logging/extensions.py b/adafruit_logging/extensions.py deleted file mode 100644 index 356ad29..0000000 --- a/adafruit_logging/extensions.py +++ /dev/null @@ -1,48 +0,0 @@ -# SPDX-FileCopyrightText: 2021 Alec Delaney for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -""" -`extensions` -==================================================== - -CircuitPython logging extension for logging to files - -* Author(s): Alec Delaney -""" - -from . import LoggingHandler - - -class FileHandler(LoggingHandler): - """File handler for working with log files off of the microcontroller (like - an SD card) - - :param filepath: The filepath to the log file - :param mode: Whether to write ('w') or append ('a'); default is to append - """ - - def __init__(self, filepath: str, mode: str = "a"): - self.logfile = open( # pylint: disable=consider-using-with - filepath, mode, encoding="utf-8" - ) - - def close(self): - """Closes the file""" - self.logfile.close() - - def format(self, level: int, msg: str): - """Generate a string to log - - :param level: The level of the message - :param msg: The message to format - """ - return super().format(level, msg) + "\r\n" - - def emit(self, level: int, msg: str): - """Generate the message and write it to the UART. - - :param level: The level of the message - :param msg: The message to log - """ - self.logfile.write(self.format(level, msg)) diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 0000000..d60cf4b --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,8 @@ +/* SPDX-FileCopyrightText: 2025 Sam Blenny + * SPDX-License-Identifier: MIT + */ + +/* Monkey patch the rtd theme to prevent horizontal stacking of short items + * see https://github.com/readthedocs/sphinx_rtd_theme/issues/1301 + */ +.py.property{display: block !important;} diff --git a/docs/api.rst b/docs/api.rst index aced610..fe3e4ee 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. 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_logging :members: diff --git a/docs/conf.py b/docs/conf.py index d48191c..c1dd48b 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", @@ -29,8 +29,8 @@ 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 Logger Library" -copyright = "2019 Dave Astels" +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 + " Dave Astels" author = "Dave Astels" # 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,25 +97,18 @@ # 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 +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 = ["."] +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, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +# Include extra css to work around rtd theme glitches +html_css_files = ["custom.css"] + # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. diff --git a/docs/index.rst b/docs/index.rst index 974b1a2..87a7a52 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/logging_filehandler.py b/examples/logging_filehandler.py index 37e5de6..fc56a7a 100644 --- a/examples/logging_filehandler.py +++ b/examples/logging_filehandler.py @@ -1,13 +1,14 @@ # SPDX-FileCopyrightText: 2021 Alec Delaney # SPDX-License-Identifier: MIT +import adafruit_sdcard import board import busio -from digitalio import DigitalInOut import storage -import adafruit_sdcard +from digitalio import DigitalInOut + import adafruit_logging as logging -from adafruit_logging.extensions import FileHandler +from adafruit_logging import FileHandler # Get chip select pin depending on the board, this one is for the Feather M4 Express sd_cs = board.D10 @@ -28,3 +29,6 @@ logger.info("Logger initialized!") logger.debug("You can even add debug statements to the log!") + +# If you're done with the FileHandler, close it +file_handler.close() diff --git a/examples/logging_formatter_example.py b/examples/logging_formatter_example.py new file mode 100644 index 0000000..02dd640 --- /dev/null +++ b/examples/logging_formatter_example.py @@ -0,0 +1,46 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks +# SPDX-License-Identifier: MIT + + +"""Illustrate usage of default and custom Formatters including +one with timestamps.""" + +import adafruit_logging as logging + +# To test on CPython, un-comment below and comment out above +# import logging + + +logger = logging.getLogger("example") +logger.setLevel(logging.INFO) +print_handler = logging.StreamHandler() +logger.addHandler(print_handler) + +default_formatter = logging.Formatter() + +print_handler.setFormatter(default_formatter) +logger.info("Default formatter example") + + +timestamp_formatter = logging.Formatter(fmt="%(asctime)s %(levelname)s: %(message)s") +print_handler.setFormatter(timestamp_formatter) +logger.info("Timestamp formatter example") + + +custom_vals_formatter = logging.Formatter( + fmt="%(ip)s %(levelname)s: %(message)s", defaults={"ip": "192.168.1.188"} +) +print_handler.setFormatter(custom_vals_formatter) +logger.info("Custom formatter example") + + +bracket_timestamp_formatter = logging.Formatter(fmt="{asctime} {levelname}: {message}", style="{") +print_handler.setFormatter(bracket_timestamp_formatter) +logger.info("Timestamp formatter bracket style example") + + +bracket_custom_vals_formatter = logging.Formatter( + fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"} +) +print_handler.setFormatter(bracket_custom_vals_formatter) +logger.info("Custom formatter bracket style example") diff --git a/examples/logging_mqtt_handler.py b/examples/logging_mqtt_handler.py new file mode 100755 index 0000000..6de8309 --- /dev/null +++ b/examples/logging_mqtt_handler.py @@ -0,0 +1,91 @@ +# SPDX-FileCopyrightText: 2022 vladak +# SPDX-License-Identifier: Unlicense +""" +Demonstrate how to use a single logger to emit log records to +both console and MQTT broker, in this case Adafruit IO. +""" + +import json +import socket +import ssl + +import adafruit_minimqtt.adafruit_minimqtt as MQTT + +import adafruit_logging as logging + +# adafruit_logging defines log levels dynamically. +from adafruit_logging import NOTSET, Handler, LogRecord + + +class MQTTHandler(Handler): + """ + Log handler that emits log records as MQTT PUBLISH messages. + """ + + def __init__(self, mqtt_client: MQTT.MQTT, topic: str) -> None: + """ + Assumes that the MQTT client object is already connected. + """ + super().__init__() + + self._mqtt_client = mqtt_client + self._topic = topic + + # To make it work also in CPython. + self.level = NOTSET + + def emit(self, record: LogRecord) -> None: + """ + Publish message from the LogRecord to the MQTT broker, if connected. + """ + try: + if self._mqtt_client.is_connected(): + self._mqtt_client.publish(self._topic, record.msg) + except MQTT.MMQTTException: + pass + + # To make this work also in CPython's logging. + def handle(self, record: LogRecord) -> None: + """ + Handle the log record. Here, it means just emit. + """ + self.emit(record) + + +def main(): + """ + Demonstrate how to use MQTT log handler. + """ + logger = logging.getLogger(__name__) + + broker = "io.adafruit.com" + port = 8883 + username = "Adafruit_IO_username" + password = "Adafruit_IO_key" + feedname = "Adafruit_feed_name" + mqtt_topic = f"{username}/feeds/{feedname}" + mqtt_client = MQTT.MQTT( + broker=broker, + port=port, + username=username, + password=password, + socket_pool=socket, + ssl_context=ssl.create_default_context(), + ) + mqtt_client.connect() + mqtt_handler = MQTTHandler(mqtt_client, mqtt_topic) + print("adding MQTT handler") + logger.addHandler(mqtt_handler) + + stream_handler = logging.StreamHandler() + print("adding Stream handler") + logger.addHandler(stream_handler) + + data = "foo bar" + print("logging begins !") + # This should emit both to the console as well as to the MQTT broker. + logger.warning(json.dumps(data)) + + +if __name__ == "__main__": + main() diff --git a/examples/logging_simpletest.py b/examples/logging_simpletest.py index 3286bce..8bdda9b 100644 --- a/examples/logging_simpletest.py +++ b/examples/logging_simpletest.py @@ -1,33 +1,42 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint:disable=undefined-variable,wildcard-import,no-name-in-module -# pylint:disable=no-member,invalid-name - """Briefly exercise the logger and null logger.""" import adafruit_logging as logging -# This should produce an error output - -logger = logging.getLogger("test") - -logger.setLevel(logging.ERROR) -logger.info("Info message") -logger.error("Error message") +# This should produce an info output via default handler. -# This should produce no output +logger_default_handler = logging.getLogger("default_handler") +logger_default_handler.setLevel(logging.INFO) +logger_default_handler.info("Default handler: Info message") +assert not logger_default_handler.hasHandlers() -null_logger = logging.getLogger(None) +# This should produce an error output via Stream Handler. -null_logger.setLevel(logging.ERROR) -null_logger.info("Info message") -null_logger.error("Error message") - -# This should produce no output +logger = logging.getLogger("test") +print_handler = logging.StreamHandler() +logger.addHandler(print_handler) +assert logger.hasHandlers() -null_logger = logging.getLogger("") +logger.setLevel(logging.ERROR) +logger.info("Stream Handler: Info message") +logger.error("Stream Handler: Error message") +try: + raise RuntimeError("Test exception handling") +except RuntimeError as e: + logger.exception(e) +# This should produce no output at all. + +null_logger = logging.getLogger("null") +null_handler = logging.NullHandler() +null_logger.addHandler(null_handler) +assert null_logger.hasHandlers() null_logger.setLevel(logging.ERROR) -null_logger.info("Info message") -null_logger.error("Error message") +null_logger.info("Null Handler: Info message") +null_logger.error("Null Handler: Error message") +try: + raise RuntimeError("Test exception handling") +except RuntimeError as e: + null_logger.exception(e) 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..00c7665 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-logging" +description = "Logging module for CircuitPython" +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_Logging"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "logging", + "logger", +] +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] +py-modules = ["adafruit_logging"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 5f97a2d..452ef26 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,6 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka +typing-extensions diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..2cc8fc7 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# 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 + "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.disabled b/setup.py.disabled deleted file mode 100644 index 4d5eddc..0000000 --- a/setup.py.disabled +++ /dev/null @@ -1,6 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""This library is not deployed to PyPI. It is either a board-specific helper library or -does not make sense for use on single board computers and Linux."""