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 c97e574..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,46 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense -default_language_version: - # force all unspecified python hooks to run python3.11 - python: python3.11 - 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: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 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: 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 e84c7bc..a6803ea 100644 --- a/README.rst +++ b/README.rst @@ -12,9 +12,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_WM8960/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 WM8960 Stereo CODEC diff --git a/adafruit_wm8960/__init__.py b/adafruit_wm8960/__init__.py index 87540a0..3f8951f 100644 --- a/adafruit_wm8960/__init__.py +++ b/adafruit_wm8960/__init__.py @@ -24,15 +24,12 @@ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_WM8960.git" -from busio import I2C from adafruit_simplemath import constrain, map_range +from busio import I2C from .advanced import * -# pylint: disable=too-few-public-methods - - class Input: """An enum-like class representing the input options of the WM8960. Used for :attr:`WM8960.input`. @@ -57,9 +54,6 @@ class Input: """Connect input 3 as a line input.""" -# pylint: enable=too-few-public-methods - - class WM8960: """Driver for controlling the WM8960 audio codec over an I2C connection. Used for receiving line and microphone input through the ADC over I2S, monitoring analog input to the output mixer, and @@ -161,9 +155,7 @@ def gain(self, value: float) -> None: mic = bool(self._input & 0b001) self._codec.mic_volume = ( - map_range(value, 0.0, 1.0, MIC_GAIN_MIN, MIC_GAIN_MAX) - if mic - else MIC_GAIN_MIN + map_range(value, 0.0, 1.0, MIC_GAIN_MIN, MIC_GAIN_MAX) if mic else MIC_GAIN_MIN ) self._codec.input2_boost = ( @@ -215,9 +207,7 @@ def loopback(self) -> bool: :default: `False` """ - return ( - self._codec.master_mode and self._codec.gpio_output and self._codec.loopback - ) + return self._codec.master_mode and self._codec.gpio_output and self._codec.loopback @loopback.setter def loopback(self, value: bool) -> None: @@ -236,9 +226,7 @@ def volume(self) -> float: """ if self._codec.dac_mute: return 0.0 - return map_range( - self._codec.dac_volume, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 0.0, 1.0 - ) + return map_range(self._codec.dac_volume, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 0.0, 1.0) @volume.setter def volume(self, value: float) -> None: @@ -246,9 +234,7 @@ def volume(self, value: float) -> None: self._codec.dac_mute = True elif self._codec.dac_mute: self._codec.dac_mute = False - self._codec.dac_volume = map_range( - value, 0.0, 1.0, DAC_VOLUME_MIN, DAC_VOLUME_MAX - ) + self._codec.dac_volume = map_range(value, 0.0, 1.0, DAC_VOLUME_MIN, DAC_VOLUME_MAX) @property def headphone(self) -> float: @@ -285,9 +271,7 @@ def speaker(self) -> float: """ if not self._codec.speaker: return 0.0 - return map_range( - self._codec.speaker_volume, AMP_VOLUME_MIN, AMP_VOLUME_MAX, 0.0, 1.0 - ) + return map_range(self._codec.speaker_volume, AMP_VOLUME_MIN, AMP_VOLUME_MAX, 0.0, 1.0) @speaker.setter def speaker(self, value: float) -> None: @@ -295,9 +279,7 @@ def speaker(self, value: float) -> None: self._codec.speaker = False elif not self._codec.speaker: self._codec.speaker = True - self._codec.speaker_volume = map_range( - value, 0.0, 1.0, AMP_VOLUME_MIN, AMP_VOLUME_MAX - ) + self._codec.speaker_volume = map_range(value, 0.0, 1.0, AMP_VOLUME_MIN, AMP_VOLUME_MAX) # 3D Enhance @@ -347,12 +329,8 @@ def alc_gain(self) -> tuple: """ return ( map_range(self._codec.alc_target, ALC_TARGET_MIN, ALC_TARGET_MAX, 0.0, 1.0), - map_range( - self._codec.alc_max_gain, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX, 0.0, 1.0 - ), - map_range( - self._codec.alc_min_gain, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX, 0.0, 1.0 - ), + map_range(self._codec.alc_max_gain, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX, 0.0, 1.0), + map_range(self._codec.alc_min_gain, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX, 0.0, 1.0), ( map_range( self._codec.noise_gate_threshold, @@ -371,17 +349,11 @@ def alc_gain(self, value: tuple) -> None: if len(value) < 4: raise ValueError("Invalid tuple object") - self._codec.alc_target = map_range( - value[0], 0.0, 1.0, ALC_TARGET_MIN, ALC_TARGET_MAX - ) + self._codec.alc_target = map_range(value[0], 0.0, 1.0, ALC_TARGET_MIN, ALC_TARGET_MAX) - self._codec.alc_max_gain = map_range( - value[1], 0.0, 1.0, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX - ) + self._codec.alc_max_gain = map_range(value[1], 0.0, 1.0, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX) - self._codec.alc_min_gain = map_range( - value[2], 0.0, 1.0, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX - ) + self._codec.alc_min_gain = map_range(value[2], 0.0, 1.0, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX) if value[3] <= 0.0: self._codec.noise_gate = False diff --git a/adafruit_wm8960/advanced.py b/adafruit_wm8960/advanced.py index 92a3205..e78d3f8 100644 --- a/adafruit_wm8960/advanced.py +++ b/adafruit_wm8960/advanced.py @@ -25,16 +25,16 @@ # * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ -# pylint: disable=too-many-lines - import math -from busio import I2C + from adafruit_bus_device.i2c_device import I2CDevice from adafruit_simplemath import constrain, map_range +from busio import I2C from micropython import const try: from typing import Optional, Type + from circuitpython_typing.device_drivers import I2CDeviceDriver except ImportError: pass @@ -253,9 +253,6 @@ """ -# pylint: disable=too-few-public-methods - - class Mic_Input: """An enum-like class representing the microphone amplifier (PGA) input modes. Used for the attributes :attr:`WM8960_Advanced.left_mic_input`, :attr:`WM8960_Advanced.right_mic_input`, and @@ -292,9 +289,6 @@ class Mic_Input: _SPEAKER_BOOST_GAIN = [0.0, 2.1, 2.9, 3.6, 4.5, 5.1] # in dB -# pylint: disable=too-few-public-methods - - class Vmid_Mode: """An enum-like class representing possible Vmid reference voltage modes used in conjunction with the attribute :attr:`WM8960_Advanced.vmid`. @@ -392,9 +386,6 @@ class Vmid_Mode: ] -# pylint: disable=protected-access,missing-class-docstring,missing-function-docstring - - class WOBit: def __init__( self, @@ -426,7 +417,7 @@ def __set__(self, obj: Optional[I2CDeviceDriver], value: bool) -> None: class WOBits: - def __init__( # pylint: disable=too-many-arguments + def __init__( self, num_bits: int, register_address: int, @@ -466,10 +457,7 @@ def __set__(self, obj: Optional[I2CDeviceDriver], value: int) -> None: i2c.write(obj._registers[self.register_address]) -# pylint: enable=protected-access,missing-class-docstring,missing-function-docstring - - -class WM8960_Advanced: # pylint: disable=too-many-instance-attributes,too-many-public-methods +class WM8960_Advanced: """Driver for interacting directly with a WM8960 audio codec to control analog and digital audio pathways over an I2C connection.""" @@ -705,9 +693,9 @@ def mic_boost_gain(self) -> float: @mic_boost_gain.setter def mic_boost_gain(self, value: float) -> None: - self._left_mic_boost_gain = ( - self._right_mic_boost_gain - ) = WM8960_Advanced._get_mic_boost_gain(value) + self._left_mic_boost_gain = self._right_mic_boost_gain = ( + WM8960_Advanced._get_mic_boost_gain(value) + ) ## Volume @@ -729,9 +717,7 @@ def left_mic_volume(self) -> float: @left_mic_volume.setter def left_mic_volume(self, value: float) -> None: - self._left_mic_volume = round( - map_range(value, MIC_GAIN_MIN, MIC_GAIN_MAX, 0, 63) - ) + self._left_mic_volume = round(map_range(value, MIC_GAIN_MIN, MIC_GAIN_MAX, 0, 63)) self._left_mic_volume_set = True @property @@ -746,9 +732,7 @@ def right_mic_volume(self) -> float: @right_mic_volume.setter def right_mic_volume(self, value: float) -> None: - self._right_mic_volume = round( - map_range(value, MIC_GAIN_MIN, MIC_GAIN_MAX, 0, 63) - ) + self._right_mic_volume = round(map_range(value, MIC_GAIN_MIN, MIC_GAIN_MAX, 0, 63)) self._right_mic_volume_set = True @property @@ -900,11 +884,7 @@ def input2_boost(self) -> float: :default: `None` """ value = max(self._left_input2_boost, self._right_input2_boost) - return ( - None - if value == 0 - else map_range(value, 1, 7, BOOST_GAIN_MIN, BOOST_GAIN_MAX) - ) + return None if value == 0 else map_range(value, 1, 7, BOOST_GAIN_MIN, BOOST_GAIN_MAX) @input2_boost.setter def input2_boost(self, value: float) -> None: @@ -972,11 +952,7 @@ def input3_boost(self) -> float: :default: `None` """ value = max(self._left_input3_boost, self._right_input3_boost) - return ( - None - if value == 0 - else map_range(value, 1, 7, BOOST_GAIN_MIN, BOOST_GAIN_MAX) - ) + return None if value == 0 else map_range(value, 1, 7, BOOST_GAIN_MIN, BOOST_GAIN_MAX) @input3_boost.setter def input3_boost(self, value: float) -> None: @@ -1145,9 +1121,7 @@ def alc_target(self) -> float: @alc_target.setter def alc_target(self, value: float) -> None: - self._alc_target = round( - map_range(value, ALC_TARGET_MIN, ALC_TARGET_MAX, 0, 15) - ) + self._alc_target = round(map_range(value, ALC_TARGET_MIN, ALC_TARGET_MAX, 0, 15)) _alc_max_gain: int = WOBits(3, _REG_ALC1, 4) @@ -1163,9 +1137,7 @@ def alc_max_gain(self) -> float: @alc_max_gain.setter def alc_max_gain(self, value: float) -> None: - self._alc_max_gain = round( - map_range(value, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX, 0, 7) - ) + self._alc_max_gain = round(map_range(value, ALC_MAX_GAIN_MIN, ALC_MAX_GAIN_MAX, 0, 7)) _alc_min_gain: int = WOBits(3, _REG_ALC2, 4) @@ -1181,9 +1153,7 @@ def alc_min_gain(self) -> float: @alc_min_gain.setter def alc_min_gain(self, value: float) -> None: - self._alc_min_gain = round( - map_range(value, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX, 0, 7) - ) + self._alc_min_gain = round(map_range(value, ALC_MIN_GAIN_MIN, ALC_MIN_GAIN_MAX, 0, 7)) _alc_hold: int = WOBits(4, _REG_ALC2, 0) @@ -1207,10 +1177,7 @@ def alc_hold_time(self, value: float) -> None: self._alc_hold = ( round( math.log( - ( - constrain(value, ALC_HOLD_TIME_MIN, ALC_HOLD_TIME_MAX) - - ALC_HOLD_TIME_MIN - ) + (constrain(value, ALC_HOLD_TIME_MIN, ALC_HOLD_TIME_MAX) - ALC_HOLD_TIME_MIN) / ALC_HOLD_TIME_MIN, 2.0, ) @@ -1238,10 +1205,7 @@ def alc_decay_time(self, value: float) -> None: self._alc_decay = min( round( math.log( - ( - constrain(value, ALC_DECAY_TIME_MIN, ALC_DECAY_TIME_MAX) - - ALC_DECAY_TIME_MIN - ) + (constrain(value, ALC_DECAY_TIME_MIN, ALC_DECAY_TIME_MAX) - ALC_DECAY_TIME_MIN) / ALC_DECAY_TIME_MIN, 2.0, ) @@ -1303,9 +1267,7 @@ def noise_gate_threshold(self) -> float: :default: -76.5 """ - return map_range( - self._noise_gate_threshold, 0, 31, GATE_THRESHOLD_MIN, GATE_THRESHOLD_MAX - ) + return map_range(self._noise_gate_threshold, 0, 31, GATE_THRESHOLD_MIN, GATE_THRESHOLD_MAX) @noise_gate_threshold.setter def noise_gate_threshold(self, value: float) -> None: @@ -1353,9 +1315,7 @@ def left_dac_volume(self) -> float: @left_dac_volume.setter def left_dac_volume(self, value: float) -> None: - self._left_dac_volume = round( - map_range(value, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 1, 255) - ) + self._left_dac_volume = round(map_range(value, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 1, 255)) self._left_dac_volume_set = True _right_dac_volume: int = WOBits(8, _REG_RIGHT_DAC_VOLUME, 0) @@ -1372,9 +1332,7 @@ def right_dac_volume(self) -> float: @right_dac_volume.setter def right_dac_volume(self, value: float) -> None: - self._right_dac_volume = round( - map_range(value, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 1, 255) - ) + self._right_dac_volume = round(map_range(value, DAC_VOLUME_MIN, DAC_VOLUME_MAX, 1, 255)) self._right_dac_volume_set = True @property @@ -1635,9 +1593,7 @@ def left_mic_output_volume(self) -> float: :default: -21.0 """ - return map_range( - self._left_mic_output_volume, 0, 7, OUTPUT_VOLUME_MAX, OUTPUT_VOLUME_MIN - ) + return map_range(self._left_mic_output_volume, 0, 7, OUTPUT_VOLUME_MAX, OUTPUT_VOLUME_MIN) @left_mic_output_volume.setter def left_mic_output_volume(self, value: float) -> None: @@ -1655,9 +1611,7 @@ def right_mic_output_volume(self) -> float: :default: -21.0 """ - return map_range( - self._right_mic_output_volume, 0, 7, OUTPUT_VOLUME_MAX, OUTPUT_VOLUME_MIN - ) + return map_range(self._right_mic_output_volume, 0, 7, OUTPUT_VOLUME_MAX, OUTPUT_VOLUME_MIN) @right_mic_output_volume.setter def right_mic_output_volume(self, value: float) -> None: @@ -2323,14 +2277,14 @@ def sample_rate(self, value: int) -> None: self.base_clock_divider = 4.0 self.amp_clock_divider = 16.0 - if value in [8000, 12000, 16000, 24000, 32000, 48000]: + if value in {8000, 12000, 16000, 24000, 32000, 48000}: # SYSCLK = 12.288 MHz # DCLK = 768.0k_hz self.pll_n = 8 self.pll_k = 0x3126E8 self.adc_clock_divider = self.dac_clock_divider = 48000 / value - elif value in [11025, 22050, 44100]: + elif value in {11025, 22050, 44100}: # SYSCLK = 11.2896 MHz # DCLK = 705.6k_hz self.pll_n = 7 diff --git a/docs/api.rst b/docs/api.rst index 9f44df2..6988702 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_wm8960 :members: diff --git a/docs/conf.py b/docs/conf.py index 92dbed9..1a1cb39 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("..")) @@ -54,9 +52,7 @@ creation_year = "2023" 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 + " Scott Shawcroft, Cooper Dalrymple" author = "Scott Shawcroft, Cooper Dalrymple" diff --git a/examples/wm8960_3d_enhance.py b/examples/wm8960_3d_enhance.py index 0bd2303..15c2d01 100644 --- a/examples/wm8960_3d_enhance.py +++ b/examples/wm8960_3d_enhance.py @@ -49,8 +49,10 @@ """ import time + import board -from adafruit_wm8960 import Input, WM8960 + +from adafruit_wm8960 import WM8960, Input codec = WM8960(board.I2C()) codec.loopback = True diff --git a/examples/wm8960_automatic_level_control.py b/examples/wm8960_automatic_level_control.py index 02ea63d..ec6fa24 100644 --- a/examples/wm8960_automatic_level_control.py +++ b/examples/wm8960_automatic_level_control.py @@ -59,10 +59,12 @@ """ import time + import board -from analogio import AnalogIn from adafruit_simplemath import map_range -from adafruit_wm8960 import Input, WM8960 +from analogio import AnalogIn + +from adafruit_wm8960 import WM8960, Input analog_in = AnalogIn(board.A0) diff --git a/examples/wm8960_input.py b/examples/wm8960_input.py index 8aeb2d6..902f180 100644 --- a/examples/wm8960_input.py +++ b/examples/wm8960_input.py @@ -51,7 +51,8 @@ """ import board -from adafruit_wm8960 import Input, WM8960 + +from adafruit_wm8960 import WM8960, Input codec = WM8960(board.I2C()) diff --git a/examples/wm8960_simpletest.py b/examples/wm8960_simpletest.py index b5196c8..46068d8 100644 --- a/examples/wm8960_simpletest.py +++ b/examples/wm8960_simpletest.py @@ -43,10 +43,12 @@ """ import time + +import audiobusio import board import digitalio -import audiobusio import synthio + from adafruit_wm8960 import WM8960 codec = WM8960(board.I2C(), 44100, 16) 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"