Merge pull request #51 from FoamyGuy/use_ruff

Use 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,22 @@
 # SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v3.3.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse

README.rst

@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Button/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
 
 UI Buttons for displayio
 

adafruit_button/__init__.py

@@ -20,4 +20,5 @@
   https://github.com/adafruit/circuitpython/releases
 
 """
+
 from adafruit_button.button import Button

adafruit_button/button.py

@@ -22,15 +22,17 @@
 
 """
 
-from micropython import const
 from adafruit_display_shapes.rect import Rect
 from adafruit_display_shapes.roundrect import RoundRect
+from micropython import const
+
 from adafruit_button.button_base import ButtonBase, _check_color
 
 try:
-    from typing import Optional, Union, Tuple
-    from fontio import FontProtocol
+    from typing import Optional, Tuple, Union
+
     from displayio import Group
+    from fontio import FontProtocol
 except ImportError:
     pass
 
@@ -39,7 +41,6 @@
 
 
 class Button(ButtonBase):
-    # pylint: disable=too-many-instance-attributes, too-many-locals
     """Helper class for creating UI buttons for ``displayio``. Provides the following
     buttons:
     RECT: A rectangular button. SHAWDOWRECT adds a drop shadow.
@@ -100,9 +101,7 @@ def _create_body(self) -> None:
                     outline=self._outline_color,
                 )
             elif self.style == Button.SHADOWRECT:
-                self.shadow = Rect(
-                    2, 2, self.width - 2, self.height - 2, fill=self.outline_color
-                )
+                self.shadow = Rect(2, 2, self.width - 2, self.height - 2, fill=self.outline_color)
                 self.body = Rect(
                     0,
                     0,
@@ -137,7 +136,7 @@ def _create_body(self) -> None:
     SHADOWRECT = const(2)
     SHADOWROUNDRECT = const(3)
 
-    def __init__(
+    def __init__(  # noqa: PLR0913 Too many arguments
         self,
         *,
         x: int,
@@ -154,7 +153,7 @@ def __init__(
         selected_fill: Optional[Union[int, Tuple[int, int, int]]] = None,
         selected_outline: Optional[Union[int, Tuple[int, int, int]]] = None,
         selected_label: Optional[Union[int, Tuple[int, int, int]]] = None,
-        label_scale: Optional[int] = 1
+        label_scale: Optional[int] = 1,
     ):
         super().__init__(
             x=x,

adafruit_button/button_base.py

@@ -21,12 +21,14 @@
   https://github.com/adafruit/circuitpython/releases
 
 """
+
+import terminalio
 from adafruit_display_text.bitmap_label import Label
 from displayio import Group
-import terminalio
 
 try:
-    from typing import Optional, Union, Tuple
+    from typing import Optional, Tuple, Union
+
     from fontio import FontProtocol
 except ImportError:
     pass
@@ -41,7 +43,6 @@ def _check_color(color: Optional[Union[int, tuple[int, int, int]]]) -> int:
 
 
 class ButtonBase(Group):
-    # pylint: disable=too-many-instance-attributes
     """Superclass for creating UI buttons for ``displayio``.
 
     :param int x: The x position of the button.
@@ -60,7 +61,7 @@ class ButtonBase(Group):
     :param Optional[int] label_scale: The scale factor used for the label. Defaults to 1.
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913 Too many arguments
         self,
         *,
         x: int,
@@ -109,20 +110,16 @@ def label(self, newtext: str) -> None:
         dims[2] *= self._label.scale
         dims[3] *= self._label.scale
         if dims[2] >= self.width or dims[3] >= self.height:
-            while len(self._label.text) > 1 and (
-                dims[2] >= self.width or dims[3] >= self.height
-            ):
-                self._label.text = "{}.".format(self._label.text[:-2])
+            while len(self._label.text) > 1 and (dims[2] >= self.width or dims[3] >= self.height):
+                self._label.text = f"{self._label.text[:-2]}."
                 dims = list(self._label.bounding_box)
                 dims[2] *= self._label.scale
                 dims[3] *= self._label.scale
             if len(self._label.text) <= 1:
                 raise RuntimeError("Button not large enough for label")
         self._label.x = (self.width - dims[2]) // 2
         self._label.y = self.height // 2
-        self._label.color = (
-            self._label_color if not self.selected else self._selected_label
-        )
+        self._label.color = self._label_color if not self.selected else self._selected_label
         self.append(self._label)
 
         if (self.selected_label is None) and (self._label_color is not None):

adafruit_button/sprite_button.py

@@ -21,12 +21,15 @@
   https://github.com/adafruit/circuitpython/releases
 
 """
-from adafruit_imageload.tilegrid_inflator import inflate_tilegrid
+
 from adafruit_imageload import load
+from adafruit_imageload.tilegrid_inflator import inflate_tilegrid
+
 from adafruit_button.button_base import ButtonBase
 
 try:
-    from typing import Optional, Union, Tuple
+    from typing import Optional, Tuple, Union
+
     from fontio import FontProtocol
 except ImportError:
     pass
@@ -56,7 +59,7 @@ class SpriteButton(ButtonBase):
     :param Optional[int] label_scale: The scale multiplier of the button label. Defaults to 1.
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913 Too many arguments
         self,
         *,
         x: int,
@@ -71,7 +74,7 @@ def __init__(
         bmp_path: str = None,
         selected_bmp_path: Optional[str] = None,
         transparent_index: Optional[Union[int, Tuple]] = None,
-        label_scale: Optional[int] = 1
+        label_scale: Optional[int] = 1,
     ):
         if bmp_path is None:
             raise ValueError("Please supply bmp_path. It cannot be None.")

docs/conf.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -48,9 +46,7 @@
 creation_year = "2019"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Limor Fried"
 author = "Limor Fried"

examples/display_button_color_properties.py

@@ -6,10 +6,11 @@
 properties after the button has been initialized.
 """
 
+import adafruit_touchscreen
 import board
 import displayio
 import terminalio
-import adafruit_touchscreen
+
 from adafruit_button import Button
 
 # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)

examples/display_button_customfont.py

@@ -5,10 +5,12 @@
 """
 
 import os
+
+import adafruit_touchscreen
 import board
 import displayio
 from adafruit_bitmap_font import bitmap_font
-import adafruit_touchscreen
+
 from adafruit_button import Button
 
 # use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)