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 f901e9c..51f9bef 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/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 EMC2101 brushless fan controller diff --git a/adafruit_emc2101/__init__.py b/adafruit_emc2101/__init__.py index d8289a4..a7e7675 100644 --- a/adafruit_emc2101/__init__.py +++ b/adafruit_emc2101/__init__.py @@ -31,16 +31,17 @@ """ -from micropython import const -from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct +import adafruit_bus_device.i2c_device as i2cdevice from adafruit_register.i2c_bit import RWBit from adafruit_register.i2c_bits import RWBits -import adafruit_bus_device.i2c_device as i2cdevice +from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct +from micropython import const from adafruit_emc2101 import emc2101_regs try: from typing import Tuple + from busio import I2C except ImportError: pass @@ -49,7 +50,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EMC2101.git" -class EMC2101: # pylint: disable=too-many-instance-attributes +class EMC2101: """Basic driver for the EMC2101 Fan Controller. :param ~busio.I2C i2c_bus: The I2C bus the EMC is connected to. @@ -189,7 +190,7 @@ def __init__(self, i2c_bus: I2C) -> None: # print("EMC2101 (part={}.{})".format(part, mfg)) if ( - not part in [emc2101_regs.PART_ID_EMC2101, emc2101_regs.PART_ID_EMC2101R] + part not in {emc2101_regs.PART_ID_EMC2101, emc2101_regs.PART_ID_EMC2101R} or mfg != emc2101_regs.MFG_ID_SMSC ): raise RuntimeError(f"No EMC2101 (part={part}.{mfg})") @@ -415,8 +416,7 @@ def spinup_time(self, spin_time: int) -> None: """ # Not importing at top level so the SpinupTime is not loaded # unless it is required, and thus 1KB bytecode can be avoided. - # pylint: disable=import-outside-toplevel - from adafruit_emc2101.emc2101_enums import SpinupTime + from adafruit_emc2101.emc2101_enums import SpinupTime # noqa: PLC0415 if not SpinupTime.is_valid(spin_time): raise TypeError("spinup_time must be a SpinupTime") @@ -448,8 +448,7 @@ def spinup_drive(self, spin_drive: int) -> None: """ # Not importing at top level so the SpinupDrive is not loaded # unless it is required, and thus 1KB bytecode can be avoided. - # pylint: disable=import-outside-toplevel - from adafruit_emc2101.emc2101_enums import SpinupDrive + from adafruit_emc2101.emc2101_enums import SpinupDrive # noqa: PLC0415 if not SpinupDrive.is_valid(spin_drive): raise TypeError("spinup_drive must be a SpinupDrive") @@ -478,8 +477,7 @@ def conversion_rate(self, rate: int) -> None: """ # Not importing at top level so the ConversionRate is not loaded # unless it is required, and thus 1KB bytecode can be avoided. - # pylint: disable=import-outside-toplevel - from adafruit_emc2101.emc2101_enums import ConversionRate + from adafruit_emc2101.emc2101_enums import ConversionRate # noqa: PLC0415 if not ConversionRate.is_valid(rate): raise ValueError("conversion_rate must be a `ConversionRate`") diff --git a/adafruit_emc2101/emc2101_enums.py b/adafruit_emc2101/emc2101_enums.py index 06ca286..6958c90 100644 --- a/adafruit_emc2101/emc2101_enums.py +++ b/adafruit_emc2101/emc2101_enums.py @@ -42,9 +42,7 @@ class CV: """struct helper""" @classmethod - def add_values( - cls, value_tuples: Iterable[Tuple[str, int, str, Optional[float]]] - ) -> None: + def add_values(cls, value_tuples: Iterable[Tuple[str, int, str, Optional[float]]]) -> None: """Creates CV entries""" cls.string = {} cls.lsb = {} diff --git a/adafruit_emc2101/emc2101_ext.py b/adafruit_emc2101/emc2101_ext.py index 9eb7aec..ee9a8f6 100644 --- a/adafruit_emc2101/emc2101_ext.py +++ b/adafruit_emc2101/emc2101_ext.py @@ -35,15 +35,15 @@ and PWM frequency control to the base feature set. """ -from adafruit_register.i2c_struct import UnaryStruct from adafruit_register.i2c_bit import RWBit from adafruit_register.i2c_bits import RWBits +from adafruit_register.i2c_struct import UnaryStruct -from adafruit_emc2101 import emc2101_regs -from adafruit_emc2101 import EMC2101 +from adafruit_emc2101 import EMC2101, emc2101_regs try: - import typing # pylint: disable=unused-import + import typing + from busio import I2C except ImportError: pass @@ -52,7 +52,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EMC2101.git" -class EMC2101_EXT(EMC2101): # pylint: disable=too-many-instance-attributes +class EMC2101_EXT(EMC2101): """Driver for EMC2101 Fan, adding definitions for all (but LUT) device registers. See :class:`adafruit_emc2101.EMC2101` for the base/common functionality. diff --git a/adafruit_emc2101/emc2101_fanspeed.py b/adafruit_emc2101/emc2101_fanspeed.py index 41d1fea..be8a32e 100644 --- a/adafruit_emc2101/emc2101_fanspeed.py +++ b/adafruit_emc2101/emc2101_fanspeed.py @@ -29,6 +29,7 @@ * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ + from types import TracebackType from typing import Optional, Type @@ -149,8 +150,7 @@ def __setitem__(self, index: int, value: int) -> None: def __repr__(self) -> str: """return the official string representation of the LUT""" - # pylint: disable=consider-using-f-string - return "FanSpeedLUT {:x}".format(id(self)) + return f"FanSpeedLUT {id(self):x}" def __str__(self) -> str: """return the official string representation of the LUT""" @@ -158,7 +158,6 @@ def __str__(self) -> str: lut_keys = tuple(sorted(self.lut_values.keys())) for temp in lut_keys: fan_drive = self.lut_values[temp] - # pylint: disable=consider-using-f-string value_strs.append("%d deg C => %.1f%% duty cycle" % (temp, fan_drive)) return "\n".join(value_strs) @@ -195,15 +194,12 @@ def _update_lut(self) -> None: # get and sort the new lut keys so that we can assign them in order for idx, current_temp in enumerate(sorted(self.lut_values.keys())): # We don't want to make `_speed_to_lsb()` public, it is only needed here. - # pylint: disable=protected-access current_speed = self.emc_fan._speed_to_lsb(self.lut_values[current_temp]) self._set_lut_entry(idx, current_temp, current_speed) # Set the remaining LUT entries to the default (Temp/Speed = max value) for idx in range(len(self.lut_values), 8): - self._set_lut_entry( - idx, emc2101_regs.MAX_LUT_TEMP, emc2101_regs.MAX_LUT_SPEED - ) + self._set_lut_entry(idx, emc2101_regs.MAX_LUT_TEMP, emc2101_regs.MAX_LUT_SPEED) self.emc_fan.lut_enabled = current_mode def _set_lut_entry(self, idx: int, temp: int, speed: int) -> None: diff --git a/adafruit_emc2101/emc2101_lut.py b/adafruit_emc2101/emc2101_lut.py index 44ad850..252e885 100644 --- a/adafruit_emc2101/emc2101_lut.py +++ b/adafruit_emc2101/emc2101_lut.py @@ -38,11 +38,12 @@ from adafruit_register.i2c_struct import UnaryStruct from adafruit_emc2101 import emc2101_regs -from adafruit_emc2101.emc2101_fanspeed import FanSpeedLUT from adafruit_emc2101.emc2101_ext import EMC2101_EXT +from adafruit_emc2101.emc2101_fanspeed import FanSpeedLUT try: - import typing # pylint: disable=unused-import + import typing + from busio import I2C except ImportError: pass @@ -51,7 +52,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EMC2101.git" -class EMC2101_LUT(EMC2101_EXT): # pylint: disable=too-many-instance-attributes +class EMC2101_LUT(EMC2101_EXT): """Driver for the EMC2101 Fan Controller, with PWM frequency and temperature look-up-table (LUT) control. @@ -81,7 +82,6 @@ def initialize(self) -> None: :raises RuntimeError: if auto_check_status and an alert status bit is set """ self.lut_enabled = True - # pylint: disable=attribute-defined-outside-init self._fan_clk_ovr = True super().initialize() self._check_status() @@ -109,9 +109,7 @@ def set_pwm_clock(self, use_preset: bool = False, use_slow: bool = False) -> Non if not isinstance(use_slow, bool): raise TypeError("use_slow_pwm must be given a bool") - # pylint: disable=attribute-defined-outside-init self._fan_clk_ovr = not use_preset - # pylint: disable=attribute-defined-outside-init self._fan_clk_sel = use_slow self._check_status() diff --git a/adafruit_emc2101/emc2101_regs.py b/adafruit_emc2101/emc2101_regs.py index e0db291..5e2fc92 100644 --- a/adafruit_emc2101/emc2101_regs.py +++ b/adafruit_emc2101/emc2101_regs.py @@ -54,12 +54,7 @@ STATUS_TACH = const(0x01) STATUS_ALERT = ( - STATUS_TACH - | STATUS_TCRIT - | STATUS_FAULT - | STATUS_EXTLOW - | STATUS_EXTHIGH - | STATUS_INTHIGH + STATUS_TACH | STATUS_TCRIT | STATUS_FAULT | STATUS_EXTLOW | STATUS_EXTHIGH | STATUS_INTHIGH ) # Bits in device configuration register for masks etc. diff --git a/docs/api.rst b/docs/api.rst index 3414142..c91029f 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_emc2101 :members: :exclude-members: CV diff --git a/docs/conf.py b/docs/conf.py index 1e0f904..112456f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -59,9 +57,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 + " Bryan Siepert" author = "Bryan Siepert" diff --git a/examples/emc2101_lut_example.py b/examples/emc2101_lut_example.py index 20630ab..e42570b 100644 --- a/examples/emc2101_lut_example.py +++ b/examples/emc2101_lut_example.py @@ -2,7 +2,9 @@ # # SPDX-License-Identifier: MIT import time + import board + from adafruit_emc2101.emc2101_lut import EMC2101_LUT as EMC2101 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/emc2101_set_pwm_freq.py b/examples/emc2101_set_pwm_freq.py index f43ed26..77cb90b 100644 --- a/examples/emc2101_set_pwm_freq.py +++ b/examples/emc2101_set_pwm_freq.py @@ -2,7 +2,9 @@ # # SPDX-License-Identifier: MIT import time + import board + from adafruit_emc2101.emc2101_lut import EMC2101_LUT as EMC2101 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/emc2101_simpletest.py b/examples/emc2101_simpletest.py index d94d883..2603d3e 100644 --- a/examples/emc2101_simpletest.py +++ b/examples/emc2101_simpletest.py @@ -2,7 +2,9 @@ # # SPDX-License-Identifier: MIT import time + import board + from adafruit_emc2101 import EMC2101 i2c = board.I2C() # uses board.SCL and board.SDA 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"