Merge pull request #13 from adafruit/use_ruff

change to ruff

Author: FoamyGuy

.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

.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

@@ -17,9 +17,9 @@ Introduction
     :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
 
 Helper library for the Adafruit ESP32-S2 TFT Feather.
 

README.rst

@@ -28,13 +28,16 @@
 """
 
 import gc
+
 from adafruit_portalbase import PortalBase
-from .network import Network
+
 from .graphics import Graphics
+from .network import Network
 from .peripherals import Peripherals
 
 try:
-    from typing import Optional, Dict, Union, Callable, Sequence, List
+    from typing import Callable, Dict, List, Optional, Sequence, Union
+
     from neopixel import NeoPixel
 except ImportError:
     pass
@@ -69,7 +72,6 @@ class ESP32S2TFT(PortalBase):
 
     """
 
-    # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements
     def __init__(
         self,
         *,
@@ -83,7 +85,7 @@ def __init__(
         rotation: int = 0,
         scale: int = 1,
         debug: bool = False,
-        use_network: bool = True
+        use_network: bool = True,
     ) -> None:
         if use_network:
             network = Network(

adafruit_esp32s2tft/__init__.py

@@ -44,14 +44,8 @@ class Graphics(GraphicsBase):
 
     """
 
-    # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements, too-few-public-methods
     def __init__(
-        self,
-        *,
-        default_bg: int = 0,
-        rotation: int = 0,
-        scale: int = 1,
-        debug: bool = False
+        self, *, default_bg: int = 0, rotation: int = 0, scale: int = 1, debug: bool = False
     ) -> None:
         self._debug = debug
         self.display = board.DISPLAY

adafruit_esp32s2tft/graphics.py

@@ -28,14 +28,16 @@
 """
 
 import ssl
+
 from adafruit_portalbase.network import NetworkBase
 from adafruit_portalbase.wifi_esp32s2 import WiFi
 
 try:
-    from typing import Optional, Union, Callable
-    from neopixel import NeoPixel
-    from adafruit_io.adafruit_io import IO_MQTT
+    from typing import Callable, Optional, Union
+
     import adafruit_minimqtt.adafruit_minimqtt as MQTT
+    from adafruit_io.adafruit_io import IO_MQTT
+    from neopixel import NeoPixel
 except ImportError:
     pass
 
@@ -56,7 +58,6 @@ class Network(NetworkBase):
 
     """
 
-    # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements
     def __init__(
         self,
         *,
@@ -75,14 +76,13 @@ def init_io_mqtt(self) -> IO_MQTT:
         """Initialize MQTT for Adafruit IO"""
         aio_username = self._get_setting["ADAFRUIT_AIO_USERNAME"]
         aio_key = self._get_setting["ADAFRUIT_AIO_KEY"]
-        if None in [aio_username, aio_key]:
+        if aio_username is None or aio_key is None:
             raise AttributeError(
                 "Adafruit IO keys are kept in settings.toml, please add them there."
             )
 
         return self.init_mqtt(IO_MQTT_BROKER, 8883, aio_username, aio_key, True)
 
-    # pylint: disable=too-many-arguments
     def init_mqtt(
         self,
         broker: str,
@@ -106,16 +106,12 @@ def init_mqtt(
 
         return self._mqtt_client
 
-    # pylint: enable=too-many-arguments
-
     def _get_mqtt_client(self) -> Union[MQTT.MQTT, IO_MQTT]:
         if self._mqtt_client is not None:
             return self._mqtt_client
         raise RuntimeError("Please initialize MQTT before using")
 
-    def mqtt_loop(
-        self, *args: int, suppress_mqtt_errors: bool = True, **kwargs: int
-    ) -> None:
+    def mqtt_loop(self, *args: int, suppress_mqtt_errors: bool = True, **kwargs: int) -> None:
         """Run the MQTT Loop"""
         self._get_mqtt_client()
         if suppress_mqtt_errors:
@@ -126,9 +122,8 @@ def mqtt_loop(
                 print(f"MMQTTException: {err}")
             except OSError as err:
                 print(f"OSError: {err}")
-        else:
-            if self._mqtt_client is not None:
-                self._mqtt_client.loop(*args, **kwargs)
+        elif self._mqtt_client is not None:
+            self._mqtt_client.loop(*args, **kwargs)
 
     def mqtt_publish(
         self,
@@ -144,13 +139,10 @@ def mqtt_publish(
                     self._mqtt_client.publish(*args, **kwargs)
             except OSError as err:
                 print(f"OSError: {err}")
-        else:
-            if self._mqtt_client is not None:
-                self._mqtt_client.publish(*args, **kwargs)
+        elif self._mqtt_client is not None:
+            self._mqtt_client.publish(*args, **kwargs)
 
-    def mqtt_connect(
-        self, *args: Union[bool, str, int], **kwargs: Union[bool, str, int]
-    ) -> None:
+    def mqtt_connect(self, *args: Union[bool, str, int], **kwargs: Union[bool, str, int]) -> None:
         """Connect to MQTT"""
         self._get_mqtt_client()
         if self._mqtt_client is not None:

adafruit_esp32s2tft/network.py

@@ -28,9 +28,8 @@
 """
 
 import board
-from digitalio import DigitalInOut, Direction, Pull
 import neopixel
-
+from digitalio import DigitalInOut, Direction, Pull
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ESP32S2TFT.git"
@@ -45,7 +44,6 @@ class Peripherals:
             See https://circuitpython.readthedocs.io/projects/neopixel/en/latest/api.html
     """
 
-    # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements
     def __init__(self) -> None:
         # Neopixel
         self.neopixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.3)

adafruit_esp32s2tft/peripherals.py

@@ -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_esp32s2tft
     :members:
 

docs/api.rst

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -57,9 +55,7 @@
 creation_year = "2022"
 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 + " Melissa LeBlanc-Williams"
 author = "Melissa LeBlanc-Williams"

docs/conf.py

@@ -4,15 +4,15 @@
 # SPDX-License-Identifier: Unlicense
 
 import random
+
 from rainbowio import colorwheel
+
 from adafruit_esp32s2tft import ESP32S2TFT
 
 esp32s2tft = ESP32S2TFT(default_bg=0xFFFF00, scale=2, use_network=False)
 
 # Create the labels
-esp32s2tft.add_text(
-    text="ESP32-S2", text_position=(10, 10), text_scale=2, text_color=0xFF00FF
-)
+esp32s2tft.add_text(text="ESP32-S2", text_position=(10, 10), text_scale=2, text_color=0xFF00FF)
 esp32s2tft.add_text(
     text="TFT Feather",
     text_position=(60, 30),
@@ -29,9 +29,7 @@
 esp32s2tft.display.root_group = esp32s2tft.splash
 
 while True:
-    esp32s2tft.set_text_color(
-        0xFF0000 if esp32s2tft.peripherals.button else 0x606060, button_label
-    )
+    esp32s2tft.set_text_color(0xFF0000 if esp32s2tft.peripherals.button else 0x606060, button_label)
     esp32s2tft.peripherals.led = esp32s2tft.peripherals.button
     if esp32s2tft.peripherals.button:
         esp32s2tft.peripherals.neopixel[0] = colorwheel(random.randint(0, 255))

examples/esp32s2tft_simpletest.py

@@ -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"