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 c4c975d..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 pylint, Sphinx, pre-commit - run: | - pip install --force-reinstall pylint 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 fcafc20..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +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 -*.ttf + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 354c761..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,34 +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: pylint-2.7.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) - description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] - language: system + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 0238b90..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 - -# 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=12 - - -[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 ffa84c4..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: requirements.txt diff --git a/LICENSES/OFL-1.1.txt b/LICENSES/OFL-1.1.txt new file mode 100644 index 0000000..84a3934 --- /dev/null +++ b/LICENSES/OFL-1.1.txt @@ -0,0 +1,90 @@ +The SIL Open Font License version 1.1 is copied below, and is also +available with a FAQ at http://scripts.sil.org/OFL. + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/README.rst b/README.rst index 2d59151..ac47515 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-bitmap_font/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/bitmap-font/en/latest/ + :target: https://docs.circuitpython.org/projects/bitmap-font/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_Bitmap_Font/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 + Loads bitmap fonts into CircuitPython's displayio. BDF and PCF files are well supported. TTF support is not yet complete. @@ -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-bitmap_font Usage Example @@ -64,20 +68,22 @@ Usage Example Creating Fonts ============== -See `this learn guide `_ for more information about building custom fornt files +See `this learn guide `_ for more information about building custom font files. The command line tool :code:`otf2bdf` can be used make bdf files for use with this library. The command line tool :code:`bdftopcf` can be used make pcf files for use with this library. +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. + 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_bitmap_font/bdf.py b/adafruit_bitmap_font/bdf.py index e15ab0c..fae6990 100644 --- a/adafruit_bitmap_font/bdf.py +++ b/adafruit_bitmap_font/bdf.py @@ -22,25 +22,34 @@ """ +try: + from io import FileIO + from typing import Iterable, Optional, Tuple, Union + + from displayio import Bitmap +except ImportError: + pass + import gc + from fontio import Glyph + from .glyph_cache import GlyphCache -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git" class BDF(GlyphCache): """Loads glyphs from a BDF file in the given bitmap_class.""" - def __init__(self, f, bitmap_class): + def __init__(self, f: FileIO, bitmap_class: Bitmap) -> None: super().__init__() self.file = f self.name = f self.file.seek(0) self.bitmap_class = bitmap_class - line = self.file.readline() - line = str(line, "utf-8") + line = self._readline_file() if not line or not line.startswith("STARTFONT 2.1"): raise ValueError("Unsupported file version") self._verify_bounding_box() @@ -51,7 +60,7 @@ def __init__(self, f, bitmap_class): self._descent = None @property - def descent(self): + def descent(self) -> Optional[int]: """The number of pixels below the baseline of a typical descender""" if self._descent is None: self.file.seek(0) @@ -67,13 +76,12 @@ def descent(self): return self._descent @property - def ascent(self): + def ascent(self) -> Optional[int]: """The number of pixels above the baseline of a typical ascender""" if self._ascent is None: self.file.seek(0) while True: - line = self.file.readline() - line = str(line, "utf-8") + line = self._readline_file() if not line: break @@ -83,7 +91,7 @@ def ascent(self): return self._ascent - def _verify_bounding_box(self): + def _verify_bounding_box(self) -> None: """Private function to verify FOUNTBOUNDINGBOX parameter This function will parse the first 10 lines of the font source file to verify the value or raise an exception in case is not found @@ -93,8 +101,9 @@ def _verify_bounding_box(self): # Exception is when font file have a comment. Comments are three lines # 10 lines is a safe bet for _ in range(11): - line = self.file.readline() - line = str(line, "utf-8") + line = self._readline_file() + while line.startswith("COMMENT "): + line = self._readline_file() if line.startswith("FONTBOUNDINGBOX "): _, x, y, x_offset, y_offset = line.split() self._boundingbox = (int(x), int(y), int(x_offset), int(y_offset)) @@ -102,16 +111,19 @@ def _verify_bounding_box(self): try: self._boundingbox except AttributeError as error: - raise Exception( - "Source file does not have the FOUNTBONDINGBOX parameter" + raise RuntimeError( + "Source file does not have the FOUNTBOUNDINGBOX parameter" ) from error - def get_bounding_box(self): + def _readline_file(self) -> str: + line = self.file.readline() + return str(line, "utf-8") + + def get_bounding_box(self) -> Tuple[int, int, int, int]: """Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset""" return self._boundingbox - def load_glyphs(self, code_points): - # pylint: disable=too-many-statements,too-many-branches,too-many-nested-blocks,too-many-locals + def load_glyphs(self, code_points: Union[int, str, Iterable[int]]) -> None: metadata = True character = False code_point = None diff --git a/adafruit_bitmap_font/bitmap_font.py b/adafruit_bitmap_font/bitmap_font.py index 5ceee18..7a67ef8 100644 --- a/adafruit_bitmap_font/bitmap_font.py +++ b/adafruit_bitmap_font/bitmap_font.py @@ -22,13 +22,28 @@ """ -__version__ = "0.0.0-auto.0" +try: + from typing import Optional, Union + + from displayio import Bitmap + + from . import bdf, lvfontbin, pcf, ttf +except ImportError: + pass + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git" -def load_font(filename, bitmap=None): +# The LVGL file starts with the size of the 'head' section. It hasn't changed in five years so +# we can treat it like a magic number. +LVGL_HEADER_SIZE = b"\x30\x00\x00\x00" + + +def load_font( + filename: str, bitmap: Optional[Bitmap] = None +) -> Union[bdf.BDF, lvfontbin.LVGLFont, pcf.PCF, ttf.TTF]: """Loads a font file. Returns None if unsupported.""" - # pylint: disable=import-outside-toplevel if not bitmap: import displayio @@ -48,4 +63,11 @@ def load_font(filename, bitmap=None): return ttf.TTF(font_file, bitmap) + if ( + filename.endswith("bin") or filename.endswith("lvfontbin") + ) and first_four == LVGL_HEADER_SIZE: + from . import lvfontbin + + return lvfontbin.LVGLFont(font_file, bitmap) + raise ValueError("Unknown magic number %r" % first_four) diff --git a/adafruit_bitmap_font/glyph_cache.py b/adafruit_bitmap_font/glyph_cache.py index 9267ef3..db08ad7 100644 --- a/adafruit_bitmap_font/glyph_cache.py +++ b/adafruit_bitmap_font/glyph_cache.py @@ -22,22 +22,29 @@ """ +try: + from typing import Iterable, Union + + from fontio import Glyph +except ImportError: + pass + import gc -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git" class GlyphCache: """Caches glyphs loaded by a subclass.""" - def __init__(self): + def __init__(self) -> None: self._glyphs = {} - def load_glyphs(self, code_points): + def load_glyphs(self, code_points: Union[int, str, Iterable[int]]) -> None: """Loads displayio.Glyph objects into the GlyphCache from the font.""" - def get_glyph(self, code_point): + def get_glyph(self, code_point: int) -> Glyph: """Returns a displayio.Glyph for the given code point or None is unsupported.""" if code_point in self._glyphs: return self._glyphs[code_point] diff --git a/adafruit_bitmap_font/lvfontbin.py b/adafruit_bitmap_font/lvfontbin.py new file mode 100644 index 0000000..5438f04 --- /dev/null +++ b/adafruit_bitmap_font/lvfontbin.py @@ -0,0 +1,281 @@ +# SPDX-FileCopyrightText: 2025 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_bitmap_font.lvfontbin` +==================================================== + +Loads binary LVGL format fonts. + +* Author(s): Scott Shawcroft + +Implementation Notes +-------------------- + +**Hardware:** + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +""" + +import struct + +try: + from io import FileIO + from typing import Iterable, Union +except ImportError: + pass + +from fontio import Glyph + +from .glyph_cache import GlyphCache + + +class LVGLFont(GlyphCache): + """Loads glyphs from a LVGL binary font file in the given bitmap_class. + + There is an in-browser converter here: https://lvgl.io/tools/fontconverter + + The format is documented here: https://github.com/lvgl/lv_font_conv/tree/master/doc + + """ + + def __init__(self, f: FileIO, bitmap_class=None): + """Initialize LVGL font. + + Args: + f: File object containing the LVGL font data + bitmap_class: Optional bitmap class to use for glyphs. Defaults to displayio.Bitmap. + """ + super().__init__() + f.seek(0) + self.file = f + self.bitmap_class = bitmap_class + # Initialize default values for bounding box + self._width = None + self._height = None + self._x_offset = 0 + self._y_offset = 0 + + # For reading bits + self._byte = 0 + self._remaining_bits = 0 + + while True: + buffer = f.read(4) + if len(buffer) < 4: + break + section_size = struct.unpack(" int: + """The number of pixels above the baseline of a typical ascender""" + return self._ascent + + @property + def descent(self) -> int: + """The number of pixels below the baseline of a typical descender""" + return self._descent + + def get_bounding_box(self) -> tuple[int, int, int, int]: + """Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset""" + return (self._width, self._height, self._x_offset, self._y_offset) + + def _seek(self, offset): + self.file.seek(offset) + self._byte = 0 + self._remaining_bits = 0 + + def _read_bits(self, num_bits): + result = 0 + needed_bits = num_bits + while needed_bits > 0: + if self._remaining_bits == 0: + self._byte = self.file.read(1)[0] + self._remaining_bits = 8 + available_bits = min(needed_bits, self._remaining_bits) + result = (result << available_bits) | (self._byte >> (8 - available_bits)) + self._byte <<= available_bits + self._byte &= 0xFF + self._remaining_bits -= available_bits + needed_bits -= available_bits + return result + + def load_glyphs(self, code_points: Union[int, str, Iterable[int]]) -> None: + # pylint: disable=too-many-statements,too-many-branches,too-many-nested-blocks,too-many-locals + if isinstance(code_points, int): + code_points = (code_points,) + elif isinstance(code_points, str): + code_points = [ord(c) for c in code_points] + + # Only load glyphs that aren't already cached + code_points = sorted(c for c in code_points if self._glyphs.get(c, None) is None) + if not code_points: + return + + for code_point in code_points: + # Find character ID in the cmap table + cid = None + + # Search through all subtables + for subtable in self._cmap_subtables: + format_type = subtable["format"] + range_start = subtable["range_start"] + range_length = subtable["range_length"] + glyph_offset = subtable["glyph_offset"] + entries_count = subtable["entries_count"] + data_offset = subtable["data_offset"] + + if range_start <= code_point < range_start + range_length: + if format_type == 0: # Continuous + # Read the glyph IDs from the data section (single bytes) + self.file.seek(data_offset) + subtable_data = self.file.read(entries_count) + glyph_id = subtable_data[code_point - range_start] + cid = glyph_id + glyph_offset + break + elif format_type == 2: # Format 0 tiny + cid = glyph_offset + (code_point - range_start) + break + elif format_type == 3: # Sparse tiny + # Read the codepoint offsets from the data section + self.file.seek(data_offset) + subtable_data = self.file.read(entries_count * 2) + for i in range(entries_count): + cp_offset = struct.unpack("= self._max_cid: + self._glyphs[code_point] = None + continue + + offset_length = 4 if self._index_to_loc_format == 1 else 2 + + # Get the glyph offset from the location table + self._seek(self._loca_start + cid * offset_length) + glyph_offset = struct.unpack( + " 0: # Convert any non-zero value to 1 + bitmap[x, y] = 1 + + # Create and cache the glyph + self._glyphs[code_point] = Glyph( + bitmap, 0, bbox_w, bbox_h, bbox_x, bbox_y, glyph_advance, 0 + ) diff --git a/adafruit_bitmap_font/pcf.py b/adafruit_bitmap_font/pcf.py index 3964cc1..1e232ba 100644 --- a/adafruit_bitmap_font/pcf.py +++ b/adafruit_bitmap_font/pcf.py @@ -22,18 +22,27 @@ """ -from collections import namedtuple +try: + from io import FileIO + from typing import Iterable, Iterator, Tuple, Union + + from displayio import Bitmap as displayioBitmap +except ImportError: + pass + import gc import struct -from micropython import const +from collections import namedtuple from fontio import Glyph +from micropython import const + from .glyph_cache import GlyphCache try: from bitmaptools import readinto as _bitmap_readinto except ImportError: - _bitmap_readinto = None # pylint: disable=invalid-name + _bitmap_readinto = None _PCF_PROPERTIES = const(1 << 0) _PCF_ACCELERATORS = const(1 << 1) @@ -96,7 +105,7 @@ class PCF(GlyphCache): """Loads glyphs from a PCF file in the given bitmap_class.""" - def __init__(self, f, bitmap_class): + def __init__(self, f: FileIO, bitmap_class: displayioBitmap) -> None: super().__init__() self.file = f self.name = f @@ -133,27 +142,27 @@ def __init__(self, f, bitmap_class): ) @property - def ascent(self): + def ascent(self) -> int: """The number of pixels above the baseline of a typical ascender""" return self._ascent @property - def descent(self): + def descent(self) -> int: """The number of pixels below the baseline of a typical descender""" return self._descent - def get_bounding_box(self): + def get_bounding_box(self) -> Tuple[int, int, int, int]: """Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset""" return self._bounding_box - def _read(self, format_): + def _read(self, format_: str) -> Tuple: size = struct.calcsize(format_) if size != len(self.buffer): self.buffer = bytearray(size) self.file.readinto(self.buffer) return struct.unpack_from(format_, self.buffer) - def _seek_table(self, table): + def _seek_table(self, table: Table) -> int: self.file.seek(table.offset) (format_,) = self._read(" Encoding: encoding = self.tables[_PCF_BDF_ENCODINGS] self._seek_table(encoding) return Encoding(*self._read(">hhhhh")) - def _read_bitmap_table(self): + def _read_bitmap_table(self) -> Bitmap: bitmaps = self.tables[_PCF_BITMAPS] format_ = self._seek_table(bitmaps) @@ -177,7 +186,7 @@ def _read_bitmap_table(self): bitmap_sizes = self._read(">4I") return Bitmap(glyph_count, bitmap_sizes[format_ & 3]) - def _read_metrics(self, compressed_metrics): + def _read_metrics(self, compressed_metrics: bool) -> Metrics: if compressed_metrics: ( left_side_bearing, @@ -210,8 +219,7 @@ def _read_metrics(self, compressed_metrics): attributes, ) - def _read_accelerator_tables(self): - # pylint: disable=too-many-locals + def _read_accelerator_tables(self) -> Accelerators: accelerators = self.tables.get(_PCF_BDF_ACCELERATORS) if not accelerators: accelerators = self.tables.get(_PCF_ACCELERATORS) @@ -260,7 +268,7 @@ def _read_accelerator_tables(self): ink_maxbounds, ) - def _read_properties(self): + def _read_properties(self) -> Iterator[Tuple[bytes, Union[bytes, int]]]: property_table_offset = self.tables[_PCF_PROPERTIES]["offset"] self.file.seek(property_table_offset) (format_,) = self._read(" None: if isinstance(code_points, int): code_points = (code_points,) elif isinstance(code_points, str): code_points = [ord(c) for c in code_points] - code_points = sorted( - c for c in code_points if self._glyphs.get(c, None) is None - ) + code_points = sorted(c for c in code_points if self._glyphs.get(c, None) is None) if not code_points: return indices_offset = self.tables[_PCF_BDF_ENCODINGS].offset + 14 bitmap_offset_offsets = self.tables[_PCF_BITMAPS].offset + 8 - first_bitmap_offset = self.tables[_PCF_BITMAPS].offset + 4 * ( - 6 + self._bitmaps.glyph_count - ) + first_bitmap_offset = self.tables[_PCF_BITMAPS].offset + 4 * (6 + self._bitmaps.glyph_count) metrics_compressed = self.tables[_PCF_METRICS].format & _PCF_COMPRESSED_METRICS - first_metric_offset = self.tables[_PCF_METRICS].offset + ( - 6 if metrics_compressed else 8 - ) + first_metric_offset = self.tables[_PCF_METRICS].offset + (6 if metrics_compressed else 8) metrics_size = 5 if metrics_compressed else 12 # These will each _tend to be_ forward reads in the file, at least @@ -359,7 +360,7 @@ def load_glyphs(self, code_points): # once gc.collect() bitmaps = [None] * len(code_points) - for i in range(len(all_metrics)): # pylint: disable=consider-using-enumerate + for i in range(len(all_metrics)): metrics = all_metrics[i] if metrics is not None: width = metrics.right_side_bearing - metrics.left_side_bearing diff --git a/adafruit_bitmap_font/ttf.py b/adafruit_bitmap_font/ttf.py index 54c81fa..3fca18b 100644 --- a/adafruit_bitmap_font/ttf.py +++ b/adafruit_bitmap_font/ttf.py @@ -2,23 +2,29 @@ # # SPDX-License-Identifier: MIT -# pylint: skip-file # Remove the above when TTF is actually supported. -import struct +try: + from io import FileIO + from typing import Tuple + + from displayio import Bitmap +except ImportError: + pass +import struct # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html class TTF: - def __init__(self, f, bitmap): + def __init__(self, f: FileIO, bitmap: Bitmap) -> None: f.seek(0) self.file = f self.characters = {} - def read(format): + def read(format: str) -> Tuple: s = struct.calcsize(format) return struct.unpack_from(format, f.read(s)) @@ -52,7 +58,7 @@ def read(format): for _ in range(numberOfContours): ends.append(read(">H")) instructionLength = read(">h")[0] - instructions = read(">{}s".format(instructionLength))[0] + instructions = read(f">{instructionLength}s")[0] print(instructions) break else: 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 71a86b4..921dbd7 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_bitmap_font :members: diff --git a/docs/conf.py b/docs/conf.py index cae894a..c899ecf 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 Bitmap_Font Library" -copyright = "2019 Scott Shawcroft" +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 + " Scott Shawcroft" author = "Scott Shawcroft" # 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 75a842e..c112508 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 new file mode 100644 index 0000000..979f568 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/bitmap_font_displayio_simpletest.py b/examples/bitmap_font_displayio_simpletest.py index 01d390e..63d3ba8 100644 --- a/examples/bitmap_font_displayio_simpletest.py +++ b/examples/bitmap_font_displayio_simpletest.py @@ -9,9 +9,9 @@ bitmap with pixels matching glyphs from a given String """ - import board import displayio + from adafruit_bitmap_font import bitmap_font # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.) @@ -71,7 +71,7 @@ group.append(tile_grid) # Add the Group to the Display -display.show(group) +display.root_group = group while True: pass diff --git a/examples/bitmap_font_forkawesome_icons.py b/examples/bitmap_font_forkawesome_icons.py index d54cc11..70c421c 100644 --- a/examples/bitmap_font_forkawesome_icons.py +++ b/examples/bitmap_font_forkawesome_icons.py @@ -6,6 +6,7 @@ More info here: https://emergent.unpythonic.net/01606790241 """ + activitypub = "\uf2f2" address_book_o = "\uf2ba" address_book = "\uf2b9" @@ -201,7 +202,7 @@ connectdevelop = "\uf20e" contao = "\uf26d" conway_glider = "\uf349" -copyright = "\uf1f9" # pylint: disable=redefined-builtin +copyright = "\uf1f9" creative_commons = "\uf25e" credit_card_alt = "\uf283" credit_card = "\uf09d" diff --git a/examples/bitmap_font_label_forkawesome.py b/examples/bitmap_font_label_forkawesome.py index 13a57b9..d00ddc9 100644 --- a/examples/bitmap_font_label_forkawesome.py +++ b/examples/bitmap_font_label_forkawesome.py @@ -9,8 +9,9 @@ """ import board -from bitmap_font_forkawesome_icons import microchip, python, terminal from adafruit_display_text import label +from bitmap_font_forkawesome_icons import microchip, python, terminal + from adafruit_bitmap_font import bitmap_font # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.) @@ -21,7 +22,7 @@ font_file = "fonts/forkawesome-42.pcf" # Set text, font, and color -text = "{} {} {}".format(terminal, python, microchip) +text = f"{terminal} {python} {microchip}" font = bitmap_font.load_font(font_file) color = 0xFF00FF @@ -33,7 +34,7 @@ text_area.anchored_position = (display.width // 2, display.height // 2) # Show it -display.show(text_area) +display.root_group = text_area while True: pass diff --git a/examples/bitmap_font_label_magtag.py b/examples/bitmap_font_label_magtag.py index 02e6a32..3a9c857 100644 --- a/examples/bitmap_font_label_magtag.py +++ b/examples/bitmap_font_label_magtag.py @@ -6,9 +6,12 @@ loaded by adafruit_bitmap_font. Adapted for use on MagTag """ + import time + import board from adafruit_display_text import label + from adafruit_bitmap_font import bitmap_font # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.) @@ -45,7 +48,7 @@ text_area.y = 20 # Show it and refresh -display.show(text_area) +display.root_group = text_area display.refresh() while True: pass diff --git a/examples/bitmap_font_label_simpletest.py b/examples/bitmap_font_label_simpletest.py index 1a1a57b..c6988ce 100644 --- a/examples/bitmap_font_label_simpletest.py +++ b/examples/bitmap_font_label_simpletest.py @@ -8,6 +8,7 @@ import board from adafruit_display_text import label + from adafruit_bitmap_font import bitmap_font # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.) @@ -32,7 +33,7 @@ text_area.y = 20 # Show it -display.show(text_area) +display.root_group = text_area while True: pass diff --git a/examples/bitmap_font_lvgl_simpletest.py b/examples/bitmap_font_lvgl_simpletest.py new file mode 100644 index 0000000..72f9872 --- /dev/null +++ b/examples/bitmap_font_lvgl_simpletest.py @@ -0,0 +1,39 @@ +# SPDX-FileCopyrightText: 2025 Scott Shawcroft for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This example demonstrates loading and using an LVGL format font. +You can convert fonts to LVGL format using the online converter: +https://lvgl.io/tools/fontconverter +""" + +from adafruit_bitmap_font import bitmap_font + +# Use the Japanese font file +font_file = "fonts/unifont-16.0.02-ja.bin" + +font = bitmap_font.load_font(font_file) +print("Successfully loaded LVGL font") +print("Font metrics:") +print(f" Ascent: {font.ascent}") +print(f" Descent: {font.descent}") +bbox = font.get_bounding_box() +print(f" Bounding box: width={bbox[0]}, height={bbox[1]}, x_offset={bbox[2]}, y_offset={bbox[3]}") + +# Test characters +test_japanese = "a こんにちは世界🎉" # Hello World in Japanese (according to Claude) +print(f"\nTesting characters: {test_japanese}") +font.load_glyphs(test_japanese) +for c in test_japanese: + glyph = font.get_glyph(ord(c)) + if glyph: + print(f" Character '{c}' (U+{ord(c):04X}):") # Print ASCII art representation of the glyph + for y in range(glyph.height): + pixels = [] + for x in range(glyph.width): + value = glyph.bitmap[x, y] + pixel = "#" if value > 0 else " " + pixels.append(pixel) + print(" " + "".join(pixels)) + else: + print(f" Character '{c}' (U+{ord(c):04X}) not found in font") diff --git a/examples/bitmap_font_simpletest.py b/examples/bitmap_font_simpletest.py index 693890e..68d9aad 100644 --- a/examples/bitmap_font_simpletest.py +++ b/examples/bitmap_font_simpletest.py @@ -6,7 +6,7 @@ ASCII art representation of the given string specimen """ -from adafruit_bitmap_font import bitmap_font # pylint: disable=wrong-import-position +from adafruit_bitmap_font import bitmap_font # you can change this to a different bdf or pcf font file font_file = "fonts/LeagueSpartan-Bold-16.bdf" diff --git a/examples/fonts/unifont-16.0.02-ascii-emoji.bin b/examples/fonts/unifont-16.0.02-ascii-emoji.bin new file mode 100644 index 0000000..418f709 Binary files /dev/null and b/examples/fonts/unifont-16.0.02-ascii-emoji.bin differ diff --git a/examples/fonts/unifont-16.0.02-ascii-emoji.bin.license b/examples/fonts/unifont-16.0.02-ascii-emoji.bin.license new file mode 100644 index 0000000..18b43d8 --- /dev/null +++ b/examples/fonts/unifont-16.0.02-ascii-emoji.bin.license @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2024 GNU Unifont Contributors +# +# SPDX-License-Identifier: OFL-1.1 + +# Unifont version 16.0.02 is licensed under the SIL Open Font License 1.1 (OFL-1.1). + +# Original Unifont converted to LVGL binary format for use with CircuitPython. diff --git a/examples/fonts/unifont-16.0.02-ja.bin b/examples/fonts/unifont-16.0.02-ja.bin new file mode 100644 index 0000000..e550156 Binary files /dev/null and b/examples/fonts/unifont-16.0.02-ja.bin differ diff --git a/examples/fonts/unifont-16.0.02-ja.bin.license b/examples/fonts/unifont-16.0.02-ja.bin.license new file mode 100644 index 0000000..18b43d8 --- /dev/null +++ b/examples/fonts/unifont-16.0.02-ja.bin.license @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2024 GNU Unifont Contributors +# +# SPDX-License-Identifier: OFL-1.1 + +# Unifont version 16.0.02 is licensed under the SIL Open Font License 1.1 (OFL-1.1). + +# Original Unifont converted to LVGL binary format for use with CircuitPython. 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..61074b6 --- /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-bitmap_font" +description = "Loads bitmap fonts into CircuitPython displayio." +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_Bitmap_Font"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "font", + "text", + "displayio", + "bitmap", +] +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_bitmap_font"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 17a850d..274b851 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,6 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka +adafruit-blinka-displayio diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..5a85851 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,104 @@ +# 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 + "PLR0912", # Too many branches + "PLR0914", # Too many local vars + "PLR0915", # Too many statements + "PLR1702", # Too many nested blocks + "PLC0415", # import outside toplevel + "F841", # local var never used +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index fe25689..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-bitmap_font", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Loads bitmap fonts into CircuitPython displayio.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka"], - # 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 font text displayio bitmap", - # 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=['...']` - packages=["adafruit_bitmap_font"], -) diff --git a/test/displayio.py b/test/displayio.py index 7b16498..90f5995 100644 --- a/test/displayio.py +++ b/test/displayio.py @@ -4,7 +4,7 @@ """Implementation of minimal displayio subset for testing""" -# pylint: disable=all + class Bitmap: def __init__(self, width, height, color_count): self.width = width