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

@@ -14,9 +14,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_SD/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 driver for SD cards. This implements the basic reading and writing
 block functionality needed to mount an SD card using `storage.VfsFat`.

README.rst

@@ -41,14 +41,16 @@
 """
 
 import time
-from micropython import const
+
 from adafruit_bus_device import spi_device
+from micropython import const
 
 try:
-    from typing import Union, Optional
+    from typing import Optional, Union
+
     from busio import SPI
-    from digitalio import DigitalInOut
     from circuitpython_typing import ReadableBuffer, WriteableBuffer
+    from digitalio import DigitalInOut
 except ImportError:
     pass
 
@@ -69,7 +71,6 @@
 _TOKEN_DATA = const(0xFE)
 
 
-# pylint: disable-msg=superfluous-parens
 class SDCard:
     """Controls an SD card over SPI.
 
@@ -97,7 +98,6 @@ class SDCard:
 
     """
 
-    # pylint: disable=invalid-name
     def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 1320000) -> None:
         # Create an SPIDevice running at a lower initialization baudrate first.
         self._spi = spi_device.SPIDevice(spi, cs, baudrate=250000, extra_clocks=8)
@@ -204,9 +204,6 @@ def _wait_for_ready(self, card: SPI, timeout: float = 0.3) -> None:
         while time.monotonic() - start_time < timeout and self._single_byte[0] != 0xFF:
             card.readinto(self._single_byte, write_value=0xFF)
 
-    # pylint: disable-msg=too-many-arguments
-    # pylint: disable=no-member
-    # pylint: disable-msg=too-many-branches
     # no-member disable should be reconsidered when it can be tested
     def _cmd(
         self,
@@ -253,7 +250,6 @@ def _cmd(
 
         card.write(buf)
 
-        # pylint: disable-msg=too-many-nested-blocks
         # wait for the response (response[7] == 0)
         for _ in range(_CMD_TIMEOUT):
             card.readinto(buf, end=1, write_value=0xFF)
@@ -275,10 +271,6 @@ def _cmd(
                 return buf[0]
         return -1
 
-    # pylint: enable-msg=too-many-branches
-    # pylint: enable-msg=too-many-arguments
-
-    # pylint: disable-msg=too-many-arguments
     def _block_cmd(
         self,
         card: SPI,
@@ -327,15 +319,12 @@ def _block_cmd(
                 result = buf[0]
                 break
 
-        # pylint: disable=singleton-comparison
         # Disable should be removed when refactor can be tested.
         if response_buf != None and result == 0:
             self._readinto(card, response_buf)
 
         return result
 
-    # pylint: enable-msg=too-many-arguments
-
     def _cmd_nodata(self, card: SPI, cmd: int, response: int = 0xFF) -> int:
         """
         Issue a command to the card with no argument.
@@ -379,7 +368,6 @@ def _readinto(
         # read checksum and throw it away
         card.readinto(self._cmdbuf, end=2, write_value=0xFF)
 
-    # pylint: disable-msg=too-many-arguments
     def _write(
         self,
         card: SPI,
@@ -412,7 +400,7 @@ def _write(
         card.write(cmd, end=2)
 
         # check the response
-        # pylint: disable=no-else-return
+
         # Disable should be removed when refactor can be tested
         for _ in range(_CMD_TIMEOUT):
             card.readinto(cmd, end=1, write_value=0xFF)
@@ -429,8 +417,6 @@ def _write(
 
         return 0  # worked
 
-    # pylint: enable-msg=too-many-arguments
-
     def count(self) -> int:
         """
         Returns the total number of sectors.
@@ -498,9 +484,7 @@ def writeblocks(self, start_block: int, buf: ReadableBuffer) -> int:
                 # send the data
                 offset = 0
                 while nblocks:
-                    self._write(
-                        card, _TOKEN_CMD25, buf, start=offset, end=(offset + 512)
-                    )
+                    self._write(card, _TOKEN_CMD25, buf, start=offset, end=(offset + 512))
                     offset += 512
                     nblocks -= 1
                 self._wait_for_ready(card)

adafruit_sdcard.py

@@ -1,5 +1,8 @@
 
 .. If you created a package, create one automodule per module in the package.
 
+API Reference
+#############
+
 .. automodule:: adafruit_sdcard
    :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(".."))
 
@@ -47,9 +45,7 @@
 creation_year = "2017"
 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

@@ -2,10 +2,12 @@
 # SPDX-License-Identifier: MIT
 
 import os
+
+import board
 import busio
 import digitalio
-import board
 import storage
+
 import adafruit_sdcard
 
 # The SD_CS pin is the chip select line.
@@ -47,7 +49,7 @@ def print_directory(path, tabs=0):
         prettyprintname += file
         if isdir:
             prettyprintname += "/"
-        print("{0:<40} Size: {1:>10}".format(prettyprintname, sizestr))
+        print(f"{prettyprintname:<40} Size: {sizestr:>10}")
 
         # recursively print directory contents
         if isdir:

examples/sd_read_simpletest.py

@@ -0,0 +1,106 @@
+# 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
+    "PLR1702", # too-many-nested-blocks
+]
+
+[format]
+line-ending = "lf"