From 8bea3b0a529a8d7e4b335028cb8c41d1a8395004 Mon Sep 17 00:00:00 2001 From: David Glaude Date: Tue, 22 Apr 2025 00:43:20 +0200 Subject: [PATCH 1/2] margin_size seems to be int like in Vertical and Horizontal The documentation is confusing. Not sure when margin_size ever was a bool, but it looks like an int to me. --- adafruit_progressbar/__init__.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_progressbar/__init__.py b/adafruit_progressbar/__init__.py index 6344bbd..0cc4da1 100755 --- a/adafruit_progressbar/__init__.py +++ b/adafruit_progressbar/__init__.py @@ -54,10 +54,10 @@ class ProgressBarBase(displayio.TileGrid): be a hexadecimal value for color (0xEE7755). Default: 0x000000 (Black) :type fill_color: int - :param margin_size: Specify whether a margin between the border of the widget and the bar - representing the value should be visible or not. - Default: True - :type margin_size: bool + :param margin_size: The thickness (in pixels) of the margin between the border and + the bar. If it is 1 or larger, will be filled in by the color of the + "fill_color" parameter. + :type margin_size: int :param value_range: Specify the range of allowed values for which the progress should be displayed. When setting the "value" property, this range is the one against which its progression will be determined. From 356ae3c2aee748c11dea9451bd1b13805c8ccea7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 16 May 2025 18:40:25 +0000 Subject: [PATCH 2/2] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------ README.rst | 6 +- adafruit_progressbar/__init__.py | 31 +- adafruit_progressbar/horizontalprogressbar.py | 16 +- adafruit_progressbar/progressbar.py | 5 - adafruit_progressbar/verticalprogressbar.py | 22 +- docs/api.rst | 4 +- docs/conf.py | 8 +- examples/progressbar_accelerometer.py | 9 +- examples/progressbar_combined.py | 4 +- examples/progressbar_displayio_blinka.py | 10 +- ...rogressbar_displayio_blinka_color_scale.py | 4 +- examples/progressbar_magtag_simpletest.py | 5 +- examples/progressbar_matrixportal.py | 12 +- examples/progressbar_simpletest.py | 6 +- examples/progressbar_vertical_simpletest.py | 6 +- ruff.toml | 108 +++++ 19 files changed, 186 insertions(+), 523 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 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 26e24d4..aad13fd 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/brentru/Adafruit_CircuitPython_ProgressBar/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 Dynamic progress bar widget for CircuitPython displays diff --git a/adafruit_progressbar/__init__.py b/adafruit_progressbar/__init__.py index 0cc4da1..70a8032 100755 --- a/adafruit_progressbar/__init__.py +++ b/adafruit_progressbar/__init__.py @@ -23,7 +23,7 @@ # imports try: - from typing import Tuple, Union, List + from typing import List, Tuple, Union except ImportError: pass # No harm if the module isn't located import displayio @@ -65,7 +65,6 @@ class ProgressBarBase(displayio.TileGrid): :type value_range: Tuple[int, int] or Tuple[float, float] """ - # pylint: disable=too-many-arguments, too-many-instance-attributes def __init__( self, position: Tuple[int, int], @@ -85,9 +84,7 @@ def __init__( raise ValueError("The width and the height must be greater than zero") if not value_range[0] <= value <= value_range[1]: - raise ValueError( - "The starting value must be within the range of minimum to maximum" - ) + raise ValueError("The starting value must be within the range of minimum to maximum") _edge_size = 2 * margin_size + 2 * border_thickness @@ -489,11 +486,9 @@ def get_value_ratio(self, value: Union[int, float]) -> float: return (float(value) - self.minimum) / (self.maximum - self.minimum) - # pylint: disable=no-self-use def _get_value_sizes(self, _old_ratio: float, _new_ratio: float) -> Tuple[int, int]: return 0, 0 - # pylint: disable=no-self-use def _get_max_fill_size(self) -> int: return 0 @@ -520,21 +515,15 @@ def _adjust_size_for_range_limits( def _get_sizes_min_max(self) -> Tuple[int, int]: return 0, min(self.fill_width(), self.fill_height()) - # pylint: disable=no-self-use def _invert_fill_direction(self) -> bool: return False - def _get_horizontal_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: + def _get_horizontal_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: return 0, self.fill_width(), 1 # Subclass must return values - def _get_vertical_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: + def _get_vertical_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: return 0, self.fill_height(), 1 # Subclass must return values - # pylint: disable=too-many-locals def _render( self, _old_value: Union[int, float], @@ -556,15 +545,11 @@ def _render( """ _prev_ratio, _new_ratio = self._get_ratios(_old_value, _new_value) - _old_value_size, _new_value_size = self._get_value_sizes( - _prev_ratio, _new_ratio - ) + _old_value_size, _new_value_size = self._get_value_sizes(_prev_ratio, _new_ratio) # Adjusts for edge cases, such as 0-width non-zero value, or 100% width # non-maximum values - _new_value_size = self._adjust_size_for_range_limits( - _new_value_size, _new_value - ) + _new_value_size = self._adjust_size_for_range_limits(_new_value_size, _new_value) # Default values for increasing value _color = 2 @@ -586,9 +571,7 @@ def _render( _render_offset = self.margin_size + self.border_thickness vert_start, vert_end, vert_incr = self._get_vertical_fill(_start, _end, _incr) - horiz_start, horiz_end, horiz_incr = self._get_horizontal_fill( - _start, _end, _incr - ) + horiz_start, horiz_end, horiz_incr = self._get_horizontal_fill(_start, _end, _incr) vert_start += _render_offset vert_end += _render_offset diff --git a/adafruit_progressbar/horizontalprogressbar.py b/adafruit_progressbar/horizontalprogressbar.py index bd2aed6..39d0b31 100755 --- a/adafruit_progressbar/horizontalprogressbar.py +++ b/adafruit_progressbar/horizontalprogressbar.py @@ -31,18 +31,14 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar.git" -# pylint: disable=too-few-public-methods class HorizontalFillDirection: """This enum is used to specify the direction in which the progress bar's display bar should fill as the value represented increases.""" - # pylint: disable=pointless-string-statement """Fills from the left-hand side toward the right""" LEFT_TO_RIGHT = 0 - # pylint: disable=pointless-string-statement """Specifies the default fill direction (LEFT_TO_RIGHT)""" DEFAULT = LEFT_TO_RIGHT - # pylint: disable=pointless-string-statement """Fill from the right-hand side toward the left""" RIGHT_TO_LEFT = 1 @@ -107,7 +103,6 @@ class HorizontalProgressBar(ProgressBarBase): """ - # pylint: disable=too-many-arguments def __init__( self, position: Tuple[int, int], @@ -146,9 +141,7 @@ def _get_sizes_min_max(self) -> Tuple[int, int]: def _get_value_sizes(self, _old_ratio: float, _new_ratio: float) -> Tuple[int, int]: return int(_old_ratio * self.fill_width()), int(_new_ratio * self.fill_width()) - def _get_horizontal_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: + def _get_horizontal_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: if not self._invert_fill_direction(): return _start, _end, _incr @@ -156,14 +149,9 @@ def _get_horizontal_fill( return base_offset - _start, base_offset - _end, _incr * -1 - # pylint: disable=protected-access - def _get_vertical_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: + def _get_vertical_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: return ProgressBarBase._get_vertical_fill(self, _start, _end, _incr) - # pylint: enable=protected-access - def _invert_fill_direction(self) -> bool: return self._direction == HorizontalFillDirection.RIGHT_TO_LEFT diff --git a/adafruit_progressbar/progressbar.py b/adafruit_progressbar/progressbar.py index 158a2d7..eeb6874 100755 --- a/adafruit_progressbar/progressbar.py +++ b/adafruit_progressbar/progressbar.py @@ -28,7 +28,6 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar.git" -# pylint: disable=too-many-arguments, too-few-public-methods class ProgressBar(HorizontalProgressBar): """A dynamic progress bar widget. @@ -53,7 +52,6 @@ class ProgressBar(HorizontalProgressBar): :type stroke: int """ - # pylint: disable=invalid-name def __init__( self, x: int, @@ -102,7 +100,4 @@ def progress(self, value: float) -> None: :rtype: None """ - # Disable pylint since the property "value" is defined in the - # base class "ProgressBarBase" - # pylint: disable=access-member-before-definition self.value = value diff --git a/adafruit_progressbar/verticalprogressbar.py b/adafruit_progressbar/verticalprogressbar.py index 472aafa..b2ec95c 100755 --- a/adafruit_progressbar/verticalprogressbar.py +++ b/adafruit_progressbar/verticalprogressbar.py @@ -32,23 +32,18 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar.git" -# pylint: disable=too-few-public-methods class VerticalFillDirection: """This enum is used to specify the direction in which the progress bar's display bar should fill as the value represented increases.""" - # pylint: disable=pointless-string-statement """Fills from the bottom up toward the top""" BOTTOM_TO_TOP = 0 - # pylint: disable=pointless-string-statement """Default fill direction (BOTTOM_TO_TOP)""" DEFAULT = BOTTOM_TO_TOP - # pylint: disable=pointless-string-statement """Fills from the top down toward the bottom""" TOP_TO_BOTTOM = 1 -# pylint: disable=too-many-arguments, too-few-public-methods, too-many-instance-attributes class VerticalProgressBar(HorizontalProgressBar): """A dynamic progress bar widget. @@ -112,21 +107,12 @@ def _get_sizes_min_max(self) -> Tuple[int, int]: return 0, self.fill_height() def _get_value_sizes(self, _old_ratio: float, _new_ratio: float) -> Tuple[int, int]: - return int(_old_ratio * self.fill_height()), int( - _new_ratio * self.fill_height() - ) - - # pylint: disable=protected-access - def _get_horizontal_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: - return ProgressBarBase._get_horizontal_fill(self, _start, _end, _incr) + return int(_old_ratio * self.fill_height()), int(_new_ratio * self.fill_height()) - # pylint: enable=protected-access + def _get_horizontal_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: + return ProgressBarBase._get_horizontal_fill(self, _start, _end, _incr) - def _get_vertical_fill( - self, _start: int, _end: int, _incr: int - ) -> Tuple[int, int, int]: + def _get_vertical_fill(self, _start: int, _end: int, _incr: int) -> Tuple[int, int, int]: if not self._invert_fill_direction(): return _start, _end, _incr diff --git a/docs/api.rst b/docs/api.rst index 00fe24c..fa75339 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ -API Definition ---------------------- +API Reference +############# .. If you created a package, create one automodule per module in the package. diff --git a/docs/conf.py b/docs/conf.py index 2dd12f0..803429d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -46,9 +44,7 @@ creation_year = "2020" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Brent Rubell" author = "Brent Rubell" diff --git a/examples/progressbar_accelerometer.py b/examples/progressbar_accelerometer.py index 9c1422f..8aefffe 100644 --- a/examples/progressbar_accelerometer.py +++ b/examples/progressbar_accelerometer.py @@ -4,16 +4,19 @@ With this example you would be able to use the progress bar to display accelerometer data in the X and Y directions """ + import time -import displayio + import board +import displayio + from adafruit_progressbar.horizontalprogressbar import ( - HorizontalProgressBar, HorizontalFillDirection, + HorizontalProgressBar, ) from adafruit_progressbar.verticalprogressbar import ( - VerticalProgressBar, VerticalFillDirection, + VerticalProgressBar, ) # This data is used to show library capability. You could use an actual accelerometer diff --git a/examples/progressbar_combined.py b/examples/progressbar_combined.py index 22743e4..e736d1a 100644 --- a/examples/progressbar_combined.py +++ b/examples/progressbar_combined.py @@ -8,8 +8,10 @@ # You can do so automatically by using the "pip" utility. import time + import board import displayio + from adafruit_progressbar.horizontalprogressbar import HorizontalProgressBar from adafruit_progressbar.verticalprogressbar import VerticalProgressBar @@ -42,7 +44,7 @@ while True: # range end is exclusive so we need to use 1 bigger than max number that we want for current_progress in range(0, 101, 1): - print("Progress: {}%".format(current_progress)) + print(f"Progress: {current_progress}%") progress_bar.value = current_progress vert_progress_bar.value = current_progress * 2 time.sleep(0.01) diff --git a/examples/progressbar_displayio_blinka.py b/examples/progressbar_displayio_blinka.py index f67c8ca..73f915e 100644 --- a/examples/progressbar_displayio_blinka.py +++ b/examples/progressbar_displayio_blinka.py @@ -7,18 +7,20 @@ # required libraries identifies in the `requirements.txt` file. # You can do so automatically by using the "pip" utility. -import time import sys +import time + import displayio from blinka_displayio_pygamedisplay import PyGameDisplay -from adafruit_progressbar.progressbar import ProgressBar + from adafruit_progressbar.horizontalprogressbar import ( - HorizontalProgressBar, HorizontalFillDirection, + HorizontalProgressBar, ) +from adafruit_progressbar.progressbar import ProgressBar from adafruit_progressbar.verticalprogressbar import ( - VerticalProgressBar, VerticalFillDirection, + VerticalProgressBar, ) display = PyGameDisplay(width=320, height=240, auto_refresh=False) diff --git a/examples/progressbar_displayio_blinka_color_scale.py b/examples/progressbar_displayio_blinka_color_scale.py index 9e3b1ee..20b8c9b 100644 --- a/examples/progressbar_displayio_blinka_color_scale.py +++ b/examples/progressbar_displayio_blinka_color_scale.py @@ -14,12 +14,14 @@ """ import time + import adafruit_fancyled.adafruit_fancyled as fancy import displayio from blinka_displayio_pygamedisplay import PyGameDisplay + from adafruit_progressbar.horizontalprogressbar import ( - HorizontalProgressBar, HorizontalFillDirection, + HorizontalProgressBar, ) display = PyGameDisplay(width=320, height=240, auto_refresh=False) diff --git a/examples/progressbar_magtag_simpletest.py b/examples/progressbar_magtag_simpletest.py index 8d85bc3..d19191b 100644 --- a/examples/progressbar_magtag_simpletest.py +++ b/examples/progressbar_magtag_simpletest.py @@ -5,10 +5,13 @@ Basic progressbar example script adapted for use on MagTag. """ + import time + import board -import displayio import digitalio +import displayio + from adafruit_progressbar.progressbar import HorizontalProgressBar # use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.) diff --git a/examples/progressbar_matrixportal.py b/examples/progressbar_matrixportal.py index 5d1cb95..c4c7c0d 100644 --- a/examples/progressbar_matrixportal.py +++ b/examples/progressbar_matrixportal.py @@ -7,24 +7,24 @@ # HARDWARE import time + import board +# CONTROLS +import digitalio + # DISPLAY import displayio # Main display library import framebufferio # For showing things on the display import rgbmatrix # For talking to matrices specifically -# CONTROLS - -import digitalio - from adafruit_progressbar.horizontalprogressbar import ( - HorizontalProgressBar, HorizontalFillDirection, + HorizontalProgressBar, ) from adafruit_progressbar.verticalprogressbar import ( - VerticalProgressBar, VerticalFillDirection, + VerticalProgressBar, ) # ############## DISPLAY SETUP ############### diff --git a/examples/progressbar_simpletest.py b/examples/progressbar_simpletest.py index 7cb2931..275f471 100644 --- a/examples/progressbar_simpletest.py +++ b/examples/progressbar_simpletest.py @@ -2,11 +2,13 @@ # SPDX-License-Identifier: MIT import time + import board import displayio + from adafruit_progressbar.horizontalprogressbar import ( - HorizontalProgressBar, HorizontalFillDirection, + HorizontalProgressBar, ) # Make the display context @@ -32,7 +34,7 @@ while True: # range end is exclusive so we need to use 1 bigger than max number that we want for current_value in range(progress_bar.minimum, progress_bar.maximum + 1, 1): - print("Progress: {}%".format(current_value)) + print(f"Progress: {current_value}%") progress_bar.value = current_value time.sleep(0.01) time.sleep(0.3) diff --git a/examples/progressbar_vertical_simpletest.py b/examples/progressbar_vertical_simpletest.py index 8620aa2..e184110 100644 --- a/examples/progressbar_vertical_simpletest.py +++ b/examples/progressbar_vertical_simpletest.py @@ -2,11 +2,13 @@ # SPDX-License-Identifier: MIT import time + import board import displayio + from adafruit_progressbar.verticalprogressbar import ( - VerticalProgressBar, VerticalFillDirection, + VerticalProgressBar, ) # Make the display context @@ -42,7 +44,7 @@ while True: # range end is exclusive so we need to use 1 bigger than max number that we want for current_progress in range(0, 101, 1): - print("Progress: {}%".format(current_progress)) + print(f"Progress: {current_progress}%") vertical_progress_bar.value = current_progress vertical_progress_bar2.value = current_progress time.sleep(0.05) diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..73e9efc --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# 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 + "PLC2701", # private import +] + +[format] +line-ending = "lf"