diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7e02117..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,40 +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: 20.8b1 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - exclude: "^(docs/|examples/|tests/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) - description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] - language: system - - id: pylint_tests - name: pylint (tests code) - description: Run pylint rules on "tests/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "tests" ]] || for test in $(find . -path "./tests/*.py"); do pylint --disable=missing-docstring $test; done)'] - language: system + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 79bcfb7..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +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= - -# 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,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,pointless-string-statement - -# 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 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# 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] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([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 - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-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 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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 - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-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 - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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=Exception diff --git a/displayio_dial.py b/displayio_dial.py index ded35a3..7b1dd6a 100644 --- a/displayio_dial.py +++ b/displayio_dial.py @@ -24,20 +24,23 @@ # pylint: disable=too-many-lines, too-many-instance-attributes, too-many-arguments # pylint: disable=too-many-locals, too-many-statements, attribute-defined-outside-init - import math + import displayio import vectorio try: import bitmaptools -except NameError: - pass # utilize the blit_rotate_scale function defined herein + + bitmaptools_available = True +except ImportError: + bitmaptools_available = False + # utilize the blit_rotate_scale function defined herein -from terminalio import FONT as terminalio_FONT from adafruit_display_text import bitmap_label from adafruit_displayio_layout.widgets.widget import Widget +from terminalio import FONT as terminalio_FONT class Dial(Widget): @@ -235,9 +238,7 @@ def __init__( if sweep_angle > 360: raise ValueError("sweep_angle must be <= 360 degrees") - sweep_angle = max( - 1, sweep_angle - ) # constrain to >= 1 to avoid divide by zero errors + sweep_angle = max(1, sweep_angle) # constrain to >= 1 to avoid divide by zero errors self._sweep_angle = sweep_angle if start_angle is None: @@ -287,7 +288,6 @@ def __init__( self._initialize_dial(width, height) def _initialize_dial(self, width, height): - for _ in range(len(self)): self.pop() @@ -355,9 +355,7 @@ def _initialize_dial(self, width, height): self.dial_palette[2] = self._tick_color # create the dial tilegrid and append to the self Widget->Group - self.dial_tilegrid = displayio.TileGrid( - self.dial_bitmap, pixel_shader=self.dial_palette - ) + self.dial_tilegrid = displayio.TileGrid(self.dial_bitmap, pixel_shader=self.dial_palette) self.append(self.dial_tilegrid) # create the label for the display_value @@ -399,9 +397,7 @@ def _adjust_dimensions(self, width, height): # calculate the pixel dimension to fit within width/height (including padding) if (width - 2 * self._padding < 0) or (height - 2 * self._padding < 0): raise ValueError("Width, height, or padding size makes zero sized box") - requested_aspect_ratio = (width - 2 * self._padding) / ( - height - 2 * self._padding - ) + requested_aspect_ratio = (width - 2 * self._padding) / (height - 2 * self._padding) box_aspect_ratio = (right - left) / (bottom - top) if box_aspect_ratio >= requested_aspect_ratio: @@ -415,9 +411,9 @@ def _adjust_dimensions(self, width, height): else: # keep height and adjust the width self._height = height - self._width = math.ceil( - ((height - 2 * self._padding) * box_aspect_ratio) - ) + (2 * self._padding) + self._width = math.ceil((height - 2 * self._padding) * box_aspect_ratio) + ( + 2 * self._padding + ) radius = round((height - 2 * self._padding) / (2 * (bottom - top))) center_x = round(x_center_calc * radius * 2) + self._padding @@ -453,11 +449,10 @@ def _adjust_dimensions(self, width, height): def _get_font_height(self, font, scale): if (self._major_tick_labels == []) or (font is None): font_height = 0 - else: - if hasattr(font, "get_bounding_box"): - font_height = int(scale * font.get_bounding_box()[1]) - elif hasattr(font, "ascent"): - font_height = int(scale * font.ascent + font.ascent) + elif hasattr(font, "get_bounding_box"): + font_height = int(scale * font.get_bounding_box()[1]) + elif hasattr(font, "ascent"): + font_height = int(scale * font.ascent + font.ascent) return font_height def _create_needle(self): @@ -473,15 +468,9 @@ def _create_needle(self): ) # if clipped, adjust the needle width up according to the clip amount - if ( - (self._sweep_angle < 180) - and (self._clip_needle) - and (self._trim_line is not None) - ): + if (self._sweep_angle < 180) and (self._clip_needle) and (self._trim_line is not None): # calculate the line where the needle is most visible - max_visible_angle = (2 * math.pi / 360) * ( - self._start_angle + self._sweep_angle / 2 - ) + max_visible_angle = (2 * math.pi / 360) * (self._start_angle + self._sweep_angle / 2) while True: if max_visible_angle > math.pi: max_visible_angle -= 2 * math.pi @@ -490,12 +479,8 @@ def _create_needle(self): else: break - temp_x = self._dial_center[0] + self._dial_radius * math.sin( - max_visible_angle - ) - temp_y = self._dial_center[1] - self._dial_radius * math.cos( - max_visible_angle - ) + temp_x = self._dial_center[0] + self._dial_radius * math.sin(max_visible_angle) + temp_y = self._dial_center[1] - self._dial_radius * math.cos(max_visible_angle) temp_line = [self._dial_center, (temp_x, temp_y)] @@ -509,7 +494,6 @@ def _create_needle(self): self._needle_width = self._needle_width_requested def _update_value(self): - if self._display_value: format_string = ("{" + self._value_format_string + "}").format(self._value) self._value_label.text = format_string @@ -546,9 +530,7 @@ def _get_offset_position(self, position): # for motion acceleration). # if multiple elements are present, they could each have their own movement functions. - angle_offset = (2 * math.pi / 360) * ( - self._start_angle + self._sweep_angle * position - ) + angle_offset = (2 * math.pi / 360) * (self._start_angle + self._sweep_angle * position) return angle_offset @@ -606,7 +588,6 @@ def value(self): @value.setter def value(self, new_value): - if new_value != self._value: self._value = new_value self._update_value() @@ -688,20 +669,17 @@ def draw_ticks( tick_bitmap = displayio.Bitmap( tick_stroke, tick_length, tick_color_index + 1 ) # make a tick line bitmap for blitting - tick_bitmap.fill( - tick_color_index - ) # initialize the tick bitmap with the tick_color_index + tick_bitmap.fill(tick_color_index) # initialize the tick bitmap with the tick_color_index for i in range(tick_count): this_angle = round( - (start_angle + ((i * sweep_angle / (tick_count - 1)))) - * (2 * math.pi / 360), + (start_angle + (i * sweep_angle / (tick_count - 1))) * (2 * math.pi / 360), 4, ) # in radians target_position_x = dial_center[0] + dial_radius * math.sin(this_angle) target_position_y = dial_center[1] - dial_radius * math.cos(this_angle) - if "rotozoom" in dir(bitmaptools): # if core function is available + if bitmaptools_available: # if core function is available bitmaptools.rotozoom( target_bitmap, ox=round(target_position_x), @@ -759,7 +737,6 @@ def draw_labels( label_count = len(tick_labels) for i, this_label_text in enumerate(tick_labels): - temp_label = bitmap_label.Label( font, text=this_label_text ) # make a tick line bitmap for blitting @@ -768,19 +745,15 @@ def draw_labels( start_angle + i * sweep_angle / (label_count - 1) ) # in radians - target_position_x = dial_center[0] + ( - dial_radius + font_height // 2 - ) * math.sin(this_angle) - target_position_y = dial_center[1] - ( - dial_radius + font_height // 2 - ) * math.cos(this_angle) + target_position_x = dial_center[0] + (dial_radius + font_height // 2) * math.sin(this_angle) + target_position_y = dial_center[1] - (dial_radius + font_height // 2) * math.cos(this_angle) if rotate_labels: pass else: this_angle = 0 - if "rotozoom" in dir(bitmaptools): # if core function is available + if bitmaptools_available: # if core function is available bitmaptools.rotozoom( target_bitmap, ox=round(target_position_x), @@ -856,6 +829,7 @@ def draw_labels( # pylint: disable=invalid-name, too-many-branches, too-many-statements + # This function is provided in case the bitmaptools.rotozoom function is not available def _blit_rotate_scale( destination, # destination bitmap @@ -872,7 +846,6 @@ def _blit_rotate_scale( scale=1.0, # scale factor (float) skip_index=None, # color index to ignore ): - if source is None: pass @@ -926,16 +899,8 @@ def _blit_rotate_scale( if dy > maxy: maxy = int(round(dy)) - dx = ( - cosAngle * (source.width - px) * scale - - sinAngle * (source.height - py) * scale - + ox - ) - dy = ( - sinAngle * (source.width - px) * scale - + cosAngle * (source.height - py) * scale - + oy - ) + dx = cosAngle * (source.width - px) * scale - sinAngle * (source.height - py) * scale + ox + dy = sinAngle * (source.width - px) * scale + cosAngle * (source.height - py) * scale + oy if dx < minx: minx = int(round(dx)) if dx > maxx: @@ -957,14 +922,10 @@ def _blit_rotate_scale( maxy = int(round(dy)) # /* Clipping */ - if minx < dest_clip0[0]: - minx = dest_clip0[0] - if maxx > dest_clip1[0] - 1: - maxx = dest_clip1[0] - 1 - if miny < dest_clip0[1]: - miny = dest_clip0[1] - if maxy > dest_clip1[1] - 1: - maxy = dest_clip1[1] - 1 + minx = max(minx, dest_clip0[0]) + maxx = min(maxx, dest_clip1[0] - 1) + miny = max(miny, dest_clip0[1]) + maxy = min(maxy, dest_clip1[1] - 1) dvCol = math.cos(angle) / scale duCol = math.sin(angle) / scale @@ -993,9 +954,9 @@ def _blit_rotate_scale( if c != skip_index: # ignore any pixels with skip_index # place the pixel color (c) into the destination bitmap at (x,y) - destination[ - x + y * destination.width - ] = c # direct index into bitmap is faster than tuple + destination[x + y * destination.width] = ( + c # direct index into bitmap is faster than tuple + ) # destination[x,y] = c u += duRow v += dvRow @@ -1061,35 +1022,31 @@ def _getCoords(interval, ignore_center=False): if is0: top = 1.0 + elif ignore_center: + top = max(xi, xf) else: - if ignore_center: - top = max(xi, xf) - else: - top = max(xi, xf, 0.5) + top = max(xi, xf, 0.5) if is90: right = 1.0 + elif ignore_center: + right = max(yi, yf) else: - if ignore_center: - right = max(yi, yf) - else: - right = max(yi, yf, 0.5) + right = max(yi, yf, 0.5) if is180: bottom = 0 + elif ignore_center: + bottom = min(xi, xf) else: - if ignore_center: - bottom = min(xi, xf) - else: - bottom = min(xi, xf, 0.5) + bottom = min(xi, xf, 0.5) if is270: left = 0 + elif ignore_center: + left = min(yi, yf) else: - if ignore_center: - left = min(yi, yf) - else: - left = min(yi, yf, 0.5) + left = min(yi, yf, 0.5) xCenter_offset = 0.5 - left yCenter_offset = 0.5 - top diff --git a/docs/api.rst b/docs/api.rst index 695f497..9b9fe26 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:: displayio_dial :members: :member-order: bysource diff --git a/docs/conf.py b/docs/conf.py index c117a41..0e760eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT @@ -99,22 +97,9 @@ # -- Options for HTML output ---------------------------------------------- -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/examples/displayio_dial_simpletest.py b/examples/displayio_dial_simpletest.py index 37cada0..65e7a82 100644 --- a/examples/displayio_dial_simpletest.py +++ b/examples/displayio_dial_simpletest.py @@ -7,9 +7,11 @@ """ import time + import board import displayio import terminalio + from displayio_dial import Dial # Fonts used for the Dial tick labels @@ -47,7 +49,6 @@ step_size = 1 while True: - # run the dial from minimum to maximum for this_value in range(minimum_value, maximum_value + 1, step_size): my_dial.value = this_value diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..3a8f900 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,104 @@ +# 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 + "PLR0917", # too many positional args + "PLR0915", # too many statements + "PLR0912", # too many branches + "PLR0914", # too many locals +] + +[format] +line-ending = "lf"