Merge pull request #103 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

@@ -13,9 +13,9 @@ Adafruit CircuitPython BusDevice
     :target: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/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
 
 The ``I2CDevice`` and ``SPIDevice`` helper classes make managing transaction state
 on a bus easy. For example, they manage locking the bus to prevent other

README.rst

@@ -10,12 +10,12 @@
 import time
 
 try:
-    from typing import Optional, Type
     from types import TracebackType
-    from circuitpython_typing import ReadableBuffer, WriteableBuffer
+    from typing import Optional, Type
 
     # Used only for type annotations.
     from busio import I2C
+    from circuitpython_typing import ReadableBuffer, WriteableBuffer
 except ImportError:
     pass
 
@@ -61,9 +61,7 @@ def __init__(self, i2c: I2C, device_address: int, probe: bool = True) -> None:
         if probe:
             self.__probe_for_device()
 
-    def readinto(
-        self, buf: WriteableBuffer, *, start: int = 0, end: Optional[int] = None
-    ) -> None:
+    def readinto(self, buf: WriteableBuffer, *, start: int = 0, end: Optional[int] = None) -> None:
         """
         Read into ``buf`` from the device. The number of bytes read will be the
         length of ``buf``.
@@ -80,9 +78,7 @@ def readinto(
             end = len(buf)
         self.i2c.readfrom_into(self.device_address, buf, start=start, end=end)
 
-    def write(
-        self, buf: ReadableBuffer, *, start: int = 0, end: Optional[int] = None
-    ) -> None:
+    def write(self, buf: ReadableBuffer, *, start: int = 0, end: Optional[int] = None) -> None:
         """
         Write the bytes from ``buffer`` to the device, then transmit a stop
         bit.
@@ -99,7 +95,6 @@ def write(
             end = len(buf)
         self.i2c.writeto(self.device_address, buf, start=start, end=end)
 
-    # pylint: disable-msg=too-many-arguments
     def write_then_readinto(
         self,
         out_buffer: ReadableBuffer,
@@ -108,7 +103,7 @@ def write_then_readinto(
         out_start: int = 0,
         out_end: Optional[int] = None,
         in_start: int = 0,
-        in_end: Optional[int] = None
+        in_end: Optional[int] = None,
     ) -> None:
         """
         Write the bytes from ``out_buffer`` to the device, then immediately
@@ -147,8 +142,6 @@ def write_then_readinto(
             in_end=in_end,
         )
 
-    # pylint: enable-msg=too-many-arguments
-
     def __enter__(self) -> "I2CDevice":
         while not self.i2c.try_lock():
             time.sleep(0)
@@ -180,8 +173,6 @@ def __probe_for_device(self) -> None:
                 result = bytearray(1)
                 self.i2c.readfrom_into(self.device_address, result)
             except OSError:
-                # pylint: disable=raise-missing-from
                 raise ValueError("No I2C device at address: 0x%x" % self.device_address)
-                # pylint: enable=raise-missing-from
         finally:
             self.i2c.unlock()

adafruit_bus_device/i2c_device.py

@@ -2,8 +2,6 @@
 #
 # SPDX-License-Identifier: MIT
 
-# pylint: disable=too-few-public-methods
-
 """
 `adafruit_bus_device.spi_device` - SPI Bus Device
 ====================================================
@@ -12,8 +10,8 @@
 import time
 
 try:
-    from typing import Optional, Type
     from types import TracebackType
+    from typing import Optional, Type
 
     # Used only for type annotations.
     from busio import SPI
@@ -79,7 +77,7 @@ def __init__(
         baudrate: int = 100000,
         polarity: int = 0,
         phase: int = 0,
-        extra_clocks: int = 0
+        extra_clocks: int = 0,
     ) -> None:
         self.spi = spi
         self.baudrate = baudrate
@@ -94,9 +92,7 @@ def __init__(
     def __enter__(self) -> SPI:
         while not self.spi.try_lock():
             time.sleep(0)
-        self.spi.configure(
-            baudrate=self.baudrate, polarity=self.polarity, phase=self.phase
-        )
+        self.spi.configure(baudrate=self.baudrate, polarity=self.polarity, phase=self.phase)
         if self.chip_select:
             self.chip_select.value = self.cs_active_value
         return self.spi

adafruit_bus_device/spi_device.py

@@ -1,6 +1,9 @@
 
 .. If you created a package, create one automodule per module in the package.
 
+API Reference
+#############
+
 .. automodule:: adafruit_bus_device.i2c_device
    :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(".."))
 
@@ -49,9 +47,7 @@
 creation_year = "2016"
 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 and Tony Dicola for Adafruit Industries"
 author = "Scott Shawcroft and Tony Dicola"

docs/conf.py

@@ -1,8 +1,9 @@
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 # SPDX-License-Identifier: MIT
 
-import busio
 import board
+import busio
+
 from adafruit_bus_device.i2c_device import I2CDevice
 
 DEVICE_ADDRESS = 0x68  # device address of DS3231 board
@@ -17,4 +18,4 @@
     result = bytearray(1)
     bus_device.readinto(result)
 
-print("".join("{:02x}".format(x) for x in result))
+print("".join(f"{x:02x}" for x in result))

examples/busdevice_read_register_i2c_simpletest.py

@@ -1,9 +1,10 @@
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 # SPDX-License-Identifier: MIT
 
-import busio
 import board
+import busio
 import digitalio
+
 from adafruit_bus_device.spi_device import SPIDevice
 
 A_DEVICE_REGISTER = 0xD0  # device id register on the BMP280 board
@@ -13,10 +14,9 @@
 comm_port = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
 device = SPIDevice(comm_port, cs)
 
-# pylint: disable-msg=no-member
 with device as bus_device:
     bus_device.write(bytes([A_DEVICE_REGISTER]))
     result = bytearray(1)
     bus_device.readinto(result)
 
-print("".join("{:02x}".format(x) for x in result))
+print("".join(f"{x:02x}" for x in result))

examples/busdevice_read_register_spi_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"