Merge pull request #50 from FoamyGuy/use_ruff_and_remove_8x_compat

use ruff and remove 8x displayio compatibility

Author: tannewt

.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

.pylintrc

@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/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
 
 DisplayIO driver for SSD1306 monochrome displays. DisplayIO drivers enable terminal output
 

README.rst

@@ -33,34 +33,35 @@
   https://github.com/adafruit/circuitpython/releases
 
 """
+
+from busdisplay import BusDisplay
+
 try:
     from typing import Union
-    from busdisplay import BusDisplay
+
     from fourwire import FourWire
     from i2cdisplaybus import I2CDisplayBus
 except ImportError:
-    from displayio import FourWire
-    from displayio import I2CDisplay as I2CDisplayBus
-    from displayio import Display as BusDisplay
+    pass
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306.git"
 
 # Sequence from page 19 here: https://cdn-shop.adafruit.com/datasheets/UG-2864HSWEG01+user+guide.pdf
 _INIT_SEQUENCE = (
-    b"\xAE\x00"  # DISPLAY_OFF
+    b"\xae\x00"  # DISPLAY_OFF
     b"\x20\x01\x00"  # Set memory addressing to horizontal mode.
     b"\x81\x01\xcf"  # set contrast control
-    b"\xA1\x00"  # Column 127 is segment 0
-    b"\xA6\x00"  # Normal display
+    b"\xa1\x00"  # Column 127 is segment 0
+    b"\xa6\x00"  # Normal display
     b"\xc8\x00"  # Normal display
-    b"\xA8\x01\x3f"  # Mux ratio is 1/64
+    b"\xa8\x01\x3f"  # Mux ratio is 1/64
     b"\xd5\x01\x80"  # Set divide ratio
     b"\xd9\x01\xf1"  # Set pre-charge period
     b"\xda\x01\x12"  # Set com configuration
     b"\xdb\x01\x40"  # Set vcom configuration
     b"\x8d\x01\x14"  # Enable charge pump
-    b"\xAF\x00"  # DISPLAY_ON
+    b"\xaf\x00"  # DISPLAY_ON
 )
 
 
@@ -85,7 +86,7 @@ def __init__(self, bus: Union[FourWire, I2CDisplayBus], **kwargs) -> None:
         init_sequence[16] = height - 1  # patch mux ratio
         if height == 32 and width == 64:  # Make sure this only apply to that resolution
             init_sequence[16] = 64 - 1  # FORCED for 64x32 because it fail with formula
-        if height in (32, 16) and width != 64:
+        if height in {32, 16} and width != 64:
             init_sequence[25] = 0x02  # patch com configuration
         col_offset = (
             0 if width == 128 else (128 - width) // 2

adafruit_displayio_ssd1306.py

@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: adafruit_displayio_ssd1306
    :members:

docs/api.rst

@@ -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(".."))
 
@@ -27,7 +25,7 @@
 # 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"]
+autodoc_mock_imports = ["busdisplay", "fourwire", "i2cdisplaybus"]
 
 
 intersphinx_mapping = {
@@ -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 + " Scott Shawcroft"
 author = "Scott Shawcroft"

docs/conf.py

@@ -19,6 +19,7 @@
 
 import terminalio
 from adafruit_display_text import label
+
 import adafruit_displayio_ssd1306
 
 displayio.release_displays()

examples/displayio_ssd1306_64x32_simpletest.py

@@ -18,6 +18,7 @@
 
 import terminalio
 from adafruit_display_text import label
+
 import adafruit_displayio_ssd1306
 
 displayio.release_displays()

examples/displayio_ssd1306_featherwing.py

@@ -4,6 +4,7 @@
 # Coded for Circuit Python 8.1
 
 import time
+
 import board
 import displayio
 
@@ -16,8 +17,9 @@
 
 import busio
 import terminalio
-from adafruit_display_text import label
 from adafruit_bme280 import basic as adafruit_bme280
+from adafruit_display_text import label
+
 import adafruit_displayio_ssd1306 as ssd1306
 
 # Reinitalizes display upon any soft reboot or hard reset

examples/displayio_ssd1306_picowbell_tempsensor.py

@@ -9,19 +9,11 @@
 import board
 import displayio
 
-# Compatibility with both CircuitPython 8.x.x and 9.x.x.
-# Remove after 8.x.x is no longer a supported release.
-try:
-    from i2cdisplaybus import I2CDisplayBus
-
-    # from fourwire import FourWire
-except ImportError:
-    from displayio import I2CDisplay as I2CDisplayBus
-
-    # from displayio import FourWire
-
+# from fourwire import FourWire
 import terminalio
 from adafruit_display_text import label
+from i2cdisplaybus import I2CDisplayBus
+
 import adafruit_displayio_ssd1306
 
 displayio.release_displays()
@@ -61,16 +53,12 @@
 inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1)
 inner_palette = displayio.Palette(1)
 inner_palette[0] = 0x000000  # Black
-inner_sprite = displayio.TileGrid(
-    inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER
-)
+inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER)
 splash.append(inner_sprite)
 
 # Draw a label
 text = "Hello World!"
-text_area = label.Label(
-    terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT // 2 - 1
-)
+text_area = label.Label(terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT // 2 - 1)
 splash.append(text_area)
 
 while True:

examples/displayio_ssd1306_simpletest.py

@@ -0,0 +1,100 @@
+# 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
+
+]
+
+[format]
+line-ending = "lf"