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/.gitignore b/.gitignore index db3d538..89da754 100644 --- a/.gitignore +++ b/.gitignore @@ -46,3 +46,6 @@ _build .idea .vscode *~ + +# Test coverage reports +.coverage diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..f27b786 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,22 @@ # SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 40208c3..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 0000000..c03fdb0 --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,7 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: Adafruit_CircuitPython_miniQR +Source: https://github.com/adafruit/Adafruit_CircuitPython_miniQR + +Files: tests/*.gild +Copyright: 2019 Translation Company +License: Unlicense diff --git a/README.rst b/README.rst index 5d000eb..8c55fc4 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_miniQR/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff A non-hardware dependant miniature QR generator library. All native Python! diff --git a/adafruit_miniqr.py b/adafruit_miniqr.py index 55b1cae..f8fcb04 100644 --- a/adafruit_miniqr.py +++ b/adafruit_miniqr.py @@ -36,6 +36,11 @@ # imports import math +try: + from typing import Dict, List, Optional, Tuple +except ImportError: + pass + __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_miniQR.git" @@ -52,14 +57,14 @@ # Optimized polynomial helpers -def _glog(n): +def _glog(n: int) -> int: """Lookup log(n) from pre-calculated byte table""" if n < 1: raise ValueError("glog(" + n + ")") return LOG_TABLE[n] -def _gexp(n): +def _gexp(n: int) -> int: """Lookup exp(n) from pre-calculated byte table""" while n < 0: n += 255 @@ -68,34 +73,32 @@ def _gexp(n): return EXP_TABLE[n] -# pylint: disable=line-too-long -EXP_TABLE = b"\x01\x02\x04\x08\x10 @\x80\x1d:t\xe8\xcd\x87\x13&L\x98-Z\xb4u\xea\xc9\x8f\x03\x06\x0c\x180`\xc0\x9d'N\x9c%J\x945j\xd4\xb5w\xee\xc1\x9f#F\x8c\x05\n\x14(P\xa0]\xbai\xd2\xb9o\xde\xa1_\xbea\xc2\x99/^\xbce\xca\x89\x0f\x1e|\xf8\xed\xc7\x93;v\xec\xc5\x973f\xcc\x85\x17.\\\xb8m\xda\xa9O\x9e!B\x84\x15*T\xa8M\x9a)R\xa4U\xaaI\x929r\xe4\xd5\xb7s\xe6\xd1\xbfc\xc6\x91?~\xfc\xe5\xd7\xb3{\xf6\xf1\xff\xe3\xdb\xabK\x961b\xc4\x957n\xdc\xa5W\xaeA\x82\x192d\xc8\x8d\x07\x0e\x1c8p\xe0\xdd\xa7S\xa6Q\xa2Y\xb2y\xf2\xf9\xef\xc3\x9b+V\xacE\x8a\t\x12$H\x90=z\xf4\xf5\xf7\xf3\xfb\xeb\xcb\x8b\x0b\x16,X\xb0}\xfa\xe9\xcf\x83\x1b6l\xd8\xadG\x8e\x01" +EXP_TABLE = b"\x01\x02\x04\x08\x10 @\x80\x1d:t\xe8\xcd\x87\x13&L\x98-Z\xb4u\xea\xc9\x8f\x03\x06\x0c\x180`\xc0\x9d'N\x9c%J\x945j\xd4\xb5w\xee\xc1\x9f#F\x8c\x05\n\x14(P\xa0]\xbai\xd2\xb9o\xde\xa1_\xbea\xc2\x99/^\xbce\xca\x89\x0f\x1e|\xf8\xed\xc7\x93;v\xec\xc5\x973f\xcc\x85\x17.\\\xb8m\xda\xa9O\x9e!B\x84\x15*T\xa8M\x9a)R\xa4U\xaaI\x929r\xe4\xd5\xb7s\xe6\xd1\xbfc\xc6\x91?~\xfc\xe5\xd7\xb3{\xf6\xf1\xff\xe3\xdb\xabK\x961b\xc4\x957n\xdc\xa5W\xaeA\x82\x192d\xc8\x8d\x07\x0e\x1c8p\xe0\xdd\xa7S\xa6Q\xa2Y\xb2y\xf2\xf9\xef\xc3\x9b+V\xacE\x8a\t\x12$H\x90=z\xf4\xf5\xf7\xf3\xfb\xeb\xcb\x8b\x0b\x16,X\xb0}\xfa\xe9\xcf\x83\x1b6l\xd8\xadG\x8e\x01" # noqa: E501 -LOG_TABLE = b"\x00\x00\x01\x19\x022\x1a\xc6\x03\xdf3\xee\x1bh\xc7K\x04d\xe0\x0e4\x8d\xef\x81\x1c\xc1i\xf8\xc8\x08Lq\x05\x8ae/\xe1$\x0f!5\x93\x8e\xda\xf0\x12\x82E\x1d\xb5\xc2}j'\xf9\xb9\xc9\x9a\txM\xe4r\xa6\x06\xbf\x8bbf\xdd0\xfd\xe2\x98%\xb3\x10\x91\"\x886\xd0\x94\xce\x8f\x96\xdb\xbd\xf1\xd2\x13\\\x838F@\x1eB\xb6\xa3\xc3H~nk:(T\xfa\x85\xba=\xca^\x9b\x9f\n\x15y+N\xd4\xe5\xacs\xf3\xa7W\x07p\xc0\xf7\x8c\x80c\rgJ\xde\xed1\xc5\xfe\x18\xe3\xa5\x99w&\xb8\xb4|\x11D\x92\xd9# \x89.7?\xd1[\x95\xbc\xcf\xcd\x90\x87\x97\xb2\xdc\xfc\xbea\xf2V\xd3\xab\x14*]\x9e\x84<9SGmA\xa2\x1f-C\xd8\xb7{\xa4v\xc4\x17I\xec\x7f\x0co\xf6l\xa1;R)\x9dU\xaa\xfb`\x86\xb1\xbb\xcc>Z\xcbY_\xb0\x9c\xa9\xa0Q\x0b\xf5\x16\xebzu,\xd7O\xae\xd5\xe9\xe6\xe7\xad\xe8t\xd6\xf4\xea\xa8PX\xaf" -# pylint: enable=line-too-long +LOG_TABLE = b"\x00\x00\x01\x19\x022\x1a\xc6\x03\xdf3\xee\x1bh\xc7K\x04d\xe0\x0e4\x8d\xef\x81\x1c\xc1i\xf8\xc8\x08Lq\x05\x8ae/\xe1$\x0f!5\x93\x8e\xda\xf0\x12\x82E\x1d\xb5\xc2}j'\xf9\xb9\xc9\x9a\txM\xe4r\xa6\x06\xbf\x8bbf\xdd0\xfd\xe2\x98%\xb3\x10\x91\"\x886\xd0\x94\xce\x8f\x96\xdb\xbd\xf1\xd2\x13\\\x838F@\x1eB\xb6\xa3\xc3H~nk:(T\xfa\x85\xba=\xca^\x9b\x9f\n\x15y+N\xd4\xe5\xacs\xf3\xa7W\x07p\xc0\xf7\x8c\x80c\rgJ\xde\xed1\xc5\xfe\x18\xe3\xa5\x99w&\xb8\xb4|\x11D\x92\xd9# \x89.7?\xd1[\x95\xbc\xcf\xcd\x90\x87\x97\xb2\xdc\xfc\xbea\xf2V\xd3\xab\x14*]\x9e\x84<9SGmA\xa2\x1f-C\xd8\xb7{\xa4v\xc4\x17I\xec\x7f\x0co\xf6l\xa1;R)\x9dU\xaa\xfb`\x86\xb1\xbb\xcc>Z\xcbY_\xb0\x9c\xa9\xa0Q\x0b\xf5\x16\xebzu,\xd7O\xae\xd5\xe9\xe6\xe7\xad\xe8t\xd6\xf4\xea\xa8PX\xaf" # noqa: E501 class QRCode: """The generator class for QR code matrices""" - def __init__(self, *, qr_type=None, error_correct=L): + def __init__(self, *, qr_type: Optional[int] = None, error_correct: int = L): """Initialize an empty QR code. You can define the `qr_type` (size) of the code matrix, or have the libary auto-select the smallest match. Default `error_correct` is type L (7%), but you can select M, Q or H.""" self.type = qr_type - self.ECC = error_correct # pylint: disable=invalid-name + self.ECC = error_correct self.matrix = None self.module_count = 0 self.data_cache = None self.data_list = [] - def add_data(self, data): + def add_data(self, data: bytes) -> None: """Add more data to the QR code, must be bytestring stype""" self.data_list.append(data) datalen = sum(len(x) for x in self.data_list) if not self.type: - for qr_type in range(1, 6): + for qr_type in range(1, 10): rs_blocks = _get_rs_blocks(qr_type, self.ECC) total_data_count = 0 for block in rs_blocks: @@ -105,7 +108,7 @@ def add_data(self, data): break self.data_cache = None - def make(self, *, test=False, mask_pattern=0): + def make(self, *, test: bool = False, mask_pattern: int = 0) -> None: """Perform the actual generation of the QR matrix. To keep things small and speedy we don't generate all 8 mask patterns and pick the best. Instead, please pass in a desired mask_pattern, the @@ -127,12 +130,12 @@ def make(self, *, test=False, mask_pattern=0): self.data_cache = QRCode._create_data(self.type, self.ECC, self.data_list) self._map_data(self.data_cache, mask_pattern) - def _setup_position_probe_pattern(self, row, col): + def _setup_position_probe_pattern(self, row: int, col: int) -> None: """Add the positition probe data pixels to the matrix""" for r in range(-1, 8): if row + r <= -1 or self.module_count <= row + r: continue - for c in range(-1, 8): # pylint: disable=invalid-name + for c in range(-1, 8): if col + c <= -1 or self.module_count <= col + c: continue test = ( @@ -142,19 +145,19 @@ def _setup_position_probe_pattern(self, row, col): ) self.matrix[row + r, col + c] = test - def _setup_timing_pattern(self): + def _setup_timing_pattern(self) -> None: """Add the timing data pixels to the matrix""" for r in range(8, self.module_count - 8): if self.matrix[r, 6] is not None: continue self.matrix[r, 6] = r % 2 == 0 - for c in range(8, self.module_count - 8): # pylint: disable=invalid-name + for c in range(8, self.module_count - 8): if self.matrix[6, c] is not None: continue self.matrix[6, c] = c % 2 == 0 - def _setup_position_adjust_pattern(self): + def _setup_position_adjust_pattern(self) -> None: """Add the position adjust data pixels to the matrix""" pos = QRUtil.get_pattern_position(self.type) @@ -164,11 +167,11 @@ def _setup_position_adjust_pattern(self): continue for r in range(-2, 3): - for c in range(-2, 3): # pylint: disable=invalid-name + for c in range(-2, 3): test = abs(r) == 2 or abs(c) == 2 or (r == 0 and c == 0) self.matrix[row + r, col + c] = test - def _setup_type_number(self, test): + def _setup_type_number(self, test: bool) -> None: """Add the type number pixels to the matrix""" bits = QRUtil.get_BCH_type_number(self.type) @@ -180,7 +183,7 @@ def _setup_type_number(self, test): mod = not test and ((bits >> i) & 1) == 1 self.matrix[i % 3 + self.module_count - 8 - 3, i // 3] = mod - def _setup_type_info(self, test, mask_pattern): + def _setup_type_info(self, test: bool, mask_pattern: int) -> None: """Add the type info pixels to the matrix""" data = (self.ECC << 3) | mask_pattern bits = QRUtil.get_BCH_type_info(data) @@ -208,7 +211,7 @@ def _setup_type_info(self, test, mask_pattern): # // fixed module self.matrix[self.module_count - 8, 8] = not test - def _map_data(self, data, mask_pattern): + def _map_data(self, data: bytes, mask_pattern: int) -> None: """Map the data onto the QR code""" inc = -1 row = self.module_count - 1 @@ -217,10 +220,10 @@ def _map_data(self, data, mask_pattern): for col in range(self.module_count - 1, 0, -2): if col == 6: - col -= 1 + col -= 1 # noqa: PLW2901 loop variable overwritten while True: - for c in range(2): # pylint: disable=invalid-name + for c in range(2): if self.matrix[row, col - c] is None: dark = False if byte_idx < len(data): @@ -240,7 +243,7 @@ def _map_data(self, data, mask_pattern): break @staticmethod - def _create_data(qr_type, ecc, data_list): + def _create_data(qr_type: int, ecc: int, data_list: list) -> bytes: """Check and format data into bit buffer""" rs_blocks = _get_rs_blocks(qr_type, ecc) @@ -248,7 +251,7 @@ def _create_data(qr_type, ecc, data_list): for data in data_list: if isinstance(data, str): - data = str.encode(data) + data = str.encode(data) # noqa: PLW2901 loop variable overwritten buffer.put(_MODE_8BIT_BYTE, 4) buffer.put(len(data), 8) for byte in data: @@ -261,8 +264,7 @@ def _create_data(qr_type, ecc, data_list): if buffer.get_length_bits() > total_data_count * 8: raise RuntimeError( - "Code length overflow: %d > %d" - % (buffer.get_length_bits(), total_data_count * 8) + "Code length overflow: %d > %d" % (buffer.get_length_bits(), total_data_count * 8) ) # // end code @@ -284,10 +286,10 @@ def _create_data(qr_type, ecc, data_list): return QRCode._create_bytes(buffer, rs_blocks) - # pylint: disable=too-many-locals,too-many-branches @staticmethod - def _create_bytes(buffer, rs_blocks): + def _create_bytes(buffer: bytes, rs_blocks: List[Dict]) -> bytes: # noqa: PLR0912 Too many branches """Perform error calculation math on bit buffer""" + offset = 0 max_dc_count = 0 max_ec_count = 0 @@ -352,9 +354,6 @@ def _create_bytes(buffer, rs_blocks): return data -# pylint: enable=too-many-locals,too-many-branches - - class QRUtil: """A selection of bit manipulation tools for QR generation and BCH encoding""" @@ -375,30 +374,25 @@ class QRUtil: G18 = 0b1111100100101 G15_MASK = 0b101010000010010 - # pylint: disable=invalid-name @staticmethod - def get_BCH_type_info(data): + def get_BCH_type_info(data: int) -> int: """Encode with G15 BCH mask""" d = data << 10 while QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G15) >= 0: - d ^= QRUtil.G15 << ( - QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G15) - ) + d ^= QRUtil.G15 << (QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G15)) return ((data << 10) | d) ^ QRUtil.G15_MASK @staticmethod - def get_BCH_type_number(data): + def get_BCH_type_number(data: int) -> int: """Encode with G18 BCH mask""" d = data << 12 while QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G18) >= 0: - d ^= QRUtil.G18 << ( - QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G18) - ) + d ^= QRUtil.G18 << (QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G18)) return (data << 12) | d @staticmethod - def get_BCH_digit(data): + def get_BCH_digit(data: int) -> int: """Count digits in data""" digit = 0 while data != 0: @@ -406,16 +400,14 @@ def get_BCH_digit(data): data >>= 1 return digit - # pylint: enable=invalid-name @staticmethod - def get_pattern_position(qr_type): + def get_pattern_position(qr_type: int) -> bytes: """The mask pattern position array for this QR type""" return QRUtil.PATTERN_POSITION_TABLE[qr_type - 1] @staticmethod - def get_mask(mask, i, j): + def get_mask(mask: int, i: int, j: int) -> int: # noqa: PLR0911 Too many return statements """Perform matching calculation on two vals for given pattern mask""" - # pylint: disable=multiple-statements, too-many-return-statements if mask == 0: return (i + j) % 2 == 0 if mask == 1: @@ -433,10 +425,9 @@ def get_mask(mask, i, j): if mask == 7: return ((i * j) % 3 + (i + j) % 2) % 2 == 0 raise ValueError("Bad mask pattern:" + mask) - # pylint: enable=multiple-statements, too-many-return-statements @staticmethod - def get_error_correct_polynomial(ecc_length): + def get_error_correct_polynomial(ecc_length: int) -> "QRPolynomial": """Generate a ecc polynomial""" poly = QRPolynomial([1], 0) for i in range(ecc_length): @@ -447,7 +438,7 @@ def get_error_correct_polynomial(ecc_length): class QRPolynomial: """Structure for creating and manipulating error code polynomials""" - def __init__(self, num, shift): + def __init__(self, num: int, shift: int): """Create a QR polynomial""" if not num: raise ValueError(num.length + "/" + shift) @@ -458,21 +449,21 @@ def __init__(self, num, shift): for i in range(len(num) - offset): self.num[i] = num[i + offset] - def get(self, index): + def get(self, index: int) -> int: """The exponent at the index location""" return self.num[index] - def get_length(self): + def get_length(self) -> int: """Length of the poly""" return len(self.num) - def multiply(self, e): # pylint: disable=invalid-name + def multiply(self, other_polynomial: "QRPolynomial") -> "QRPolynomial": """Multiply two polynomials, returns a new one""" - num = [0 for x in range(self.get_length() + e.get_length() - 1)] + num = [0 for x in range(self.get_length() + other_polynomial.get_length() - 1)] for i in range(self.get_length()): - for j in range(e.get_length()): - num[i + j] ^= _gexp(_glog(self.get(i)) + _glog(e.get(j))) + for j in range(other_polynomial.get_length()): + num[i + j] ^= _gexp(_glog(self.get(i)) + _glog(other_polynomial.get(j))) return QRPolynomial(num, 0) @@ -514,10 +505,10 @@ def multiply(self, e): # pylint: disable=invalid-name b"\x02\x92t", b"\x04$\x0c\x04%\r", b"\x04$\x10\x04%\x11", -) # pylint: disable=line-too-long +) -def _get_rs_blocks(qr_type, ecc): +def _get_rs_blocks(qr_type: int, ecc: int) -> List[Dict]: rs_block = _QRRS_BLOCK_TABLE[(qr_type - 1) * 4 + ecc] length = len(rs_block) // 3 @@ -535,7 +526,7 @@ def _get_rs_blocks(qr_type, ecc): class QRBitMatrix: """A bit-packed storage class for matrices""" - def __init__(self, width, height): + def __init__(self, width: int, height: int): self.width = width self.height = height if width > 60: @@ -543,7 +534,7 @@ def __init__(self, width, height): self.buffer = [0] * self.height * 2 self.used = [0] * self.height * 2 - def __repr__(self): + def __repr__(self) -> str: b = "" for y in range(self.height): for x in range(self.width): @@ -554,7 +545,7 @@ def __repr__(self): b += "\n" return b - def __getitem__(self, key): + def __getitem__(self, key: Tuple[int, int]) -> int: x, y = key if y > self.width: raise ValueError() @@ -564,7 +555,7 @@ def __getitem__(self, key): return None return self.buffer[i] & (1 << j) - def __setitem__(self, key, value): + def __setitem__(self, key: Tuple[int, int], value: int) -> None: x, y = key if y > self.width: raise ValueError() @@ -584,24 +575,24 @@ def __init__(self): self.buffer = [] self.length = 0 - def __repr__(self): + def __repr__(self) -> str: return ".".join([str(n) for n in self.buffer]) - def get(self, index): + def get(self, index: int) -> int: """The bit value at a location""" i = index // 8 return self.buffer[i] & (1 << (7 - index % 8)) - def put(self, num, length): + def put(self, num: int, length: int) -> None: """Add a number of bits from a single integer value""" for i in range(length): self.put_bit(num & (1 << (length - i - 1))) - def get_length_bits(self): + def get_length_bits(self) -> int: """Size of bit buffer""" return self.length - def put_bit(self, bit): + def put_bit(self, bit: int) -> None: """Insert one bit at the end of the bit buffer""" i = self.length // 8 if len(self.buffer) <= i: diff --git a/docs/conf.py b/docs/conf.py index ac1713d..844f88e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -17,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -47,9 +46,7 @@ creation_year = "2018" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " ladyada" author = "ladyada" @@ -100,19 +97,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/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/miniqr_displaytest.py b/examples/miniqr_displaytest.py index bfeb8ef..fb8c8ca 100644 --- a/examples/miniqr_displaytest.py +++ b/examples/miniqr_displaytest.py @@ -3,6 +3,7 @@ import board import displayio + import adafruit_miniqr @@ -35,9 +36,7 @@ def bitmap_QR(matrix): palette[0] = 0xFFFFFF palette[1] = 0x000000 # we'll scale the QR code as big as the display can handle -scale = min( - board.DISPLAY.width // qr_bitmap.width, board.DISPLAY.height // qr_bitmap.height -) +scale = min(board.DISPLAY.width // qr_bitmap.width, board.DISPLAY.height // qr_bitmap.height) # then center it! pos_x = int(((board.DISPLAY.width / scale) - qr_bitmap.width) / 2) pos_y = int(((board.DISPLAY.height / scale) - qr_bitmap.height) / 2) @@ -45,7 +44,7 @@ def bitmap_QR(matrix): splash = displayio.Group(scale=scale) splash.append(qr_img) -board.DISPLAY.show(splash) +board.DISPLAY.root_group = splash # Hang out forever while True: diff --git a/examples/miniqr_simpletest.py b/examples/miniqr_simpletest.py index 8d4ca65..429c469 100644 --- a/examples/miniqr_simpletest.py +++ b/examples/miniqr_simpletest.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import sys + import adafruit_miniqr # For drawing filled rectangles to the console: diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..db37c83 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,99 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + +] + +[format] +line-ending = "lf" diff --git a/tests/test_example.gild b/tests/test_example.gild new file mode 100644 index 0000000..0f66b61 --- /dev/null +++ b/tests/test_example.gild @@ -0,0 +1,25 @@ +XXXXXXX.X.........XXXXXXX +X.....X.X.XX.XXXX.X.....X +X.XXX.X.X.X.XXXXX.X.XXX.X +X.XXX.X..X...XXXX.X.XXX.X +X.XXX.X.X..XXXXXX.X.XXX.X +X.....X.X.XXXX.XX.X.....X +XXXXXXX.X.X.X.X.X.XXXXXXX +........X..X...X......... +..X...XXX.XX.XXXXXXXX.XXX +.X.XX....X.X.XX..X.XXXXX. +X....XX...XXXX.XX.X....X. +..X..X.X.XX.XX.X.XX.XX.XX +...XXXX.XXXX....XXXXX..XX +.X..XX.XXX.XX.XXXXXXX.XXX +.X.XX.XX.X..X.....XX...X. +XXXXXX.....X...X.XX....XX +..XX..XXXX..XXXXXXXXX.XXX +........X.X.X.X.X...XX... +XXXXXXX.XXXXXXXXX.X.X..X. +X.....X...X.X.X.X...XX..X +X.XXX.X........XXXXXXXXX. +X.XXX.X.....XX..XXXXXX.X. +X.XXX.X.X.X...X......X... +X.....X...XXX.XX.XXX...XX +XXXXXXX..XX.XXX..XX...X.X diff --git a/tests/test_unit.py b/tests/test_unit.py new file mode 100644 index 0000000..edc7754 --- /dev/null +++ b/tests/test_unit.py @@ -0,0 +1,98 @@ +# SPDX-FileCopyrightText: 2024 James Bowman +# +# SPDX-License-Identifier: MIT + +import random +import unittest + +import adafruit_miniqr + + +def enc(msg, **args): + _q = adafruit_miniqr.QRCode(**args) + _q.add_data(msg) + _q.make() + return _q.matrix + + +class TestMiniQR(unittest.TestCase): + def test_example(self): + # Confirm the simple test that is in the docs + msg = b"https://www.adafruit.com" + _qr = adafruit_miniqr.QRCode() + _qr.add_data(msg) + _qr.make() + with open("tests/test_example.gild") as _f: + self.assertEqual(_f.read(), repr(_qr.matrix)) + + def test_qr_type(self): + # Confirm that qr_type 1-9 increases the matrix size + expected_size = [None, 21, 25, 29, 33, 37, 41, 45, 49, 53] + for _t in range(1, 10): + _m = enc(b"abc", qr_type=_t) + self.assertEqual(_m.width, _m.height) + self.assertEqual(_m.width, expected_size[_t]) + + def test_qr_error_correct(self): + # Confirm that error correct L,M,Q,H give different matrix + matrices = set() + for _ec in ( + adafruit_miniqr.L, + adafruit_miniqr.M, + adafruit_miniqr.Q, + adafruit_miniqr.H, + ): + _m = enc(b"abc", error_correct=_ec) + matrices.add(_m) + self.assertEqual(len(matrices), 4) # All 4 are unique + + def test_qr_pattern_mask(self): + # Confirm that pattern_mask 0-7 gives different matrix + matrices = set() + _qr = adafruit_miniqr.QRCode() + _qr.add_data("test_qr_pattern_mask/1Z") + for _m in range(8): + _qr.make(mask_pattern=_m) + matrices.add(tuple(_qr.matrix.buffer)) + self.assertEqual(len(matrices), 8) # All 8 are unique + + def test_qr_auto(self): + # Confirm that increasing message size increases the matrix size monotonically + sizes = [] + for i in range(29): + msg = b"aBc!1234" * i + _m = enc(msg) + sizes.append(_m.width) + self.assertTrue(len(set(sizes)) > 1) + self.assertEqual(sizes, sorted(sizes)) + + def test_qr_str(self): + # Confirm that bytes and str give the same result + for _s in ("", "abc", "https://www.adafruit.com", "AbCd12"): + _a = enc(_s.encode()) + _b = enc(_s) + self.assertEqual(_a.buffer, _b.buffer) + + def test_qr_all(self): + for _ty in range(1, 10): + for _ec in ( + adafruit_miniqr.L, + adafruit_miniqr.M, + adafruit_miniqr.Q, + adafruit_miniqr.H, + ): + _qr = adafruit_miniqr.QRCode(qr_type=_ty, error_correct=_ec) + _qr.add_data("abc") + for _m in range(8): + _qr.matrix = None + _qr.make(mask_pattern=_m) + self.assertTrue(_qr.matrix is not None) + + def test_qr_maximum(self): + msg = bytes([random.randrange(32, 127) for i in range(230)]) + _a = enc(msg) + self.assertTrue(_a is not None) + + +if __name__ == "__main__": + unittest.main()