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 374676d..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v3.3.1 + - 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 4c51e24..0000000 --- a/.pylintrc +++ /dev/null @@ -1,396 +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,too-many-arguments,too-many-positional-arguments - -# 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 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 5686e18..b23d319 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes/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 Various common shapes for use with displayio diff --git a/adafruit_display_shapes/arc.py b/adafruit_display_shapes/arc.py index e1f7158..1308673 100644 --- a/adafruit_display_shapes/arc.py +++ b/adafruit_display_shapes/arc.py @@ -27,7 +27,9 @@ pass import math + import displayio + from adafruit_display_shapes.polygon import Polygon try: @@ -42,7 +44,6 @@ class Arc(displayio.Group): - # pylint: disable=too-few-public-methods, invalid-name """An arc. Technically, an arc is a Group with one or two polygons. An arc is defined by a radius, an angle (in degrees) and a direction (also in @@ -67,7 +68,6 @@ class Arc(displayio.Group): """ def __init__( - # pylint: disable=too-many-arguments, too-many-locals self, radius: float, angle: float, @@ -107,9 +107,7 @@ def _init_arc(self): # create inner points if self._arc_width > 1: for i in range(self._segments, -1, -1): - alpha = ( - (i * self._angle / self._segments + self._direction) / 180 * math.pi - ) + alpha = (i * self._angle / self._segments + self._direction) / 180 * math.pi x0 = int((self._radius - self._arc_width) * math.cos(alpha)) y0 = -int((self._radius - self._arc_width) * math.sin(alpha)) points.append((x0, y0)) diff --git a/adafruit_display_shapes/circle.py b/adafruit_display_shapes/circle.py index 1b774a5..3395351 100644 --- a/adafruit_display_shapes/circle.py +++ b/adafruit_display_shapes/circle.py @@ -33,7 +33,6 @@ class Circle(RoundRect): - # pylint: disable=too-few-public-methods, invalid-name """A circle. :param int x0: The x-position of the center. diff --git a/adafruit_display_shapes/filled_polygon.py b/adafruit_display_shapes/filled_polygon.py index 8a1289d..3225462 100644 --- a/adafruit_display_shapes/filled_polygon.py +++ b/adafruit_display_shapes/filled_polygon.py @@ -23,11 +23,12 @@ """ try: - from typing import Optional, List, Tuple + from typing import List, Optional, Tuple except ImportError: pass import displayio + from adafruit_display_shapes.polygon import Polygon try: @@ -42,7 +43,6 @@ class FilledPolygon(displayio.Group): - # pylint: disable=too-few-public-methods, invalid-name """A filled polygon. Technically, an FilledPolygon is a Group with one or two polygons. :param list points: A list of (x, y) tuples of the points diff --git a/adafruit_display_shapes/line.py b/adafruit_display_shapes/line.py index 2d5c40d..58664a7 100644 --- a/adafruit_display_shapes/line.py +++ b/adafruit_display_shapes/line.py @@ -33,7 +33,6 @@ class Line(Polygon): - # pylint: disable=too-many-arguments,invalid-name, too-few-public-methods """A line. :param int x0: The x-position of the first vertex. diff --git a/adafruit_display_shapes/multisparkline.py b/adafruit_display_shapes/multisparkline.py index 0d01b8b..8b9f904 100644 --- a/adafruit_display_shapes/multisparkline.py +++ b/adafruit_display_shapes/multisparkline.py @@ -22,12 +22,13 @@ """ try: - from typing import Optional, List, TypeVar + from typing import List, Optional, TypeVar T = TypeVar("T") except ImportError: pass import displayio + from adafruit_display_shapes.polygon import Polygon @@ -108,7 +109,6 @@ class MultiSparkline(displayio.TileGrid): will scroll to the left. """ - # pylint: disable=too-many-arguments, too-many-instance-attributes def __init__( self, width: int, @@ -153,8 +153,6 @@ def __init__( super().__init__(self._bitmap, pixel_shader=self._palette, x=x, y=y) - # pylint: enable=too-many-arguments - def clear_values(self) -> None: """Clears _buffer and removes all lines in the group""" self._bitmap.fill(0) diff --git a/adafruit_display_shapes/polygon.py b/adafruit_display_shapes/polygon.py index 1909653..3d3eafc 100644 --- a/adafruit_display_shapes/polygon.py +++ b/adafruit_display_shapes/polygon.py @@ -22,7 +22,7 @@ """ try: - from typing import Optional, List, Tuple + from typing import List, Optional, Tuple except ImportError: pass @@ -57,7 +57,6 @@ def __init__( close: Optional[bool] = True, colors: Optional[int] = 2, stroke: int = 1, - # pylint: disable=too-many-arguments ) -> None: (x_s, y_s) = zip(*points) @@ -79,9 +78,7 @@ def __init__( self.outline = outline self.draw(self._bitmap, shifted, self._OUTLINE, close, stroke) - super().__init__( - self._bitmap, pixel_shader=self._palette, x=x_offset, y=y_offset - ) + super().__init__(self._bitmap, pixel_shader=self._palette, x=x_offset, y=y_offset) @staticmethod def draw( @@ -105,7 +102,6 @@ def draw( for index in range(len(points) - 1): Polygon._line_on(bitmap, points[index], points[index + 1], color_id, stroke) - # pylint: disable=too-many-arguments def _line( self, x_0: int, @@ -116,8 +112,6 @@ def _line( ) -> None: self._line_on(self._bitmap, (x_0, y_0), (x_1, y_1), color) - # pylint: enable=too-many-arguments - @staticmethod def _safe_draw( bitmap: displayio.Bitmap, @@ -128,7 +122,6 @@ def _safe_draw( if 0 <= x < bitmap.width and 0 <= y < bitmap.height: bitmap[x, y] = color - # pylint: disable=too-many-branches, too-many-locals @staticmethod def _line_on( bitmap: displayio.Bitmap, @@ -195,8 +188,6 @@ def pt_on(x, y, pt_size=1): y_0 += ystep err += d_x - # pylint: enable=too-many-branches, too-many-locals - @property def outline(self) -> Optional[int]: """The outline of the polygon. Can be a hex value for a color or diff --git a/adafruit_display_shapes/roundrect.py b/adafruit_display_shapes/roundrect.py index 189c912..e511253 100644 --- a/adafruit_display_shapes/roundrect.py +++ b/adafruit_display_shapes/roundrect.py @@ -23,7 +23,6 @@ class RoundRect(displayio.TileGrid): - # pylint: disable=too-many-arguments """A round-corner rectangle. :param int x: The x-position of the top left corner. @@ -55,9 +54,7 @@ def __init__( if width <= 0 or height <= 0: raise ValueError("Rectangle dimensions must be larger than 0.") if r > width / 2 or r > height / 2: - raise ValueError( - "Radius cannot exceed half of the smaller side (width or height)." - ) + raise ValueError("Radius cannot exceed half of the smaller side (width or height).") self._palette = displayio.Palette(3) self._palette.make_transparent(0) @@ -105,7 +102,6 @@ def __init__( ) super().__init__(self._bitmap, pixel_shader=self._palette, x=x, y=y) - # pylint: disable=invalid-name, too-many-locals, too-many-branches def _helper( self, x0: int, @@ -162,8 +158,6 @@ def _helper( self._bitmap[x0 + x + x_offset, y0 - y + line] = color self._bitmap[x0 + y + x_offset - line, y0 - x] = color - # pylint: enable=invalid-name, too-many-locals, too-many-branches - @property def fill(self) -> Optional[int]: """The fill of the rounded-corner rectangle. Can be a hex value for a color or ``None`` for diff --git a/adafruit_display_shapes/sparkline.py b/adafruit_display_shapes/sparkline.py index d37b98b..b61f0d0 100644 --- a/adafruit_display_shapes/sparkline.py +++ b/adafruit_display_shapes/sparkline.py @@ -38,7 +38,7 @@ """ try: - from typing import Optional, List + from typing import List, Optional except ImportError: pass from adafruit_display_shapes.multisparkline import MultiSparkline @@ -63,7 +63,6 @@ class Sparkline(MultiSparkline): will scroll to the left. """ - # pylint: disable=too-many-arguments def __init__( self, width: int, @@ -76,11 +75,7 @@ def __init__( y: int = 0, color: int = 0xFFFFFF, # line color, default is WHITE ) -> None: - super().__init__( - width, height, max_items, [color], dyn_xpitch, [y_min], [y_max], x, y - ) - - # pylint: enable=too-many-arguments + super().__init__(width, height, max_items, [color], dyn_xpitch, [y_min], [y_max], x, y) def add_value(self, value: float, update: bool = True) -> None: """Add a value to the sparkline. diff --git a/adafruit_display_shapes/triangle.py b/adafruit_display_shapes/triangle.py index 84224c5..92c3fd1 100644 --- a/adafruit_display_shapes/triangle.py +++ b/adafruit_display_shapes/triangle.py @@ -33,7 +33,6 @@ class Triangle(Polygon): - # pylint: disable=too-many-arguments,invalid-name """A triangle. :param int x0: The x-position of the first vertex. @@ -48,7 +47,6 @@ class Triangle(Polygon): ``None`` for no outline. """ - # pylint: disable=too-many-locals def __init__( self, x0: int, @@ -82,9 +80,7 @@ def __init__( super().__init__(points) if fill is not None: - self._draw_filled( - x0 - min(xs), 0, x1 - min(xs), y1 - y0, x2 - min(xs), y2 - y0 - ) + self._draw_filled(x0 - min(xs), 0, x1 - min(xs), y1 - y0, x2 - min(xs), y2 - y0) self.fill = fill else: self.fill = None @@ -105,7 +101,6 @@ def __init__( self._OUTLINE, ) - # pylint: disable=invalid-name, too-many-branches def _draw_filled( self, x0: int, @@ -151,8 +146,6 @@ def _draw_filled( a, b = b, a self._line(a, y, b, y, self._FILL) - # pylint: enable=invalid-name, too-many-locals, too-many-branches - @property def fill(self) -> Optional[int]: """The fill of the triangle. Can be a hex value for a color or diff --git a/docs/api.rst b/docs/api.rst index 572a17e..2af1a29 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_display_shapes.circle :members: diff --git a/docs/conf.py b/docs/conf.py index 6d31dca..459a544 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -48,9 +46,7 @@ creation_year = "2019" 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 + " Limor Fried" author = "Limor Fried" diff --git a/examples/display_shapes_arc.py b/examples/display_shapes_arc.py index 5139a77..60c529e 100644 --- a/examples/display_shapes_arc.py +++ b/examples/display_shapes_arc.py @@ -2,9 +2,10 @@ # SPDX-License-Identifier: MIT import time -import board +import board import displayio + from adafruit_display_shapes.arc import Arc from adafruit_display_shapes.circle import Circle diff --git a/examples/display_shapes_arc_dynamic.py b/examples/display_shapes_arc_dynamic.py index a94b2fd..8957e9e 100644 --- a/examples/display_shapes_arc_dynamic.py +++ b/examples/display_shapes_arc_dynamic.py @@ -3,10 +3,12 @@ """ Illustrates how to dynamically update arcs over time. """ + import time -import board +import board import displayio + from adafruit_display_shapes.arc import Arc from adafruit_display_shapes.circle import Circle diff --git a/examples/display_shapes_circle_animation.py b/examples/display_shapes_circle_animation.py index f82d9be..a510ddf 100644 --- a/examples/display_shapes_circle_animation.py +++ b/examples/display_shapes_circle_animation.py @@ -5,10 +5,12 @@ This is an animation to demonstrate the use of Circle Setter Attribute. """ -import time import gc +import time + import board import displayio + from adafruit_display_shapes.circle import Circle # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.) diff --git a/examples/display_shapes_filled_polygon_simpletest.py b/examples/display_shapes_filled_polygon_simpletest.py index 921b353..bd2af74 100644 --- a/examples/display_shapes_filled_polygon_simpletest.py +++ b/examples/display_shapes_filled_polygon_simpletest.py @@ -3,6 +3,7 @@ import board import displayio + from adafruit_display_shapes.filled_polygon import FilledPolygon # Make the display context diff --git a/examples/display_shapes_simpletest.py b/examples/display_shapes_simpletest.py index 52dd7e2..09625b8 100644 --- a/examples/display_shapes_simpletest.py +++ b/examples/display_shapes_simpletest.py @@ -3,12 +3,13 @@ import board import displayio -from adafruit_display_shapes.rect import Rect + from adafruit_display_shapes.circle import Circle -from adafruit_display_shapes.roundrect import RoundRect -from adafruit_display_shapes.triangle import Triangle from adafruit_display_shapes.line import Line from adafruit_display_shapes.polygon import Polygon +from adafruit_display_shapes.rect import Rect +from adafruit_display_shapes.roundrect import RoundRect +from adafruit_display_shapes.triangle import Triangle # Make the display context splash = displayio.Group() diff --git a/examples/display_shapes_simpletest_magtag.py b/examples/display_shapes_simpletest_magtag.py index 1dc58fd..6457cb9 100644 --- a/examples/display_shapes_simpletest_magtag.py +++ b/examples/display_shapes_simpletest_magtag.py @@ -3,12 +3,13 @@ import board import displayio -from adafruit_display_shapes.rect import Rect + from adafruit_display_shapes.circle import Circle -from adafruit_display_shapes.roundrect import RoundRect -from adafruit_display_shapes.triangle import Triangle from adafruit_display_shapes.line import Line from adafruit_display_shapes.polygon import Polygon +from adafruit_display_shapes.rect import Rect +from adafruit_display_shapes.roundrect import RoundRect +from adafruit_display_shapes.triangle import Triangle # use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.) # see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.) diff --git a/examples/display_shapes_sparkline_simpletest.py b/examples/display_shapes_sparkline_simpletest.py index cff1e6b..1cef1f5 100755 --- a/examples/display_shapes_sparkline_simpletest.py +++ b/examples/display_shapes_sparkline_simpletest.py @@ -30,12 +30,12 @@ # add new values to sparkline `add_value` # update the sparklines `update` -import time import random +import time + import board import displayio - from adafruit_display_shapes.sparkline import Sparkline if "DISPLAY" not in dir(board): @@ -68,7 +68,7 @@ phase=1, ) - print("spi.frequency: {}".format(spi.frequency)) + print(f"spi.frequency: {spi.frequency}") # Number of pixels in the display DISPLAY_WIDTH = 320 diff --git a/examples/display_shapes_sparkline_ticks.py b/examples/display_shapes_sparkline_ticks.py index d31719f..f436ccc 100755 --- a/examples/display_shapes_sparkline_ticks.py +++ b/examples/display_shapes_sparkline_ticks.py @@ -31,14 +31,15 @@ import random import time + import board import displayio import terminalio from adafruit_display_text import label -from adafruit_display_shapes.sparkline import Sparkline + from adafruit_display_shapes.line import Line from adafruit_display_shapes.rect import Rect - +from adafruit_display_shapes.sparkline import Sparkline if "DISPLAY" not in dir(board): # Setup the LCD display with driver @@ -69,7 +70,7 @@ phase=1, ) - print("spi.frequency: {}".format(spi.frequency)) + print(f"spi.frequency: {spi.frequency}") # Number of pixels in the display DISPLAY_WIDTH = 320 @@ -121,18 +122,14 @@ # Label the y-axis range text_xoffset = -10 -text_label1a = label.Label( - font=font, text=str(sparkline1.y_top), color=line_color -) # yTop label +text_label1a = label.Label(font=font, text=str(sparkline1.y_top), color=line_color) # yTop label text_label1a.anchor_point = (1, 0.5) # set the anchorpoint at right-center text_label1a.anchored_position = ( sparkline1.x + text_xoffset, sparkline1.y, ) # set the text anchored position to the upper right of the graph -text_label1b = label.Label( - font=font, text=str(sparkline1.y_bottom), color=line_color -) # yTop label +text_label1b = label.Label(font=font, text=str(sparkline1.y_bottom), color=line_color) # yTop label text_label1b.anchor_point = (1, 0.5) # set the anchorpoint at right-center text_label1b.anchored_position = ( sparkline1.x + text_xoffset, @@ -140,9 +137,7 @@ ) # set the text anchored position to the upper right of the graph -bounding_rectangle = Rect( - sparkline1.x, sparkline1.y, chart_width, chart_height, outline=line_color -) +bounding_rectangle = Rect(sparkline1.x, sparkline1.y, chart_width, chart_height, outline=line_color) # Create a group to hold the sparkline, text, rectangle and tickmarks diff --git a/examples/display_shapes_sparkline_triple.py b/examples/display_shapes_sparkline_triple.py index 53c4f69..b85f4e8 100755 --- a/examples/display_shapes_sparkline_triple.py +++ b/examples/display_shapes_sparkline_triple.py @@ -31,12 +31,13 @@ import random import time + import board import displayio import terminalio from adafruit_display_text import label -from adafruit_display_shapes.sparkline import Sparkline +from adafruit_display_shapes.sparkline import Sparkline if "DISPLAY" not in dir(board): # Setup the LCD display with driver @@ -67,7 +68,7 @@ phase=1, ) - print("spi.frequency: {}".format(spi.frequency)) + print(f"spi.frequency: {spi.frequency}") # Number of pixels in the display DISPLAY_WIDTH = 320 @@ -114,9 +115,7 @@ ) # Label the y-axis range -text_label1a = label.Label( - font=font, text=str(sparkline1.y_top), color=0xFFFFFF -) # y_top label +text_label1a = label.Label(font=font, text=str(sparkline1.y_top), color=0xFFFFFF) # y_top label text_label1a.anchor_point = (0, 0.5) # set the anchorpoint text_label1a.anchored_position = ( 10 + chart_width, 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"