adafruit · FoamyGuy · May 14, 2025 · May 14, 2025
diff --git a/.gitattributes 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
@@ -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
diff --git a/README.rst b/README.rst
@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_FRAM/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
 
 CircuitPython/Python library to support the I2C and SPI FRAM Breakouts.
 

diff --git a/adafruit_fram.py b/adafruit_fram.py
@@ -32,9 +32,10 @@
 from micropython import const
 
 try:
-    from typing import Optional, Union, Sequence
-    from digitalio import DigitalInOut
+    from typing import Optional, Sequence, Union
+
     from busio import I2C, SPI
+    from digitalio import DigitalInOut
 except ImportError:
     pass
 
@@ -144,9 +145,7 @@ def __getitem__(self, address: Union[int, slice]) -> bytearray:
         if isinstance(address, int):
             if not 0 <= address < self._max_size:
                 raise ValueError(
-                    "Address '{0}' out of range. It must be 0 <= address < {1}.".format(
-                        address, self._max_size
-                    )
+                    f"Address '{address}' out of range. It must be 0 <= address < {self._max_size}."
                 )
             buffer = bytearray(1)
             read_buffer = self._read_address(address, buffer)
@@ -163,7 +162,7 @@ def __getitem__(self, address: Union[int, slice]) -> bytearray:
             if regs[0] < 0 or (regs[0] + len(regs)) > self._max_size:
                 raise ValueError(
                     "Address slice out of range. It must be 0 <= [starting address"
-                    ":stopping address] < {0}.".format(self._max_size)
+                    f":stopping address] < {self._max_size}."
                 )
 
             buffer = bytearray(len(regs))
@@ -190,43 +189,34 @@ def __setitem__(self, address: Union[int, slice], value: Union[int, Sequence[int
                 raise ValueError("Data stored in an address must be an integer 0-255")
             if not 0 <= address < self._max_size:
                 raise ValueError(
-                    "Address '{0}' out of range. It must be 0 <= address < {1}.".format(
-                        address, self._max_size
-                    )
+                    f"Address '{address}' out of range. It must be 0 <= address < {self._max_size}."
                 )
 
             self._write(address, value, self._wraparound)
 
         elif isinstance(address, slice):
             if not isinstance(value, (bytes, bytearray, list, tuple)):
                 raise ValueError(
-                    "Data must be bytes, bytearray, list, "
-                    "or tuple for multiple addresses"
+                    "Data must be bytes, bytearray, list, " "or tuple for multiple addresses"
                 )
             if (address.start is None) or (address.stop is None):
                 raise ValueError("Boundless slices are not supported")
             if (address.step is not None) and (address.step != 1):
                 raise ValueError("Slice stepping is not currently available.")
             if (address.start < 0) or (address.stop > self._max_size):
                 raise ValueError(
-                    "Slice '{0}:{1}' out of range. All addresses must be 0 <= address < {2}.".format(  # pylint: disable=line-too-long
-                        address.start, address.stop, self._max_size
-                    )
+                    f"Slice '{address.start}:{address.stop}' out of range. All addresses must be 0 <= address < {self._max_size}."  # noqa: E501
                 )
             if len(value) < (len(range(address.start, address.stop))):
-                raise ValueError(
-                    "Cannot set values with a list smaller than the number of indexes"
-                )
+                raise ValueError("Cannot set values with a list smaller than the number of indexes")
 
             self._write(address.start, value, self._wraparound)
 
     def _read_address(self, address: int, read_buffer: bytearray) -> bytearray:
         # Implemented by subclass
         raise NotImplementedError
 
-    def _write(
-        self, start_address: int, data: Union[int, Sequence[int]], wraparound: bool
-    ) -> None:
+    def _write(self, start_address: int, data: Union[int, Sequence[int]], wraparound: bool) -> None:
         # Implemened by subclass
         raise NotImplementedError
 
@@ -242,15 +232,14 @@ class FRAM_I2C(FRAM):
                     Must be a ``digitalio.DigitalInOut`` object.
     """
 
-    # pylint: disable=too-many-arguments
     def __init__(
         self,
         i2c_bus: I2C,
         address: int = 0x50,
         write_protect: bool = False,
         wp_pin: Optional[DigitalInOut] = None,
     ) -> None:
-        from adafruit_bus_device.i2c_device import (  # pylint: disable=import-outside-toplevel
+        from adafruit_bus_device.i2c_device import (  # noqa: PLC0415
             I2CDevice as i2cdev,
         )
 
@@ -311,7 +300,6 @@ def _write(
                 buffer[2] = data[i]
                 i2c.write(buffer)
 
-    # pylint: disable=no-member
     @FRAM.write_protected.setter
     def write_protected(self, value: bool) -> None:
         if not isinstance(value, bool):
@@ -334,7 +322,6 @@ class FRAM_SPI(FRAM):
     :param int max_size: Size of FRAM in Bytes. Default is ``8192``.
     """
 
-    # pylint: disable=too-many-arguments,too-many-locals
     def __init__(
         self,
         spi_bus: SPI,
@@ -344,7 +331,7 @@ def __init__(
         baudrate: int = 100000,
         max_size: int = _MAX_SIZE_SPI,
     ):
-        from adafruit_bus_device.spi_device import (  # pylint: disable=import-outside-toplevel
+        from adafruit_bus_device.spi_device import (  # noqa: PLC0415
             SPIDevice as spidev,
         )
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -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_fram
    :members:
    :special-members: __len__, __getitem__, __setitem__
diff --git 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 = "2018"
 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 + " Michael Schroeder"
 author = "Michael Schroeder"

diff --git a/examples/fram_i2c_simpletest.py b/examples/fram_i2c_simpletest.py
@@ -5,6 +5,7 @@
 
 import board
 import busio
+
 import adafruit_fram
 
 ## Create a FRAM object (default address used).

diff --git a/examples/fram_spi_simpletest.py b/examples/fram_spi_simpletest.py
@@ -6,6 +6,7 @@
 import board
 import busio
 import digitalio
+
 import adafruit_fram
 
 ## Create a FRAM object.

diff --git a/ruff.toml b/ruff.toml
@@ -0,0 +1,105 @@
+# 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
+]
+
+[format]
+line-ending = "lf"