Merge pull request #32 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
 
 Simple BLE Service for reading and writing files over BLE. This BLE service is geared towards file
 transfer to and from a device running the service. A core part of the protocol is free space

README.rst

@@ -14,17 +14,18 @@
 
 import struct
 import time
-import _bleio
 
+import _bleio
 from adafruit_ble.attributes import Attribute
 from adafruit_ble.characteristics import Characteristic, ComplexCharacteristic
 from adafruit_ble.characteristics.int import Uint32Characteristic
-from adafruit_ble.uuid import VendorUUID, StandardUUID
 from adafruit_ble.services import Service
+from adafruit_ble.uuid import StandardUUID, VendorUUID
 
 try:
-    from typing import Optional, List
-    from circuitpython_typing import WriteableBuffer, ReadableBuffer
+    from typing import List, Optional
+
+    from circuitpython_typing import ReadableBuffer, WriteableBuffer
 except ImportError:
     pass
 
@@ -37,10 +38,8 @@
 class FileTransferUUID(VendorUUID):
     """UUIDs with the CircuitPython base UUID."""
 
-    # pylint: disable=too-few-public-methods
-
     def __init__(self, uuid16: int) -> None:
-        uuid128 = bytearray("refsnarTeliF".encode("utf-8") + b"\x00\x00\xaf\xad")
+        uuid128 = bytearray(b"refsnarTeliF" + b"\x00\x00\xaf\xad")
         uuid128[-3] = uuid16 >> 8
         uuid128[-4] = uuid16 & 0xFF
         super().__init__(uuid128)
@@ -50,8 +49,6 @@ class _TransferCharacteristic(ComplexCharacteristic):
     """Endpoint for sending commands to a media player. The value read will list all available
     commands."""
 
-    # pylint: disable=too-few-public-methods
-
     uuid = FileTransferUUID(0x0200)
 
     def __init__(self) -> None:
@@ -68,9 +65,7 @@ def __init__(self) -> None:
     def bind(self, service: "FileTransferService") -> _bleio.PacketBuffer:
         """Binds the characteristic to the given Service."""
         bound_characteristic = super().bind(service)
-        return _bleio.PacketBuffer(
-            bound_characteristic, buffer_size=4, max_packet_size=512
-        )
+        return _bleio.PacketBuffer(bound_characteristic, buffer_size=4, max_packet_size=512)
 
 
 class FileTransferService(Service):
@@ -79,14 +74,10 @@ class FileTransferService(Service):
     The server dictates data transfer chunk sizes so it can minimize buffer sizes on its end.
     """
 
-    # pylint: disable=too-few-public-methods
-
     uuid = StandardUUID(0xFEBB)
     version = Uint32Characteristic(uuid=FileTransferUUID(0x0100), initial_value=4)
     raw = _TransferCharacteristic()
-    # _raw gets shadowed for each MIDIService instance by a PacketBuffer. PyLint doesn't know this
-    # so it complains about missing members.
-    # pylint: disable=no-member
+    # _raw gets shadowed for each MIDIService instance by a PacketBuffer.
 
     # Commands
     INVALID = 0x00
@@ -107,7 +98,7 @@ class FileTransferService(Service):
 
     # Responses
     # 0x00 is INVALID
-    OK = 0x01  # pylint: disable=invalid-name
+    OK = 0x01
     ERROR = 0x02
     ERROR_NO_FILE = 0x03
     ERROR_PROTOCOL = 0x04
@@ -152,23 +143,18 @@ def _readinto(self, buffer: WriteableBuffer) -> bytearray:
 
     def read(self, path: str, *, offset: int = 0) -> bytearray:
         """Returns the contents of the file at the given path starting at the given offset"""
-        # pylint: disable=too-many-locals
         path = path.encode("utf-8")
         chunk_size = CHUNK_SIZE
         start_offset = offset
         encoded = (
-            struct.pack(
-                "<BxHII", FileTransferService.READ, len(path), offset, chunk_size
-            )
-            + path
+            struct.pack("<BxHII", FileTransferService.READ, len(path), offset, chunk_size) + path
         )
         self._write(encoded)
         b = bytearray(struct.calcsize("<BBxxIII") + chunk_size)
         current_offset = start_offset
         chunk_done = True
         content_length = None
         chunk_end = 0
-        # pylint: disable=unsupported-assignment-operation
         buf = []
         data_header_size = struct.calcsize("<BBxxIII")
         while content_length is None or current_offset < content_length:
@@ -190,9 +176,7 @@ def read(self, path: str, *, offset: int = 0) -> bytearray:
                 if not buf:
                     buf = bytearray(content_length - start_offset)
                 out_offset = current_offset - start_offset
-                buf[out_offset : out_offset + (read - data_header_size)] = b[
-                    data_header_size:read
-                ]
+                buf[out_offset : out_offset + (read - data_header_size)] = b[data_header_size:read]
                 current_offset += read - data_header_size
             else:
                 out_offset = current_offset - start_offset
@@ -252,10 +236,7 @@ def write(
             if status != FileTransferService.OK:
                 print("write error", status)
                 raise RuntimeError()
-            if (
-                cmd != FileTransferService.WRITE_PACING
-                or current_offset != written + offset
-            ):
+            if cmd != FileTransferService.WRITE_PACING or current_offset != written + offset:
                 self._write(
                     struct.pack(
                         "<BBxxII",
@@ -292,10 +273,7 @@ def mkdir(self, path: str, modification_time: Optional[int] = None) -> int:
         if modification_time is None:
             modification_time = int(time.time() * 1_000_000_000)
         encoded = (
-            struct.pack(
-                "<BxHxxxxQ", FileTransferService.MKDIR, len(path), modification_time
-            )
-            + path
+            struct.pack("<BxHxxxxQ", FileTransferService.MKDIR, len(path), modification_time) + path
         )
         self._write(encoded)
 
@@ -310,7 +288,6 @@ def mkdir(self, path: str, modification_time: Optional[int] = None) -> int:
 
     def listdir(self, path: str) -> List[tuple]:
         """Returns a list of tuples, one tuple for each file or directory in the given path"""
-        # pylint: disable=too-many-locals
         paths = []
         path = path.encode("utf-8")
         encoded = struct.pack("<BxH", FileTransferService.LISTDIR, len(path)) + path

adafruit_ble_file_transfer.py

@@ -4,5 +4,8 @@
 .. 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_ble_file_transfer
    :members:

docs/api.rst

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT

docs/conf.py

@@ -9,18 +9,17 @@
 
 from adafruit_ble import BLERadio
 from adafruit_ble.advertising.standard import (
-    ProvideServicesAdvertisement,
     Advertisement,
+    ProvideServicesAdvertisement,
 )
+
 import adafruit_ble_file_transfer
 
 # Connect to a file transfer device
 ble = BLERadio()
 connection = None
 print("disconnected, scanning")
-for advertisement in ble.start_scan(
-    ProvideServicesAdvertisement, Advertisement, timeout=1
-):
+for advertisement in ble.start_scan(ProvideServicesAdvertisement, Advertisement, timeout=1):
     # print(advertisement.address, advertisement.address.type)
     if (
         not hasattr(advertisement, "services")

examples/ble_file_transfer_listdirs.py

@@ -11,14 +11,14 @@
 
 from adafruit_ble import BLERadio
 from adafruit_ble.advertising.standard import (
-    ProvideServicesAdvertisement,
     Advertisement,
+    ProvideServicesAdvertisement,
 )
+
 import adafruit_ble_file_transfer
 
 
 def _write(client, filename, contents, *, offset=0):
-    # pylint: disable=redefined-outer-name
     start = time.monotonic()
     try:
         client.write(filename, contents, offset=offset)
@@ -32,7 +32,6 @@ def _write(client, filename, contents, *, offset=0):
 
 
 def _read(client, filename, *, offset=0):
-    # pylint: disable=redefined-outer-name
     start = time.monotonic()
     try:
         contents = client.read(filename, offset=offset)
@@ -73,7 +72,6 @@ def wait_for_reconnect():
     try:
         while ble.connected:
             for connection in ble.connections:
-                # pylint: disable=redefined-outer-name
                 if adafruit_ble_file_transfer.FileTransferService not in connection:
                     continue
                 if not connection.paired:
@@ -85,7 +83,7 @@ def wait_for_reconnect():
                 client = adafruit_ble_file_transfer.FileTransferClient(service)
 
                 print("Testing write")
-                client = _write(client, "/hello.txt", "Hello world".encode("utf-8"))
+                client = _write(client, "/hello.txt", b"Hello world")
                 time.sleep(1)
                 c = _read(client, "/hello.txt")
                 print(len(c), c)
@@ -101,23 +99,21 @@ def wait_for_reconnect():
                 print()
 
                 print("Test writing within dir")
-                client = _write(client, "/world/hi.txt", "Hi world".encode("utf-8"))
+                client = _write(client, "/world/hi.txt", b"Hi world")
 
-                hello_world = "Hello world".encode("utf-8")
+                hello_world = b"Hello world"
                 client = _write(client, "/world/hello.txt", hello_world)
                 c = _read(client, "/world/hello.txt")
                 print(c)
                 print()
 
                 # Test offsets
                 print("Testing offsets")
-                hello = len("Hello ".encode("utf-8"))
+                hello = len(b"Hello ")
                 c = _read(client, "/world/hello.txt", offset=hello)
                 print(c)
 
-                client = _write(
-                    client, "/world/hello.txt", "offsets!".encode("utf-8"), offset=hello
-                )
+                client = _write(client, "/world/hello.txt", b"offsets!", offset=hello)
                 c = _read(client, "/world/hello.txt", offset=0)
                 print(c)
                 print()
@@ -174,18 +170,15 @@ def wait_for_reconnect():
                     raise RuntimeError("large contents don't match!")
                 print()
             time.sleep(20)
-    except ConnectionError as e:
+    except ConnectionError:
         pass
 
     print("disconnected, scanning")
-    for advertisement in ble.start_scan(
-        ProvideServicesAdvertisement, Advertisement, timeout=1
-    ):
+    for advertisement in ble.start_scan(ProvideServicesAdvertisement, Advertisement, timeout=1):
         # print(advertisement.address, advertisement.address.type)
         if (
             not hasattr(advertisement, "services")
-            or adafruit_ble_file_transfer.FileTransferService
-            not in advertisement.services
+            or adafruit_ble_file_transfer.FileTransferService not in advertisement.services
         ):
             continue
         ble.connect(advertisement)

examples/ble_file_transfer_simpletest.py

@@ -3,11 +3,11 @@
 # SPDX-License-Identifier: Unlicense
 
 """This example broadcasts out the creation id based on the CircuitPython machine
-   string and provides a stub FileTransferService."""
+string and provides a stub FileTransferService."""
 
 import binascii
-import struct
 import os
+import struct
 import time
 
 import adafruit_ble
@@ -68,7 +68,7 @@ def write_packets(buf):
     sent = 0
     while offset < len(buf):
         this_packet = full_packet[: len(buf) - sent]
-        for k in range(len(this_packet)):  # pylint: disable=consider-using-enumerate
+        for k in range(len(this_packet)):
             this_packet[k] = buf[sent + k]
         sent += len(this_packet)
         service.raw.write(this_packet)
@@ -80,9 +80,7 @@ def read_complete_path(starting_path, total_length):
     remaining_path = total_length - current_path_length
     complete_path[:current_path_length] = starting_path
     if remaining_path > 0:
-        read_packets(
-            memoryview(complete_path)[current_path_length:], target_size=remaining_path
-        )
+        read_packets(memoryview(complete_path)[current_path_length:], target_size=remaining_path)
     return str(complete_path, "utf-8")
 
 
@@ -152,12 +150,8 @@ def read_complete_path(starting_path, total_length):
                     next_amount,
                 )
                 write_packets(header)
-                read = read_packets(
-                    packet_buffer, target_size=next_amount + write_data_header_size
-                )
-                cmd, status, offset, data_size = struct.unpack_from(
-                    "<BBxxII", packet_buffer
-                )
+                read = read_packets(packet_buffer, target_size=next_amount + write_data_header_size)
+                cmd, status, offset, data_size = struct.unpack_from("<BBxxII", packet_buffer)
                 if status != FileTransferService.OK:
                     print("bad status, resetting")
                     ok = False
@@ -226,20 +220,14 @@ def read_complete_path(starting_path, total_length):
                     len(contents),
                     next_amount,
                 )
-                write_packets(
-                    header + contents[contents_sent : contents_sent + next_amount]
-                )
+                write_packets(header + contents[contents_sent : contents_sent + next_amount])
                 contents_sent += next_amount
 
                 if contents_sent == len(contents):
                     break
 
-                read = read_packets(
-                    packet_buffer, target_size=struct.calcsize("<BBxxII")
-                )
-                cmd, status, offset, free_space = struct.unpack_from(
-                    "<BBxxII", packet_buffer
-                )
+                read = read_packets(packet_buffer, target_size=struct.calcsize("<BBxxII"))
+                cmd, status, offset, free_space = struct.unpack_from("<BBxxII", packet_buffer)
                 if cmd != FileTransferService.READ_PACING:
                     write_packets(
                         struct.pack(
@@ -390,17 +378,13 @@ def read_complete_path(starting_path, total_length):
             del stored_timestamps[path]
             del d[filename]
 
-            header = struct.pack(
-                "<BB", FileTransferService.DELETE_STATUS, FileTransferService.OK
-            )
+            header = struct.pack("<BB", FileTransferService.DELETE_STATUS, FileTransferService.OK)
             write_packets(header)
         elif command == adafruit_ble_file_transfer.FileTransferService.MOVE:
             old_path_length, new_path_length = struct.unpack_from("<xHH", p, offset=1)
             path_start = struct.calcsize("<BxHH")
             # We read in one extra character and then discard it. We don't need it. (C does.)
-            both_paths = read_complete_path(
-                p[path_start:], old_path_length + 1 + new_path_length
-            )
+            both_paths = read_complete_path(p[path_start:], old_path_length + 1 + new_path_length)
             old_path = both_paths[:old_path_length]
             new_path = both_paths[old_path_length + 1 :]
 
@@ -439,9 +423,7 @@ def read_complete_path(starting_path, total_length):
             stored_timestamps[new_path] = stored_timestamps[old_path]
             del stored_timestamps[old_path]
 
-            header = struct.pack(
-                "<BB", FileTransferService.MOVE_STATUS, FileTransferService.OK
-            )
+            header = struct.pack("<BB", FileTransferService.MOVE_STATUS, FileTransferService.OK)
             write_packets(header)
         else:
             print("unknown command", hex(command))

examples/ble_file_transfer_stub_server.py

@@ -0,0 +1,109 @@
+# 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
+    "PLR0914", # too many local vars
+]
+
+[format]
+line-ending = "lf"