From 5f6acbb376fb644121ca6d7e1ab2e0cdb8f4ac58 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 20 Feb 2024 08:20:32 -0600 Subject: [PATCH 01/11] allow usage of ColorConverter with Bitmap saving --- adafruit_bitmapsaver.py | 97 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 91 insertions(+), 6 deletions(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index 936830b..fd57d93 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -31,7 +31,7 @@ import gc import struct import board -from displayio import Bitmap, Palette, Display +from displayio import Bitmap, Palette, Display, ColorConverter try: from typing import Tuple, Optional, Union @@ -81,11 +81,88 @@ def _rgb565_to_bgr_tuple(color: int) -> Tuple[int, int, int]: return blue, green, red +def rgb565_unpack(packed_rgb: int) -> tuple[int, int, int]: + """ + Convert an int representing a hex rgb565 color into a tuple + of it's r, g, and b values. + :param packed_rgb: rgb565 color value as an int + :return: Tuple with r, g, and b values + """ + r = (packed_rgb >> 11) & 0x1F + g = (packed_rgb >> 5) & 0x3F + b = packed_rgb & 0x1F + return (r, g, b) + + +def rgb565_pack(r: int, g: int, b: int) -> int: + """ + Convert a tuple with r, g, and b values into an rgb565 + color value represented as an integer + :param r: red value + :param g: green value + :param b: blue value + :return int: rgb565 value + """ + return ((r & 0x1F) << 11) | ((g & 0x3F) << 5) | (b & 0x1F) + + +def rgb888_unpack(packed_rgb: int) -> Tuple[int, int, int]: + """ + Convert an int representing an rgb888 color value into a + tuple containing it's r, g, and b values. + :param packed_rgb: rgb888 integer color value + :return: Tuple containing r, g, and b values + """ + r = (packed_rgb >> 16) & 0xFF + g = (packed_rgb >> 8) & 0xFF + b = packed_rgb & 0xFF + return (r, g, b) + + +def rgb888_pack(r, g, b): + """ + Convert a tuple with r, g, and b values into an rgb888 + color value represented as an integer + :param r: red value + :param g: green value + :param b: blue value + :return int: rgb888 value + """ + return ((r & 0xFF) << 16) | ((g & 0xFF) << 8) | (b & 0xFF) + + +def rgb565_to_rgb888(rgb565): + """ + Convert from an integer representing rgb565 color into an integer + representing rgb888 color. + :param rgb565: Color to convert + :return int: rgb888 color value + """ + # Shift the red value to the right by 11 bits. + red5 = rgb565 >> 11 + # Shift the green value to the right by 5 bits and extract the lower 6 bits. + green6 = (rgb565 >> 5) & 0b111111 + # Extract the lower 5 bits for blue. + blue5 = rgb565 & 0b11111 + + # Convert 5-bit red to 8-bit red. + red8 = round(red5 / 31 * 255) + # Convert 6-bit green to 8-bit green. + green8 = round(green6 / 63 * 255) + # Convert 5-bit blue to 8-bit blue. + blue8 = round(blue5 / 31 * 255) + + # Combine the RGB888 values into a single integer + rgb888_value = (red8 << 16) | (green8 << 8) | blue8 + + return rgb888_value + + # pylint:disable=too-many-locals def _write_pixels( output_file: BufferedWriter, pixel_source: Union[Bitmap, Display], - palette: Optional[Palette], + palette: Optional[Union[Palette, ColorConverter]], ) -> None: saving_bitmap = isinstance(pixel_source, Bitmap) width, height = _rotated_height_and_width(pixel_source) @@ -97,7 +174,13 @@ def _write_pixels( # pixel_source: Bitmap for x in range(width): pixel = pixel_source[x, y - 1] - color = palette[pixel] # handled by save_pixel's guardians + if isinstance(palette, Palette): + color = palette[pixel] # handled by save_pixel's guardians + elif isinstance(palette, ColorConverter): + converted = palette.convert(pixel) + converted_888 = rgb565_to_rgb888(converted) + color = converted_888 + for _ in range(3): row_buffer[buffer_index] = color & 0xFF color >>= 8 @@ -124,7 +207,7 @@ def _write_pixels( def save_pixels( file_or_filename: Union[str, BufferedWriter], pixel_source: Union[Display, Bitmap] = None, - palette: Optional[Palette] = None, + palette: Optional[Union[Palette, ColorConverter]] = None, ) -> None: """Save pixels to a 24 bit per pixel BMP file. If pixel_source if a displayio.Bitmap, save it's pixels through palette. @@ -140,8 +223,10 @@ def save_pixels( pixel_source = board.DISPLAY if isinstance(pixel_source, Bitmap): - if not isinstance(palette, Palette): - raise ValueError("Third argument must be a Palette for a Bitmap save") + if not isinstance(palette, Palette) and not isinstance(palette, ColorConverter): + raise ValueError( + "Third argument must be a Palette or ColorConverter for a Bitmap save" + ) elif not isinstance(pixel_source, Display): raise ValueError("Second argument must be a Bitmap or Display") try: From c1df2a6dac8177e5874915e3ba530aceeb409e99 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 20 Feb 2024 11:07:09 -0600 Subject: [PATCH 02/11] remove unused functions --- adafruit_bitmapsaver.py | 50 ----------------------------------------- 1 file changed, 50 deletions(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index fd57d93..d01685f 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -81,56 +81,6 @@ def _rgb565_to_bgr_tuple(color: int) -> Tuple[int, int, int]: return blue, green, red -def rgb565_unpack(packed_rgb: int) -> tuple[int, int, int]: - """ - Convert an int representing a hex rgb565 color into a tuple - of it's r, g, and b values. - :param packed_rgb: rgb565 color value as an int - :return: Tuple with r, g, and b values - """ - r = (packed_rgb >> 11) & 0x1F - g = (packed_rgb >> 5) & 0x3F - b = packed_rgb & 0x1F - return (r, g, b) - - -def rgb565_pack(r: int, g: int, b: int) -> int: - """ - Convert a tuple with r, g, and b values into an rgb565 - color value represented as an integer - :param r: red value - :param g: green value - :param b: blue value - :return int: rgb565 value - """ - return ((r & 0x1F) << 11) | ((g & 0x3F) << 5) | (b & 0x1F) - - -def rgb888_unpack(packed_rgb: int) -> Tuple[int, int, int]: - """ - Convert an int representing an rgb888 color value into a - tuple containing it's r, g, and b values. - :param packed_rgb: rgb888 integer color value - :return: Tuple containing r, g, and b values - """ - r = (packed_rgb >> 16) & 0xFF - g = (packed_rgb >> 8) & 0xFF - b = packed_rgb & 0xFF - return (r, g, b) - - -def rgb888_pack(r, g, b): - """ - Convert a tuple with r, g, and b values into an rgb888 - color value represented as an integer - :param r: red value - :param g: green value - :param b: blue value - :return int: rgb888 value - """ - return ((r & 0xFF) << 16) | ((g & 0xFF) << 8) | (b & 0xFF) - - def rgb565_to_rgb888(rgb565): """ Convert from an integer representing rgb565 color into an integer From 0df8c44e02d5511df34c8219ebdf8c50a71a03c1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 03/11] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 971fb4e..0262580 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # 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, From 1befbbb1018c4009ba754a2ea07eb24428a30dd1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 04/11] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From b4c5f77ceec8dfc2968a0bfbdee7b6ba14a8fe5f Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Wed, 12 Feb 2025 15:45:40 -0600 Subject: [PATCH 05/11] Update how board.DISPLAY is checked Historically, boards with no built-in display have not had a `board.DISPLAY` property. Soon, with https://github.com/adafruit/circuitpython/pull/10028, any board with displayio will have a `board.DISPLAY` property. This property will be `None` if no display is configured, or a truthy non-`None` value if a display is configured (including dynamically at runtime). This revised check will work on both old and new circuitpython versions. --- adafruit_bitmapsaver.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index d01685f..4b7d892 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -168,7 +168,7 @@ def save_pixels( :param palette: the Palette to use for looking up colors in the bitmap """ if not pixel_source: - if not hasattr(board, "DISPLAY"): + if not getattr(board, "DISPLAY", None): raise ValueError("Second argument must be a Bitmap or Display") pixel_source = board.DISPLAY From ef436d2b2e1875a0591d18b5e12041ae432a6d5c Mon Sep 17 00:00:00 2001 From: Neradoc Date: Wed, 2 Apr 2025 05:13:37 +0200 Subject: [PATCH 06/11] update to CP 10 with busdisplay --- adafruit_bitmapsaver.py | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index 4b7d892..d8b5f19 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -8,7 +8,7 @@ ================================================================================ Save a displayio.Bitmap (and associated displayio.Palette) in a BMP file. -Make a screenshot (the contents of a displayio.Display) and save in a BMP file. +Make a screenshot (the contents of a busdisplay.BusDisplay) and save in a BMP file. * Author(s): Dave Astels, Matt Land @@ -26,12 +26,17 @@ """ -# imports +# pylint: disable=ungrouped-imports import gc import struct import board -from displayio import Bitmap, Palette, Display, ColorConverter +from displayio import Bitmap, Palette, ColorConverter + +try: + from busdisplay import BusDisplay +except ImportError: + from displayio import Display as BusDisplay try: from typing import Tuple, Optional, Union @@ -67,9 +72,11 @@ def _bytes_per_row(source_width: int) -> int: return pixel_bytes + padding_bytes -def _rotated_height_and_width(pixel_source: Union[Bitmap, Display]) -> Tuple[int, int]: +def _rotated_height_and_width( + pixel_source: Union[Bitmap, BusDisplay] +) -> Tuple[int, int]: # flip axis if the display is rotated - if isinstance(pixel_source, Display) and (pixel_source.rotation % 180 != 0): + if isinstance(pixel_source, BusDisplay) and (pixel_source.rotation % 180 != 0): return pixel_source.height, pixel_source.width return pixel_source.width, pixel_source.height @@ -111,7 +118,7 @@ def rgb565_to_rgb888(rgb565): # pylint:disable=too-many-locals def _write_pixels( output_file: BufferedWriter, - pixel_source: Union[Bitmap, Display], + pixel_source: Union[Bitmap, BusDisplay], palette: Optional[Union[Palette, ColorConverter]], ) -> None: saving_bitmap = isinstance(pixel_source, Bitmap) @@ -156,7 +163,7 @@ def _write_pixels( def save_pixels( file_or_filename: Union[str, BufferedWriter], - pixel_source: Union[Display, Bitmap] = None, + pixel_source: Union[BusDisplay, Bitmap] = None, palette: Optional[Union[Palette, ColorConverter]] = None, ) -> None: """Save pixels to a 24 bit per pixel BMP file. @@ -177,7 +184,7 @@ def save_pixels( raise ValueError( "Third argument must be a Palette or ColorConverter for a Bitmap save" ) - elif not isinstance(pixel_source, Display): + elif not isinstance(pixel_source, BusDisplay): raise ValueError("Second argument must be a Bitmap or Display") try: if isinstance(file_or_filename, str): From b75aac874d6d860d4e7689587e1aee62213da54a Mon Sep 17 00:00:00 2001 From: Neradoc Date: Wed, 2 Apr 2025 05:15:59 +0200 Subject: [PATCH 07/11] no need to keep compatibility with 8.x --- adafruit_bitmapsaver.py | 8 ++------ docs/api.rst | 6 ++---- docs/conf.py | 9 ++++++++- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index d8b5f19..f59d319 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -26,17 +26,13 @@ """ -# pylint: disable=ungrouped-imports +# imports import gc import struct import board from displayio import Bitmap, Palette, ColorConverter - -try: - from busdisplay import BusDisplay -except ImportError: - from displayio import Display as BusDisplay +from busdisplay import BusDisplay try: from typing import Tuple, Optional, Union diff --git a/docs/api.rst b/docs/api.rst index 1819110..92e264a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,6 @@ -.. If you created a package, create one automodule per module in the package. - -.. 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_bitmapsaver :members: diff --git a/docs/conf.py b/docs/conf.py index 0262580..fa91348 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,14 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["displayio", "digitalio", "busio", "board"] +autodoc_mock_imports = [ + "busdisplay", + "displayio", + "digitalio", + "busio", + "board", + "framebufferio", +] intersphinx_mapping = { From 8967ac35e6db858ce736705ed1cdad2bdf4ee7b6 Mon Sep 17 00:00:00 2001 From: Neradoc Date: Wed, 2 Apr 2025 15:52:03 +0200 Subject: [PATCH 08/11] don't import display classes, use hasattr() --- adafruit_bitmapsaver.py | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index f59d319..ce3b82e 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -32,11 +32,13 @@ import struct import board from displayio import Bitmap, Palette, ColorConverter -from busdisplay import BusDisplay + try: from typing import Tuple, Optional, Union from io import BufferedWriter + from busdisplay import BusDisplay + from framebufferio import FramebufferDisplay except ImportError: pass @@ -69,10 +71,10 @@ def _bytes_per_row(source_width: int) -> int: def _rotated_height_and_width( - pixel_source: Union[Bitmap, BusDisplay] + pixel_source: Union[Bitmap, BusDisplay, FramebufferDisplay] ) -> Tuple[int, int]: # flip axis if the display is rotated - if isinstance(pixel_source, BusDisplay) and (pixel_source.rotation % 180 != 0): + if hasattr(pixel_source, "rotation") and (pixel_source.rotation % 180 != 0): return pixel_source.height, pixel_source.width return pixel_source.width, pixel_source.height @@ -114,7 +116,7 @@ def rgb565_to_rgb888(rgb565): # pylint:disable=too-many-locals def _write_pixels( output_file: BufferedWriter, - pixel_source: Union[Bitmap, BusDisplay], + pixel_source: Union[Bitmap, BusDisplay, FramebufferDisplay], palette: Optional[Union[Palette, ColorConverter]], ) -> None: saving_bitmap = isinstance(pixel_source, Bitmap) @@ -139,7 +141,7 @@ def _write_pixels( color >>= 8 buffer_index += 1 else: - # pixel_source: Display + # pixel_source: display result_buffer = bytearray(2048) data = pixel_source.fill_row(y - 1, result_buffer) for i in range(width): @@ -159,15 +161,17 @@ def _write_pixels( def save_pixels( file_or_filename: Union[str, BufferedWriter], - pixel_source: Union[BusDisplay, Bitmap] = None, + pixel_source: Union[BusDisplay, FramebufferDisplay, Bitmap] = None, palette: Optional[Union[Palette, ColorConverter]] = None, ) -> None: """Save pixels to a 24 bit per pixel BMP file. If pixel_source if a displayio.Bitmap, save it's pixels through palette. - If it's a displayio.Display, a palette isn't required. + If it's a displayio display, a palette isn't required. To be supported, + a display must implement `busdisplay.BusDisplay.fill_row`. Known supported + display types are `busdisplay.BusDisplay` and `framebufferio.FramebufferDisplay`. :param file_or_filename: either the file to save to, or it's absolute name - :param pixel_source: the Bitmap or Display to save + :param pixel_source: the Bitmap or display to save :param palette: the Palette to use for looking up colors in the bitmap """ if not pixel_source: @@ -180,8 +184,8 @@ def save_pixels( raise ValueError( "Third argument must be a Palette or ColorConverter for a Bitmap save" ) - elif not isinstance(pixel_source, BusDisplay): - raise ValueError("Second argument must be a Bitmap or Display") + elif not hasattr(pixel_source, "fill_row"): + raise ValueError("Second argument must be a Bitmap or supported display type") try: if isinstance(file_or_filename, str): output_file = open( # pylint: disable=consider-using-with From a753015e90917846a159cba81b471c1c02b65aea Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 15 May 2025 20:52:40 +0000 Subject: [PATCH 09/11] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------ README.rst | 6 +- adafruit_bitmapsaver.py | 21 +- docs/conf.py | 8 +- examples/bitmapsaver_screenshot_simpletest.py | 5 +- .../bitmapsaver_screenshot_tft_featherwing.py | 5 +- examples/bitmapsaver_simpletest.py | 7 +- ruff.toml | 107 +++++ 10 files changed, 151 insertions(+), 461 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 ca329db..aec1e18 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BitmapSaver/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 Save a displayio.Bitmap (and associated displayio.Palette) into a BMP file. diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index ce3b82e..37d32ee 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -30,13 +30,14 @@ import gc import struct -import board -from displayio import Bitmap, Palette, ColorConverter +import board +from displayio import Bitmap, ColorConverter, Palette try: - from typing import Tuple, Optional, Union from io import BufferedWriter + from typing import Optional, Tuple, Union + from busdisplay import BusDisplay from framebufferio import FramebufferDisplay except ImportError: @@ -71,7 +72,7 @@ def _bytes_per_row(source_width: int) -> int: def _rotated_height_and_width( - pixel_source: Union[Bitmap, BusDisplay, FramebufferDisplay] + pixel_source: Union[Bitmap, BusDisplay, FramebufferDisplay], ) -> Tuple[int, int]: # flip axis if the display is rotated if hasattr(pixel_source, "rotation") and (pixel_source.rotation % 180 != 0): @@ -113,7 +114,6 @@ def rgb565_to_rgb888(rgb565): return rgb888_value -# pylint:disable=too-many-locals def _write_pixels( output_file: BufferedWriter, pixel_source: Union[Bitmap, BusDisplay, FramebufferDisplay], @@ -156,9 +156,6 @@ def _write_pixels( gc.collect() -# pylint:enable=too-many-locals - - def save_pixels( file_or_filename: Union[str, BufferedWriter], pixel_source: Union[BusDisplay, FramebufferDisplay, Bitmap] = None, @@ -181,16 +178,12 @@ def save_pixels( if isinstance(pixel_source, Bitmap): if not isinstance(palette, Palette) and not isinstance(palette, ColorConverter): - raise ValueError( - "Third argument must be a Palette or ColorConverter for a Bitmap save" - ) + raise ValueError("Third argument must be a Palette or ColorConverter for a Bitmap save") elif not hasattr(pixel_source, "fill_row"): raise ValueError("Second argument must be a Bitmap or supported display type") try: if isinstance(file_or_filename, str): - output_file = open( # pylint: disable=consider-using-with - file_or_filename, "wb" - ) + output_file = open(file_or_filename, "wb") else: output_file = file_or_filename diff --git a/docs/conf.py b/docs/conf.py index fa91348..2aab4c4 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("..")) @@ -55,9 +53,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 + " Dave Astels" author = "Dave Astels" diff --git a/examples/bitmapsaver_screenshot_simpletest.py b/examples/bitmapsaver_screenshot_simpletest.py index 49c426f..ff1b750 100644 --- a/examples/bitmapsaver_screenshot_simpletest.py +++ b/examples/bitmapsaver_screenshot_simpletest.py @@ -4,11 +4,12 @@ """Example of taking a screenshot.""" # pylint:disable=invalid-name +import adafruit_sdcard import board -import digitalio import busio -import adafruit_sdcard +import digitalio import storage + from adafruit_bitmapsaver import save_pixels TAKE_SCREENSHOT = False # Set to True to take a screenshot diff --git a/examples/bitmapsaver_screenshot_tft_featherwing.py b/examples/bitmapsaver_screenshot_tft_featherwing.py index d279fb4..2f69bd4 100644 --- a/examples/bitmapsaver_screenshot_tft_featherwing.py +++ b/examples/bitmapsaver_screenshot_tft_featherwing.py @@ -1,14 +1,15 @@ # SPDX-FileCopyrightText: 2023 DJDevon3 # SPDX-License-Identifier: MIT -""" Screenshot on a 3.5" TFT Featherwing (integrated SD Card) """ +"""Screenshot on a 3.5" TFT Featherwing (integrated SD Card)""" # pylint:disable=invalid-name +import adafruit_sdcard import board import digitalio import displayio -import adafruit_sdcard import storage from adafruit_hx8357 import HX8357 + from adafruit_bitmapsaver import save_pixels displayio.release_displays() diff --git a/examples/bitmapsaver_simpletest.py b/examples/bitmapsaver_simpletest.py index d4ecb75..1b53054 100644 --- a/examples/bitmapsaver_simpletest.py +++ b/examples/bitmapsaver_simpletest.py @@ -3,12 +3,13 @@ """Example of using save_bitmap""" # pylint:disable=invalid-name +import adafruit_sdcard import board import busio import digitalio -from displayio import Bitmap, Palette -import adafruit_sdcard import storage +from displayio import Bitmap, Palette + from adafruit_bitmapsaver import save_pixels TAKE_SCREENSHOT = False # Set True to take a screenshot @@ -33,7 +34,7 @@ for x in range(16): for y in range(16): - if x == 0 or y == 0 or x == 15 or y == 15: + if x in {0, 15} or y in {0, 15}: bitmap[x, y] = 1 elif x == y: bitmap[x, y] = 4 diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..1b887b1 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel +] + +[format] +line-ending = "lf" From 7cdfdc69fdd12de75ce5597559e16c03b710cac3 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 31 May 2025 10:58:20 -0500 Subject: [PATCH 10/11] displayio api updates --- examples/bitmapsaver_screenshot_tft_featherwing.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/bitmapsaver_screenshot_tft_featherwing.py b/examples/bitmapsaver_screenshot_tft_featherwing.py index 2f69bd4..fe187f4 100644 --- a/examples/bitmapsaver_screenshot_tft_featherwing.py +++ b/examples/bitmapsaver_screenshot_tft_featherwing.py @@ -7,6 +7,7 @@ import board import digitalio import displayio +import fourwire import storage from adafruit_hx8357 import HX8357 @@ -26,7 +27,7 @@ # Initialize TFT Featherwing Display tft_cs = board.D9 tft_dc = board.D10 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs) +display_bus = fourwire.FourWire(spi, command=tft_dc, chip_select=tft_cs) display = HX8357(display_bus, width=DISPLAY_WIDTH, height=DISPLAY_HEIGHT) if TAKE_SCREENSHOT: From 005d9cb3369d024b2573d9cc299c2da98d27d3c8 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 11/11] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy