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 82607d2..f6a5098 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BitbangIO/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 library for adding bitbang I2C and SPI to CircuitPython without the built-in bitbangio module. The interface is intended to be the same as bitbangio and therefore there is no bit order or chip diff --git a/adafruit_bitbangio.py b/adafruit_bitbangio.py index 10bf6f5..ead99c4 100644 --- a/adafruit_bitbangio.py +++ b/adafruit_bitbangio.py @@ -24,16 +24,18 @@ """ try: - from typing import List, Optional, Type - from typing_extensions import Literal from types import TracebackType - from circuitpython_typing import WriteableBuffer, ReadableBuffer + from typing import List, Optional, Type + + from circuitpython_typing import ReadableBuffer, WriteableBuffer from microcontroller import Pin + from typing_extensions import Literal except ImportError: pass # imports from time import monotonic + from digitalio import DigitalInOut __version__ = "0.0.0+auto.0" @@ -79,20 +81,15 @@ def __exit__( ) -> None: self.deinit() - # pylint: disable=no-self-use def deinit(self) -> None: """Free any hardware used by the object.""" return - # pylint: enable=no-self-use - class I2C(_BitBangIO): """Software-based implementation of the I2C protocol over GPIO pins.""" - def __init__( - self, scl: Pin, sda: Pin, *, frequency: int = 400000, timeout: float = 1 - ) -> None: + def __init__(self, scl: Pin, sda: Pin, *, frequency: int = 400000, timeout: float = 1) -> None: """Initialize bitbang (or software) based I2C. Must provide the I2C clock, and data pin numbers. """ @@ -312,9 +309,7 @@ def _read(self, address: int, length: int) -> bytearray: class SPI(_BitBangIO): """Software-based implementation of the SPI protocol over GPIO pins.""" - def __init__( - self, clock: Pin, MOSI: Optional[Pin] = None, MISO: Optional[Pin] = None - ) -> None: + def __init__(self, clock: Pin, MOSI: Optional[Pin] = None, MISO: Optional[Pin] = None) -> None: """Initialize bit bang (or software) based SPI. Must provide the SPI clock, and optionally MOSI and MISO pin numbers. If MOSI is set to None then writes will be disabled and fail with an error, likewise for MISO @@ -367,9 +362,9 @@ def configure( raise ValueError("bits must be an integer") if bits < 1 or bits > 8: raise ValueError("bits must be in the range of 1-8") - if polarity not in (0, 1): + if polarity not in {0, 1}: raise ValueError("polarity must be either 0 or 1") - if phase not in (0, 1): + if phase not in {0, 1}: raise ValueError("phase must be either 0 or 1") self._baudrate = baudrate self._polarity = polarity @@ -401,9 +396,7 @@ def _should_read(self, to_active: Literal[0, 1]) -> bool: # Data is read on the idle->active transition only when the phase is 1 return self._phase == 1 - to_active - def write( - self, buffer: ReadableBuffer, start: int = 0, end: Optional[int] = None - ) -> None: + def write(self, buffer: ReadableBuffer, start: int = 0, end: Optional[int] = None) -> None: """Write the data contained in buf. Requires the SPI being locked. If the buffer is empty, nothing happens. """ @@ -436,7 +429,6 @@ def write( # to settle. start_time = self._wait(start_time) - # pylint: disable=too-many-branches def readinto( self, buffer: WriteableBuffer, @@ -522,9 +514,7 @@ def write_readinto( for byte_position, _ in enumerate(buffer_out[out_start:out_end]): for bit_position in range(self._bits): bit_mask = 0x80 >> bit_position - bit_value = ( - buffer_out[byte_position + out_start] & 0x80 >> bit_position - ) + bit_value = buffer_out[byte_position + out_start] & 0x80 >> bit_position in_byte_position = byte_position + in_start # clock: idle, or has made an active->idle transition. if self._should_write(to_active=0): @@ -555,8 +545,6 @@ def write_readinto( # clock: wait another half period for the last transition. start_time = self._wait(start_time) - # pylint: enable=too-many-branches - @property def frequency(self) -> int: """Return the currently configured baud rate""" diff --git a/docs/api.rst b/docs/api.rst index 44d499a..2fd39e0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_bitbangio :members: diff --git a/docs/conf.py b/docs/conf.py index 42d8b80..5003267 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("..")) @@ -46,9 +44,7 @@ creation_year = "2020" 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 + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" diff --git a/examples/bitbangio_simpletest.py b/examples/bitbangio_simpletest.py index c79c7f2..a4d1536 100644 --- a/examples/bitbangio_simpletest.py +++ b/examples/bitbangio_simpletest.py @@ -9,6 +9,7 @@ import board import digitalio + import adafruit_bitbangio as bitbangio # Change these to the actual connections @@ -29,4 +30,4 @@ spi.readinto(data) spi.unlock() cs.value = 1 -print("Result is {}".format(data)) +print(f"Result is {data}") diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..1b887b1 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel +] + +[format] +line-ending = "lf" diff --git a/tests/simulated_i2c.py b/tests/simulated_i2c.py index c31a371..db484e4 100644 --- a/tests/simulated_i2c.py +++ b/tests/simulated_i2c.py @@ -2,17 +2,16 @@ # SPDX-License-Identifier: MIT """Implementation of testable I2C devices.""" -from typing import Any, Callable, Optional, Union import dataclasses import enum import signal import types -from typing_extensions import TypeAlias +from typing import Any, Callable, Optional, Union + import simulator as sim +from typing_extensions import TypeAlias -_SignalHandler: TypeAlias = Union[ - Callable[[int, Optional[types.FrameType]], Any], int, None -] +_SignalHandler: TypeAlias = Union[Callable[[int, Optional[types.FrameType]], Any], int, None] @enum.unique @@ -123,7 +122,7 @@ def _on_clock_fall(self) -> None: self._maybe_clock_stretch() # Return early unless we need to send data. - if self._state not in (State.ACK, State.ACK_DONE, State.WRITE): + if self._state not in {State.ACK, State.ACK_DONE, State.WRITE}: return if self._state == State.ACK: @@ -154,7 +153,7 @@ def _on_clock_fall(self) -> None: self._sent_bit_count += 1 def _on_clock_rise(self) -> None: - if self._state not in (State.ADDRESS, State.READ, State.WAIT_ACK): + if self._state not in {State.ADDRESS, State.READ, State.WAIT_ACK}: return bit_value = 1 if self._sda.net.level == sim.Level.HIGH else 0 if self._state == State.WAIT_ACK: diff --git a/tests/simulated_spi.py b/tests/simulated_spi.py index 8e8ad0b..65479a1 100644 --- a/tests/simulated_spi.py +++ b/tests/simulated_spi.py @@ -3,6 +3,7 @@ """Implementation of testable SPI devices.""" import dataclasses + import simulator as sim @@ -37,11 +38,9 @@ def write_bit(self) -> None: """Writes the next bit to the cipo net.""" if self._bit_position >= len(self._data): # Just write a zero - self._cipo.value(0) # pylint: disable=not-callable + self._cipo.value(0) return - self._cipo.value( - int(self._data[self._bit_position]) # pylint: disable=not-callable - ) + self._cipo.value(int(self._data[self._bit_position])) self._bit_position += 1 def _on_level_change(self, net: sim.Net) -> None: diff --git a/tests/simulator.py b/tests/simulator.py index 2837a3a..1ec3078 100644 --- a/tests/simulator.py +++ b/tests/simulator.py @@ -2,11 +2,11 @@ # SPDX-License-Identifier: MIT """Simple logic level simulator to test I2C/SPI interactions.""" -from typing import Any, Callable, List, Literal, Optional, Sequence import dataclasses import enum import functools import time +from typing import Any, Callable, List, Literal, Optional, Sequence import digitalio @@ -89,7 +89,7 @@ def change_history(self) -> Sequence[Change]: def write_vcd(self, path: str) -> None: """Writes monitored nets to the provided path as a VCD file.""" - with open(path, "wt") as vcdfile: + with open(path, "w") as vcdfile: vcdfile.write("$version pytest output $end\n") vcdfile.write("$timescale 1 us $end\n") vcdfile.write("$scope module top $end\n") @@ -116,14 +116,14 @@ def write_vcd(self, path: str) -> None: class FakePin: """Test double for a microcontroller pin used in tests.""" - IN = Mode.IN # pylint: disable=invalid-name + IN = Mode.IN OUT = Mode.OUT PULL_NONE = Pull.NONE PULL_UP = Pull.UP PULL_DOWN = Pull.DOWN def __init__(self, pin_id: str, net: Optional["Net"] = None): - self.id = pin_id # pylint: disable=invalid-name + self.id = pin_id self.mode: Optional[Mode] = None self.pull: Optional[Pull] = None self.level: Level = Level.Z @@ -157,11 +157,9 @@ def value(self, val: Optional[Literal[0, 1]] = None) -> Optional[Literal[0, 1]]: # Nothing is actively driving the line - we assume that during # testing, this is an error either in the test setup, or # something is asking for a value in an uninitialized state. - raise ValueError( - f"{self.id}: value read but nothing is driving the net." - ) + raise ValueError(f"{self.id}: value read but nothing is driving the net.") return 1 if level == Level.HIGH else 0 - if val in (0, 1): + if val in {0, 1}: if self.mode != Mode.OUT: raise ValueError(f"{self.id}: is not an output") nlevel = Level.HIGH if val else Level.LOW diff --git a/tests/test_adafruit_bitbangio_i2c.py b/tests/test_adafruit_bitbangio_i2c.py index 2d8e5df..2456d80 100644 --- a/tests/test_adafruit_bitbangio_i2c.py +++ b/tests/test_adafruit_bitbangio_i2c.py @@ -2,11 +2,12 @@ # SPDX-License-Identifier: MIT from typing import Sequence + import pytest import simulated_i2c as si2c import simulator as sim -import adafruit_bitbangio +import adafruit_bitbangio _SCL_NET = "scl" _SDA_NET = "sda" @@ -16,17 +17,11 @@ class TestBitbangI2C: def setup_method(self) -> None: sim.engine.reset() # Create nets, with a pullup by default. - scl = sim.engine.create_net( - _SCL_NET, monitor=True, default_level=sim.Level.HIGH - ) - sda = sim.engine.create_net( - _SDA_NET, monitor=True, default_level=sim.Level.HIGH - ) - # pylint: disable=attribute-defined-outside-init + scl = sim.engine.create_net(_SCL_NET, monitor=True, default_level=sim.Level.HIGH) + sda = sim.engine.create_net(_SDA_NET, monitor=True, default_level=sim.Level.HIGH) self.scl_pin = sim.FakePin("scl_pin", scl) self.sda_pin = sim.FakePin("sda_pin", sda) self.i2cbus = si2c.I2CBus(scl=scl, sda=sda) - # pylint: enable=attribute-defined-outside-init @sim.stub @pytest.mark.parametrize("addresses", [[0x42, 0x43]]) @@ -59,9 +54,7 @@ def test_write( device = si2c.Constant("target", address=0x42, bus=self.i2cbus) # Write data over the bus and verify the device received it. - with adafruit_bitbangio.I2C( - scl=self.scl_pin, sda=self.sda_pin, frequency=1000 - ) as i2c: + with adafruit_bitbangio.I2C(scl=self.scl_pin, sda=self.sda_pin, frequency=1000) as i2c: i2c.try_lock() i2c.writeto(address=0x42, buffer=data_array) i2c.unlock() @@ -75,9 +68,7 @@ def test_write_no_ack(self) -> None: # attach a device that will ack the address, but not the data. si2c.Constant("target", address=0x42, bus=self.i2cbus, ack_data=False) - with adafruit_bitbangio.I2C( - scl=self.scl_pin, sda=self.sda_pin, frequency=1000 - ) as i2c: + with adafruit_bitbangio.I2C(scl=self.scl_pin, sda=self.sda_pin, frequency=1000) as i2c: i2c.try_lock() with pytest.raises(RuntimeError) as info: i2c.writeto(address=0x42, buffer=b"\x42") @@ -92,9 +83,7 @@ def test_write_clock_stretching(self, data: str) -> None: data_array = bytearray(int(data, 2).to_bytes(datalen, byteorder="big")) # attach a device that does clock stretching, but not exceed our timeout. - device = si2c.Constant( - "target", address=0x42, bus=self.i2cbus, clock_stretch_sec=1 - ) + device = si2c.Constant("target", address=0x42, bus=self.i2cbus, clock_stretch_sec=1) with adafruit_bitbangio.I2C( scl=self.scl_pin, sda=self.sda_pin, frequency=1000, timeout=2.0 @@ -132,9 +121,7 @@ def test_readfrom(self, count: int, data: str) -> None: si2c.Constant("target", address=0x42, bus=self.i2cbus, data_to_send=value) # Confirm we were able to read back the data - with adafruit_bitbangio.I2C( - scl=self.scl_pin, sda=self.sda_pin, frequency=1000 - ) as i2c: + with adafruit_bitbangio.I2C(scl=self.scl_pin, sda=self.sda_pin, frequency=1000) as i2c: i2c.try_lock() i2c.readfrom_into(address=0x42, buffer=data_array) i2c.unlock() @@ -168,18 +155,12 @@ def test_writeto_readfrom(self, send_data: str, expect_data: str) -> None: data_array = bytearray(1) # attach a device that sends a constant byte of data. - device = si2c.Constant( - "target", address=0x42, bus=self.i2cbus, data_to_send=expect_value - ) + device = si2c.Constant("target", address=0x42, bus=self.i2cbus, data_to_send=expect_value) # Send the send_data, and check we got back expect_data - with adafruit_bitbangio.I2C( - scl=self.scl_pin, sda=self.sda_pin, frequency=1000 - ) as i2c: + with adafruit_bitbangio.I2C(scl=self.scl_pin, sda=self.sda_pin, frequency=1000) as i2c: i2c.try_lock() - i2c.writeto_then_readfrom( - address=0x42, buffer_out=send_array, buffer_in=data_array - ) + i2c.writeto_then_readfrom(address=0x42, buffer_out=send_array, buffer_in=data_array) i2c.unlock() # Useful to debug signals in pulseview. diff --git a/tests/test_adafruit_bitbangio_spi.py b/tests/test_adafruit_bitbangio_spi.py index 4da63f3..0a981f5 100644 --- a/tests/test_adafruit_bitbangio_spi.py +++ b/tests/test_adafruit_bitbangio_spi.py @@ -2,11 +2,12 @@ # SPDX-License-Identifier: MIT from typing import Literal, Sequence + import pytest import simulated_spi as sspi import simulator as sim -import adafruit_bitbangio +import adafruit_bitbangio _CLOCK_NET = "clock" _COPI_NET = "copi" @@ -39,9 +40,7 @@ def _check_write( last_clock_state = sim.Level.Z last_copi_state = sim.Level.Z last_copi_us = 0 - idle, active = ( - (sim.Level.HIGH, sim.Level.LOW) if polarity else (sim.Level.LOW, sim.Level.HIGH) - ) + idle, active = (sim.Level.HIGH, sim.Level.LOW) if polarity else (sim.Level.LOW, sim.Level.HIGH) bits_read = 0 # We want data to be written at least this long before a read # transition. @@ -88,18 +87,16 @@ def setup_method(self) -> None: copi = sim.engine.create_net(_COPI_NET, monitor=True) cipo = sim.engine.create_net(_CIPO_NET, monitor=True) enable = sim.engine.create_net(_ENABLE_NET, monitor=True) - # pylint: disable=attribute-defined-outside-init self.clock_pin = sim.FakePin("clock_pin", clock) self.copi_pin = sim.FakePin("copi_pin", copi) self.cipo_pin = sim.FakePin("cipo_pin", cipo) self.enable_pin = sim.FakePin("enable_pin", enable) self.enable_pin.init(mode=sim.Mode.OUT) self.spibus = sspi.SpiBus(clock=clock, copi=copi, cipo=cipo, enable=enable) - # pylint: enable=attribute-defined-outside-init self._enable_net(0) def _enable_net(self, val: Literal[0, 1]) -> None: - self.enable_pin.value(val) # pylint: disable=not-callable + self.enable_pin.value(val) @sim.stub @pytest.mark.parametrize("baud", [100]) @@ -139,9 +136,7 @@ def test_readinto( data_int = int(data, 2) data_array = bytearray(data_int.to_bytes(1, byteorder="big")) # attach a device that sends a constant. - _ = sspi.Constant( - data=data_array, bus=self.spibus, polarity=polarity, phase=phase - ) + _ = sspi.Constant(data=data_array, bus=self.spibus, polarity=polarity, phase=phase) # Read/write a byte of data with adafruit_bitbangio.SPI( @@ -181,9 +176,7 @@ def test_write_readinto( nbytes = len(data) // 8 data_array = bytearray(int(data, 2).to_bytes(nbytes, byteorder="big")) # attach a device that sends a constant. - _ = sspi.Constant( - data=data_array, bus=self.spibus, polarity=polarity, phase=phase - ) + _ = sspi.Constant(data=data_array, bus=self.spibus, polarity=polarity, phase=phase) # Read/write data array with adafruit_bitbangio.SPI(