diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index c32bdea..31ded59 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PN532/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 CircuitPython driver for the `PN532 NFC/RFID Breakout `_ and `PN532 NFC/RFID Shield `_ diff --git a/adafruit_pn532/adafruit_pn532.py b/adafruit_pn532/adafruit_pn532.py index d6a8620..c809d12 100644 --- a/adafruit_pn532/adafruit_pn532.py +++ b/adafruit_pn532/adafruit_pn532.py @@ -26,16 +26,18 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ -import time import struct +import time + from digitalio import Direction from micropython import const try: from typing import Optional, Tuple, Union - from typing_extensions import Literal + from circuitpython_typing import ReadableBuffer - from digitalio import DigitalInOut # pylint: disable=ungrouped-imports + from digitalio import DigitalInOut + from typing_extensions import Literal except ImportError: pass @@ -148,8 +150,8 @@ _GPIO_P34 = const(4) _GPIO_P35 = const(5) -_ACK = b"\x00\x00\xFF\x00\xFF\x00" -_FRAME_START = b"\x00\x00\xFF" +_ACK = b"\x00\x00\xff\x00\xff\x00" +_FRAME_START = b"\x00\x00\xff" class BusyError(Exception): @@ -207,9 +209,7 @@ def reset(self) -> None: def _write_frame(self, data: bytearray) -> None: """Write a frame to the PN532 with the specified data bytearray.""" - assert ( - data is not None and 1 < len(data) < 255 - ), "Data must be array of 1 to 255 bytes." + assert data is not None and 1 < len(data) < 255, "Data must be array of 1 to 255 bytes." # Build frame to send as: # - Preamble (0x00) # - Start code (0x00, 0xFF) @@ -264,9 +264,7 @@ def _read_frame(self, length: int) -> Union[bytes, bytearray]: # Check frame checksum value matches bytes. checksum = sum(response[offset + 2 : offset + 2 + frame_len + 1]) & 0xFF if checksum != 0: - raise RuntimeError( - "Response checksum did not match expected value: ", checksum - ) + raise RuntimeError("Response checksum did not match expected value: ", checksum) # Return frame data. return response[offset + 2 : offset + 2 + frame_len] @@ -286,13 +284,9 @@ def call_function( """ if not self.send_command(command, params=params, timeout=timeout): return None - return self.process_response( - command, response_length=response_length, timeout=timeout - ) + return self.process_response(command, response_length=response_length, timeout=timeout) - def send_command( - self, command: int, params: ReadableBuffer = b"", timeout: float = 1 - ) -> bool: + def send_command(self, command: int, params: ReadableBuffer = b"", timeout: float = 1) -> bool: """Send specified command to the PN532 and wait for an acknowledgment. Will wait up to timeout seconds for the acknowledgment and return True. If no acknowledgment is received, False is returned. @@ -362,7 +356,7 @@ def firmware_version(self) -> Tuple[int, int, int, int]: raise RuntimeError("Failed to detect the PN532") return tuple(response) - def SAM_configuration(self) -> None: # pylint: disable=invalid-name + def SAM_configuration(self) -> None: """Configure the PN532 to read MiFare cards.""" # Send SAM configuration command with configuration for: # - 0x01, normal mode @@ -404,9 +398,7 @@ def listen_for_passive_target( return False # _COMMAND_INLISTPASSIVETARGET failed return response - def get_passive_target( - self, timeout: float = 1 - ) -> Optional[Union[bytes, bytearray]]: + def get_passive_target(self, timeout: float = 1) -> Optional[Union[bytes, bytearray]]: """Will wait up to timeout seconds and return None if no card is found, otherwise a bytearray with the UID of the found card is returned. `listen_for_passive_target` must have been called first in order to put @@ -430,7 +422,7 @@ def get_passive_target( # Return UID of card. return response[6 : 6 + response[5]] - def mifare_classic_authenticate_block( # pylint: disable=invalid-name + def mifare_classic_authenticate_block( self, uid: ReadableBuffer, block_number: int, @@ -454,14 +446,10 @@ def mifare_classic_authenticate_block( # pylint: disable=invalid-name params[3 : 3 + keylen] = key params[3 + keylen :] = uid # Send InDataExchange request and verify response is 0x00. - response = self.call_function( - _COMMAND_INDATAEXCHANGE, params=params, response_length=1 - ) + response = self.call_function(_COMMAND_INDATAEXCHANGE, params=params, response_length=1) return response[0] == 0x00 - def mifare_classic_read_block( - self, block_number: int - ) -> Optional[Union[bytes, bytearray]]: + def mifare_classic_read_block(self, block_number: int) -> Optional[Union[bytes, bytearray]]: """Read a block of data from the card. Block number should be the block to read. If the block is successfully read a bytearray of length 16 with data starting at the specified block will be returned. If the block is @@ -479,17 +467,13 @@ def mifare_classic_read_block( # Return first 4 bytes since 16 bytes are always returned. return response[1:] - def mifare_classic_write_block( - self, block_number: int, data: ReadableBuffer - ) -> bool: + def mifare_classic_write_block(self, block_number: int, data: ReadableBuffer) -> bool: """Write a block of data to the card. Block number should be the block to write and data should be a byte array of length 16 with the data to write. If the data is successfully written then True is returned, otherwise False is returned. """ - assert ( - data is not None and len(data) == 16 - ), "Data must be an array of 16 bytes!" + assert data is not None and len(data) == 16, "Data must be an array of 16 bytes!" # Build parameters for InDataExchange command to do MiFare classic write. params = bytearray(19) params[0] = 0x01 # Max card numbers @@ -497,9 +481,7 @@ def mifare_classic_write_block( params[2] = block_number & 0xFF params[3:] = data # Send InDataExchange request. - response = self.call_function( - _COMMAND_INDATAEXCHANGE, params=params, response_length=1 - ) + response = self.call_function(_COMMAND_INDATAEXCHANGE, params=params, response_length=1) return response[0] == 0x0 def mifare_classic_sub_value_block(self, block_number: int, amount: int) -> bool: @@ -511,9 +493,7 @@ def mifare_classic_sub_value_block(self, block_number: int, amount: int) -> bool params = [0x01, MIFARE_CMD_DECREMENT, block_number & 0xFF] params.extend(list(amount.to_bytes(4, "little"))) - response = self.call_function( - _COMMAND_INDATAEXCHANGE, params=params, response_length=1 - ) + response = self.call_function(_COMMAND_INDATAEXCHANGE, params=params, response_length=1) if response[0] != 0x00: return False @@ -534,9 +514,7 @@ def mifare_classic_add_value_block(self, block_number: int, amount: int) -> bool params = [0x01, MIFARE_CMD_INCREMENT, block_number & 0xFF] params.extend(list(amount.to_bytes(4, "little"))) - response = self.call_function( - _COMMAND_INDATAEXCHANGE, params=params, response_length=1 - ) + response = self.call_function(_COMMAND_INDATAEXCHANGE, params=params, response_length=1) if response[0] != 0x00: return False @@ -561,13 +539,11 @@ def mifare_classic_get_value_block(self, block_number: int) -> int: value_backup = block[8:12] if value != value_backup: raise RuntimeError( - "Value block bytes 0-3 do not match 8-11: " - + "".join("%02x" % b for b in block) + "Value block bytes 0-3 do not match 8-11: " + "".join("%02x" % b for b in block) ) if value_inverted != bytearray(map((lambda x: x ^ 0xFF), value)): raise RuntimeError( - "Inverted value block bytes 4-7 not valid: " - + "".join("%02x" % b for b in block) + "Inverted value block bytes 4-7 not valid: " + "".join("%02x" % b for b in block) ) return struct.unpack(" bool: params[2] = block_number & 0xFF params[3:] = data # Send InDataExchange request. - response = self.call_function( - _COMMAND_INDATAEXCHANGE, params=params, response_length=1 - ) + response = self.call_function(_COMMAND_INDATAEXCHANGE, params=params, response_length=1) return response[0] == 0x00 - def ntag2xx_read_block( - self, block_number: int - ) -> Optional[Union[bytes, bytearray]]: + def ntag2xx_read_block(self, block_number: int) -> Optional[Union[bytes, bytearray]]: """Read a block of data from the card. Block number should be the block to read. If the block is successfully read the first 4 bytes (after the leading 0x00 byte) will be returned. diff --git a/adafruit_pn532/i2c.py b/adafruit_pn532/i2c.py index 657688c..2698ed0 100644 --- a/adafruit_pn532/i2c.py +++ b/adafruit_pn532/i2c.py @@ -18,15 +18,18 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PN532.git" import time + from adafruit_bus_device import i2c_device from digitalio import Direction from micropython import const + from adafruit_pn532.adafruit_pn532 import PN532, BusyError try: from typing import Optional - from digitalio import DigitalInOut # pylint: disable=ungrouped-imports + from busio import I2C + from digitalio import DigitalInOut except ImportError: pass @@ -44,7 +47,7 @@ def __init__( irq: Optional[DigitalInOut] = None, reset: Optional[DigitalInOut] = None, req: Optional[DigitalInOut] = None, - debug: bool = False + debug: bool = False, ) -> None: """Create an instance of the PN532 class using I2C. Note that PN532 uses clock stretching. Optional IRQ pin (not used), diff --git a/adafruit_pn532/spi.py b/adafruit_pn532/spi.py index d1a8566..7ba093a 100644 --- a/adafruit_pn532/spi.py +++ b/adafruit_pn532/spi.py @@ -16,9 +16,10 @@ try: from typing import Optional + + from busio import SPI from circuitpython_typing import ReadableBuffer from digitalio import DigitalInOut - from busio import SPI except ImportError: pass @@ -26,8 +27,10 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PN532.git" import time + from adafruit_bus_device import spi_device from micropython import const + from adafruit_pn532.adafruit_pn532 import PN532 _SPI_STATREAD = const(0x02) @@ -59,7 +62,7 @@ def __init__( *, irq: Optional[DigitalInOut] = None, reset: Optional[DigitalInOut] = None, - debug: bool = False + debug: bool = False, ) -> None: """Create an instance of the PN532 class using SPI Optional IRQ pin (not used) @@ -108,7 +111,7 @@ def _wakeup(self) -> None: self._reset_pin.value = True time.sleep(0.01) with self._spi as spi: - spi.write(bytearray([0x00])) # pylint: disable=no-member + spi.write(bytearray([0x00])) time.sleep(0.01) self.low_power = False self.SAM_configuration() # Put the PN532 back in normal mode @@ -120,9 +123,7 @@ def _wait_ready(self, timeout: float = 1) -> bool: timestamp = time.monotonic() with self._spi as spi: while (time.monotonic() - timestamp) < timeout: - spi.write_readinto( - status_cmd, status_response - ) # pylint: disable=no-member + spi.write_readinto(status_cmd, status_response) if reverse_bit(status_response[1]) == 0x01: # LSB data is read in MSB return True # Not busy anymore! time.sleep(0.01) # pause a bit till we ask again @@ -137,7 +138,7 @@ def _read_data(self, count: int) -> bytearray: frame[0] = reverse_bit(_SPI_DATAREAD) with self._spi as spi: - spi.write_readinto(frame, frame) # pylint: disable=no-member + spi.write_readinto(frame, frame) for i, val in enumerate(frame): frame[i] = reverse_bit(val) # turn LSB data to MSB if self.debug: @@ -152,4 +153,4 @@ def _write_data(self, framebytes: ReadableBuffer) -> None: if self.debug: print("Writing: ", [hex(i) for i in rev_frame]) with self._spi as spi: - spi.write(bytes(rev_frame)) # pylint: disable=no-member + spi.write(bytes(rev_frame)) diff --git a/adafruit_pn532/uart.py b/adafruit_pn532/uart.py index 8f8949b..8f50cc5 100644 --- a/adafruit_pn532/uart.py +++ b/adafruit_pn532/uart.py @@ -19,13 +19,15 @@ try: from typing import Optional + + from busio import UART from circuitpython_typing import ReadableBuffer from digitalio import DigitalInOut - from busio import UART except ImportError: pass import time + from adafruit_pn532.adafruit_pn532 import PN532, BusyError diff --git a/docs/api.rst b/docs/api.rst index 164f9e8..07d7f89 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_pn532.adafruit_pn532 :members: diff --git a/docs/conf.py b/docs/conf.py index d478f6b..749badd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,13 +1,11 @@ -# -*- 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("..")) @@ -55,9 +53,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" diff --git a/examples/pn532_low_power.py b/examples/pn532_low_power.py index bac7667..7b0c1b5 100644 --- a/examples/pn532_low_power.py +++ b/examples/pn532_low_power.py @@ -10,6 +10,7 @@ """ import time + import board import busio from digitalio import DigitalInOut @@ -46,7 +47,7 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() diff --git a/examples/pn532_readwrite_mifare.py b/examples/pn532_readwrite_mifare.py index 82333e7..d47fae5 100644 --- a/examples/pn532_readwrite_mifare.py +++ b/examples/pn532_readwrite_mifare.py @@ -48,14 +48,14 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() print("Waiting for RFID/NFC card to write to!") -key = b"\xFF\xFF\xFF\xFF\xFF\xFF" +key = b"\xff\xff\xff\xff\xff\xff" while True: # Check if a card is available to read @@ -76,7 +76,7 @@ # Set 16 bytes of block to 0xFEEDBEEF data = bytearray(16) -data[0:16] = b"\xFE\xED\xBE\xEF\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" +data[0:16] = b"\xfe\xed\xbe\xef\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" # Write 16 byte block. pn532.mifare_classic_write_block(4, data) diff --git a/examples/pn532_readwrite_ntag2xx.py b/examples/pn532_readwrite_ntag2xx.py index 9755d87..f8bf8b1 100644 --- a/examples/pn532_readwrite_ntag2xx.py +++ b/examples/pn532_readwrite_ntag2xx.py @@ -44,7 +44,7 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() @@ -63,7 +63,7 @@ # Set 4 bytes of block to 0xFEEDBEEF data = bytearray(4) -data[0:4] = b"\xFE\xED\xBE\xEF" +data[0:4] = b"\xfe\xed\xbe\xef" # Write 4 byte block. pn532.ntag2xx_write_block(6, data) # Read block #6 diff --git a/examples/pn532_simplelisten.py b/examples/pn532_simplelisten.py index 35eea95..704f154 100644 --- a/examples/pn532_simplelisten.py +++ b/examples/pn532_simplelisten.py @@ -11,6 +11,7 @@ """ import time + import board import busio from digitalio import DigitalInOut @@ -50,7 +51,7 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() diff --git a/examples/pn532_simpletest.py b/examples/pn532_simpletest.py index 4308525..4a828ae 100644 --- a/examples/pn532_simpletest.py +++ b/examples/pn532_simpletest.py @@ -44,7 +44,7 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() diff --git a/examples/pn532_value_block_mifare.py b/examples/pn532_value_block_mifare.py index 201d97d..731e986 100644 --- a/examples/pn532_value_block_mifare.py +++ b/examples/pn532_value_block_mifare.py @@ -48,15 +48,15 @@ # pn532 = PN532_UART(uart, debug=False) ic, ver, rev, support = pn532.firmware_version -print("Found PN532 with firmware version: {0}.{1}".format(ver, rev)) +print(f"Found PN532 with firmware version: {ver}.{rev}") # Configure PN532 to communicate with MiFare cards pn532.SAM_configuration() print("Waiting for RFID/NFC card to write to!") -key_a = b"\xFF\xFF\xFF\xFF\xFF\xFF" -key_b = b"\xFF\xFF\xFF\xFF\xFF\xFF" +key_a = b"\xff\xff\xff\xff\xff\xff" +key_b = b"\xff\xff\xff\xff\xff\xff" while True: @@ -72,9 +72,7 @@ print("Found card with UID:", [hex(i) for i in uid]) print("Authenticating block 4 ...") -authenticated = pn532.mifare_classic_authenticate_block( - uid, 4, MIFARE_CMD_AUTH_B, key_b -) +authenticated = pn532.mifare_classic_authenticate_block(uid, 4, MIFARE_CMD_AUTH_B, key_b) if not authenticated: print("Authentication failed!") diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions +] + +[format] +line-ending = "lf"