From 2c0dd7f2d79ab44373276670274f4b2013db52d1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 17:22:19 +0000 Subject: [PATCH] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ------------------------- README.rst | 6 +- adafruit_ads1x15/ads1015.py | 6 +- adafruit_ads1x15/ads1115.py | 6 +- adafruit_ads1x15/ads1x15.py | 52 +--- adafruit_ads1x15/analog_in.py | 9 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/ads1x15_ads1115_simpletest.py | 4 +- examples/ads1x15_comparator_example.py | 3 +- examples/ads1x15_fast_read.py | 18 +- examples/ads1x15_gain_example.py | 5 +- examples/ads1x15_simpletest.py | 4 +- ruff.toml | 105 +++++++ 16 files changed, 179 insertions(+), 503 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml 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 874bf5f..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: v3.2.6 + - 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 551ba6b..1e11321 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15/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 Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015) and 16-bit (ADS1115) versions. diff --git a/adafruit_ads1x15/ads1015.py b/adafruit_ads1x15/ads1015.py index 9ec537a..666735e 100644 --- a/adafruit_ads1x15/ads1015.py +++ b/adafruit_ads1x15/ads1015.py @@ -10,6 +10,7 @@ * Author(s): Carter Nelson """ + import struct try: @@ -19,7 +20,6 @@ except ImportError: pass -# pylint: disable=unused-import from .ads1x15 import ADS1x15 # Data sample rates @@ -64,10 +64,10 @@ def rate_config(self) -> Dict[int, int]: """Rate configuration masks.""" return _ADS1015_CONFIG_DR - def _data_rate_default(self) -> Literal[1600]: + def _data_rate_default(self) -> Literal[1600]: # noqa: PLR6301 """Default data rate setting is 1600 samples per second""" return 1600 - def _conversion_value(self, raw_adc: int) -> int: + def _conversion_value(self, raw_adc: int) -> int: # noqa: PLR6301 value = struct.unpack(">h", raw_adc.to_bytes(2, "big"))[0] return value diff --git a/adafruit_ads1x15/ads1115.py b/adafruit_ads1x15/ads1115.py index 2d23b99..0933f24 100644 --- a/adafruit_ads1x15/ads1115.py +++ b/adafruit_ads1x15/ads1115.py @@ -10,6 +10,7 @@ * Author(s): Carter Nelson """ + import struct try: @@ -19,7 +20,6 @@ except ImportError: pass -# pylint: disable=unused-import from .ads1x15 import ADS1x15 # Data sample rates @@ -65,10 +65,10 @@ def rate_config(self) -> Dict[int, int]: """Rate configuration masks.""" return _ADS1115_CONFIG_DR - def _data_rate_default(self) -> Literal[128]: + def _data_rate_default(self) -> Literal[128]: # noqa: PLR6301 """Default data rate setting is 128 samples per second""" return 128 - def _conversion_value(self, raw_adc: int) -> int: + def _conversion_value(self, raw_adc: int) -> int: # noqa: PLR6301 value = struct.unpack(">h", raw_adc.to_bytes(2, "big"))[0] return value diff --git a/adafruit_ads1x15/ads1x15.py b/adafruit_ads1x15/ads1x15.py index 7bee3fd..573b9e7 100644 --- a/adafruit_ads1x15/ads1x15.py +++ b/adafruit_ads1x15/ads1x15.py @@ -59,7 +59,6 @@ class Mode: # See datasheet "Operating Modes" section # values here are masks for setting MODE bit in Config Register - # pylint: disable=too-few-public-methods CONTINUOUS = 0x0000 """Continuous Mode""" SINGLE = 0x0100 @@ -71,7 +70,6 @@ class Comp_Mode: # See datasheet "Operating Modes" section # values here are masks for setting COMP_MODE bit in Config Register - # pylint: disable=too-few-public-methods TRADITIONAL = 0x0000 """Traditional Compartor Mode activates above high threshold, de-activates below low""" WINDOW = 0x0010 @@ -83,7 +81,6 @@ class Comp_Polarity: # See datasheet "Operating Modes" section # values here are masks for setting COMP_POL bit in Config Register - # pylint: disable=too-few-public-methods ACTIVE_LOW = 0x0000 """ALERT_RDY pin is LOW when comparator is active""" ACTIVE_HIGH = 0x0008 @@ -95,7 +92,6 @@ class Comp_Latch: # See datasheet "Operating Modes" section # values here are masks for setting COMP_LAT bit in Config Register - # pylint: disable=too-few-public-methods NONLATCHING = 0x0000 """ALERT_RDY pin does not latch when asserted""" LATCHING = 0x0004 @@ -129,7 +125,6 @@ class ADS1x15: :param int address: The I2C address of the device. """ - # pylint: disable=too-many-instance-attributes def __init__( self, i2c: I2C, @@ -144,12 +139,9 @@ def __init__( comparator_latch: int = Comp_Latch.NONLATCHING, address: int = _ADS1X15_DEFAULT_ADDRESS, ): - # pylint: disable=too-many-arguments self._last_pin_read = None self.buf = bytearray(3) - self.initialized = ( - False # Prevents writing to ADC until all values are initialized - ) + self.initialized = False # Prevents writing to ADC until all values are initialized self.i2c_device = I2CDevice(i2c, address) self.gain = gain self.data_rate = self._data_rate_default() if data_rate is None else data_rate @@ -177,7 +169,7 @@ def data_rate(self) -> int: def data_rate(self, rate: int) -> None: possible_rates = self.rates if rate not in possible_rates: - raise ValueError("Data rate must be one of: {}".format(possible_rates)) + raise ValueError(f"Data rate must be one of: {possible_rates}") self._data_rate = rate if self.initialized: self._write_config() @@ -201,7 +193,7 @@ def gain(self) -> float: def gain(self, gain: float) -> None: possible_gains = self.gains if gain not in possible_gains: - raise ValueError("Gain must be one of: {}".format(possible_gains)) + raise ValueError(f"Gain must be one of: {possible_gains}") self._gain = gain if self.initialized: self._write_config() @@ -222,11 +214,7 @@ def comparator_queue_length(self) -> int: def comparator_queue_length(self, comparator_queue_length: int) -> None: possible_comp_queue_lengths = self.comparator_queue_lengths if comparator_queue_length not in possible_comp_queue_lengths: - raise ValueError( - "Comparator Queue must be one of: {}".format( - possible_comp_queue_lengths - ) - ) + raise ValueError(f"Comparator Queue must be one of: {possible_comp_queue_lengths}") self._comparator_queue_length = comparator_queue_length if self.initialized: self._write_config() @@ -255,9 +243,7 @@ def comparator_low_threshold(self, value: int) -> None: :param int value: 16-bit signed integer to write to register """ if value < -32768 or value > 32767: - raise ValueError( - "Comparator Threshold value must be between -32768 and 32767" - ) + raise ValueError("Comparator Threshold value must be between -32768 and 32767") self._comparator_low_threshold = value self._write_register(_ADS1X15_POINTER_LO_THRES, self.comparator_low_threshold) @@ -269,9 +255,7 @@ def comparator_high_threshold(self, value: int) -> None: :param int value: 16-bit signed integer to write to register """ if value < -32768 or value > 32767: - raise ValueError( - "Comparator Threshold value must be between -32768 and 32767" - ) + raise ValueError("Comparator Threshold value must be between -32768 and 32767") self._comparator_high_threshold = value self._write_register(_ADS1X15_POINTER_HI_THRES, self.comparator_high_threshold) @@ -283,7 +267,7 @@ def mode(self) -> int: @mode.setter def mode(self, mode: int) -> None: - if mode not in (Mode.CONTINUOUS, Mode.SINGLE): + if mode not in {Mode.CONTINUOUS, Mode.SINGLE}: raise ValueError("Unsupported mode.") self._mode = mode if self.initialized: @@ -296,7 +280,7 @@ def comparator_mode(self) -> int: @comparator_mode.setter def comparator_mode(self, comp_mode: int) -> None: - if comp_mode not in (Comp_Mode.TRADITIONAL, Comp_Mode.WINDOW): + if comp_mode not in {Comp_Mode.TRADITIONAL, Comp_Mode.WINDOW}: raise ValueError("Unsupported mode.") self._comparator_mode = comp_mode if self.initialized: @@ -309,7 +293,7 @@ def comparator_polarity(self) -> int: @comparator_polarity.setter def comparator_polarity(self, comp_pol: int) -> None: - if comp_pol not in (Comp_Polarity.ACTIVE_LOW, Comp_Polarity.ACTIVE_HIGH): + if comp_pol not in {Comp_Polarity.ACTIVE_LOW, Comp_Polarity.ACTIVE_HIGH}: raise ValueError("Unsupported mode.") self._comparator_polarity = comp_pol if self.initialized: @@ -322,7 +306,7 @@ def comparator_latch(self) -> int: @comparator_latch.setter def comparator_latch(self, comp_latch: int) -> None: - if comp_latch not in (Comp_Latch.NONLATCHING, Comp_Latch.LATCHING): + if comp_latch not in {Comp_Latch.NONLATCHING, Comp_Latch.LATCHING}: raise ValueError("Unsupported mode.") self._comparator_latch = comp_latch if self.initialized: @@ -439,14 +423,10 @@ def _read_config(self) -> None: config_value = self._read_register(_ADS1X15_POINTER_CONFIG) self.gain = next( - key - for key, value in _ADS1X15_CONFIG_GAIN.items() - if value == (config_value & 0x0E00) + key for key, value in _ADS1X15_CONFIG_GAIN.items() if value == (config_value & 0x0E00) ) self.data_rate = next( - key - for key, value in self.rate_config.items() - if value == (config_value & 0x00E0) + key for key, value in self.rate_config.items() if value == (config_value & 0x00E0) ) self.comparator_queue_length = next( key @@ -454,13 +434,9 @@ def _read_config(self) -> None: if value == (config_value & 0x0003) ) self.mode = Mode.SINGLE if config_value & 0x0100 else Mode.CONTINUOUS - self.comparator_mode = ( - Comp_Mode.WINDOW if config_value & 0x0010 else Comp_Mode.TRADITIONAL - ) + self.comparator_mode = Comp_Mode.WINDOW if config_value & 0x0010 else Comp_Mode.TRADITIONAL self.comparator_polarity = ( - Comp_Polarity.ACTIVE_HIGH - if config_value & 0x0008 - else Comp_Polarity.ACTIVE_LOW + Comp_Polarity.ACTIVE_HIGH if config_value & 0x0008 else Comp_Polarity.ACTIVE_LOW ) self.comparator_latch = ( Comp_Latch.LATCHING if config_value & 0x0004 else Comp_Latch.NONLATCHING diff --git a/adafruit_ads1x15/analog_in.py b/adafruit_ads1x15/analog_in.py index 510151d..518a523 100644 --- a/adafruit_ads1x15/analog_in.py +++ b/adafruit_ads1x15/analog_in.py @@ -13,6 +13,7 @@ try: from typing import Optional + from .ads1x15 import ADS1x15 except ImportError: pass @@ -29,9 +30,7 @@ class AnalogIn: :param int negative_pin: Optional pin for differential reads. """ - def __init__( - self, ads: ADS1x15, positive_pin: int, negative_pin: Optional[int] = None - ): + def __init__(self, ads: ADS1x15, positive_pin: int, negative_pin: Optional[int] = None): self._ads = ads self._pin_setting = positive_pin self._negative_pin = negative_pin @@ -40,9 +39,7 @@ def __init__( pins = (self._pin_setting, self._negative_pin) if pins not in _ADS1X15_DIFF_CHANNELS: raise ValueError( - "Differential channels must be one of: {}".format( - list(_ADS1X15_DIFF_CHANNELS.keys()) - ) + f"Differential channels must be one of: {list(_ADS1X15_DIFF_CHANNELS.keys())}" ) self._pin_setting = _ADS1X15_DIFF_CHANNELS[pins] self.is_differential = True diff --git a/docs/api.rst b/docs/api.rst index eb0bde4..f05cd7d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,6 +1,9 @@ .. If you created a package, create one automodule per module in the package. +API Reference +############# + .. automodule:: adafruit_ads1x15.ads1x15 :members: diff --git a/docs/conf.py b/docs/conf.py index eab4493..2eff199 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("..")) @@ -48,9 +46,7 @@ creation_year = "2017" 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 + " Carter Nelson" author = "Carter Nelson" diff --git a/examples/ads1x15_ads1115_simpletest.py b/examples/ads1x15_ads1115_simpletest.py index 7f6bbd6..6ebe7d5 100644 --- a/examples/ads1x15_ads1115_simpletest.py +++ b/examples/ads1x15_ads1115_simpletest.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board import busio + import adafruit_ads1x15.ads1115 as ADS from adafruit_ads1x15.analog_in import AnalogIn @@ -24,5 +26,5 @@ print("{:>5}\t{:>5}".format("raw", "v")) while True: - print("{:>5}\t{:>5.3f}".format(chan.value, chan.voltage)) + print(f"{chan.value:>5}\t{chan.voltage:>5.3f}") time.sleep(0.5) diff --git a/examples/ads1x15_comparator_example.py b/examples/ads1x15_comparator_example.py index 52dc1f4..03cdaea 100644 --- a/examples/ads1x15_comparator_example.py +++ b/examples/ads1x15_comparator_example.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import time + import board import busio import countio @@ -9,7 +10,7 @@ import adafruit_ads1x15.ads1015 as ADS # import adafruit_ads1x15.ads1115 as ADS -from adafruit_ads1x15.ads1x15 import Mode, Comp_Mode, Comp_Polarity, Comp_Latch +from adafruit_ads1x15.ads1x15 import Comp_Latch, Comp_Mode, Comp_Polarity, Mode from adafruit_ads1x15.analog_in import AnalogIn # Create the I2C bus diff --git a/examples/ads1x15_fast_read.py b/examples/ads1x15_fast_read.py index 3caf0df..af04072 100644 --- a/examples/ads1x15_fast_read.py +++ b/examples/ads1x15_fast_read.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board import busio + import adafruit_ads1x15.ads1015 as ADS from adafruit_ads1x15.ads1x15 import Mode from adafruit_ads1x15.analog_in import AnalogIn @@ -70,15 +72,15 @@ # NOTE: leave input floating to pickup some random noise # This cannot estimate conversion rates higher than polling rate -print("Took {:5.3f} s to acquire {:d} samples.".format(total_time, SAMPLES)) +print(f"Took {total_time:5.3f} s to acquire {SAMPLES:d} samples.") print("") print("Configured:") -print(" Requested = {:5d} sps".format(RATE)) -print(" Reported = {:5d} sps".format(ads.data_rate)) +print(f" Requested = {RATE:5d} sps") +print(f" Reported = {ads.data_rate:5d} sps") print("") print("Actual:") -print(" Polling Rate = {:8.2f} sps".format(rate_reported)) -print(" {:9.2%}".format(rate_reported / RATE)) -print(" Skipped = {:5d}".format(skips)) -print(" Repeats = {:5d}".format(repeats)) -print(" Conversion Rate = {:8.2f} sps (estimated)".format(rate_actual)) +print(f" Polling Rate = {rate_reported:8.2f} sps") +print(f" {rate_reported / RATE:9.2%}") +print(f" Skipped = {skips:5d}") +print(f" Repeats = {repeats:5d}") +print(f" Conversion Rate = {rate_actual:8.2f} sps (estimated)") diff --git a/examples/ads1x15_gain_example.py b/examples/ads1x15_gain_example.py index 420f948..9acf8d0 100644 --- a/examples/ads1x15_gain_example.py +++ b/examples/ads1x15_gain_example.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import time + import board import busio @@ -36,9 +37,9 @@ while True: ads.gain = gains[0] - print("{:5} {:5.3f}".format(chan.value, chan.voltage), end="") + print(f"{chan.value:5} {chan.voltage:5.3f}", end="") for gain in gains[1:]: ads.gain = gain - print(" | {:5} {:5.3f}".format(chan.value, chan.voltage), end="") + print(f" | {chan.value:5} {chan.voltage:5.3f}", end="") print() time.sleep(0.5) diff --git a/examples/ads1x15_simpletest.py b/examples/ads1x15_simpletest.py index 0afea2c..041d978 100644 --- a/examples/ads1x15_simpletest.py +++ b/examples/ads1x15_simpletest.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board import busio + import adafruit_ads1x15.ads1015 as ADS from adafruit_ads1x15.analog_in import AnalogIn @@ -22,5 +24,5 @@ print("{:>5}\t{:>5}".format("raw", "v")) while True: - print("{:>5}\t{:>5.3f}".format(chan.value, chan.voltage)) + print(f"{chan.value:>5}\t{chan.voltage:>5.3f}") time.sleep(0.5) 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"