Merge pull request #221 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: 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,too-many-arguments,too-many-positional-arguments
-        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 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/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 library for using ESP32 as WiFi co-processor using SPI.
 The companion firmware `is available on GitHub

README.rst

@@ -26,9 +26,7 @@ class PWMOut:
         [0, 1, 2, 4, 5, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 25, 26, 27, 32, 33]
     )
 
-    def __init__(
-        self, esp, pwm_pin, *, frequency=500, duty_cycle=0, variable_frequency=False
-    ):
+    def __init__(self, esp, pwm_pin, *, frequency=500, duty_cycle=0, variable_frequency=False):
         if pwm_pin in self.ESP32_PWM_PINS:
             self._pwm_pin = pwm_pin
         else:

adafruit_esp32spi/PWMOut.py

@@ -29,9 +29,10 @@
 import struct
 import time
 import warnings
-from micropython import const
+
 from adafruit_bus_device.spi_device import SPIDevice
 from digitalio import Direction
+from micropython import const
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI.git"
@@ -129,13 +130,11 @@
 ADC_ATTEN_DB_6 = const(2)
 ADC_ATTEN_DB_11 = const(3)
 
-# pylint: disable=too-many-lines
-
 
 class Network:
     """A wifi network provided by a nearby access point."""
 
-    def __init__(  # pylint: disable=too-many-arguments
+    def __init__(
         self,
         esp_spi_control=None,
         raw_ssid=None,
@@ -154,9 +153,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self._raw_authmode = raw_authmode
 
     def _get_response(self, cmd):
-        respose = self._esp_spi_control._send_command_get_response(  # pylint: disable=protected-access
-            cmd, [b"\xFF"]
-        )
+        respose = self._esp_spi_control._send_command_get_response(cmd, [b"\xff"])
         return respose[0]
 
     @property
@@ -221,15 +218,14 @@ def authmode(self):
         return "UNKNOWN"
 
 
-class ESP_SPIcontrol:  # pylint: disable=too-many-public-methods, too-many-instance-attributes
+class ESP_SPIcontrol:
     """A class that will talk to an ESP32 module programmed with special firmware
     that lets it act as a fast an efficient WiFi co-processor"""
 
     TCP_MODE = const(0)
     UDP_MODE = const(1)
     TLS_MODE = const(2)
 
-    # pylint: disable=too-many-arguments
     def __init__(
         self,
         spi,
@@ -297,7 +293,6 @@ def _wait_for_ready(self):
         if self._debug >= 3:
             print()
 
-    # pylint: disable=too-many-branches
     def _send_command(self, cmd, params=None, *, param_len_16=False):
         """Send over a command with a list of parameters"""
         if not params:
@@ -342,14 +337,10 @@ def _send_command(self, cmd, params=None, *, param_len_16=False):
                     break
             else:
                 raise TimeoutError("ESP32 timed out on SPI select")
-            spi.write(
-                self._sendbuf, start=0, end=packet_len
-            )  # pylint: disable=no-member
+            spi.write(self._sendbuf, start=0, end=packet_len)
             if self._debug >= 3:
                 print("Wrote: ", [hex(b) for b in self._sendbuf[0:packet_len]])
 
-    # pylint: disable=too-many-branches
-
     def _read_byte(self, spi):
         """Read one byte from SPI"""
         spi.readinto(self._pbuf)
@@ -380,7 +371,7 @@ def _check_data(self, spi, desired):
         """Read a byte and verify its the value we want"""
         r = self._read_byte(spi)
         if r != desired:
-            raise BrokenPipeError("Expected %02X but got %02X" % (desired, r))
+            raise BrokenPipeError(f"Expected {desired:02X} but got {r:02X}")
 
     def _wait_response_cmd(self, cmd, num_responses=None, *, param_len_16=False):
         """Wait for ready, then parse the response"""
@@ -417,7 +408,7 @@ def _wait_response_cmd(self, cmd, num_responses=None, *, param_len_16=False):
             print("Read %d: " % len(responses[0]), responses)
         return responses
 
-    def _send_command_get_response(  # pylint: disable=too-many-arguments
+    def _send_command_get_response(
         self,
         cmd,
         params=None,
@@ -428,9 +419,7 @@ def _send_command_get_response(  # pylint: disable=too-many-arguments
     ):
         """Send a high level SPI command, wait and return the response"""
         self._send_command(cmd, params, param_len_16=sent_param_len_16)
-        return self._wait_response_cmd(
-            cmd, reply_params, param_len_16=recv_param_len_16
-        )
+        return self._wait_response_cmd(cmd, reply_params, param_len_16=recv_param_len_16)
 
     @property
     def status(self):
@@ -452,15 +441,15 @@ def firmware_version(self):
         return resp[0].decode("utf-8").replace("\x00", "")
 
     @property
-    def MAC_address(self):  # pylint: disable=invalid-name
+    def MAC_address(self):
         """A bytearray containing the MAC address of the ESP32"""
         if self._debug:
             print("MAC address")
-        resp = self._send_command_get_response(_GET_MACADDR_CMD, [b"\xFF"])
+        resp = self._send_command_get_response(_GET_MACADDR_CMD, [b"\xff"])
         return resp[0]
 
     @property
-    def MAC_address_actual(self):  # pylint: disable=invalid-name
+    def MAC_address_actual(self):
         """A bytearray containing the actual MAC address of the ESP32"""
         return bytearray(reversed(self.MAC_address))
 
@@ -485,7 +474,7 @@ def get_scan_networks(self):
         self._send_command(_SCAN_NETWORKS)
         names = self._wait_response_cmd(_SCAN_NETWORKS)
         # print("SSID names:", names)
-        APs = []  # pylint: disable=invalid-name
+        APs = []
         for i, name in enumerate(names):
             bssid = self._send_command_get_response(_GET_IDX_BSSID_CMD, ((i,),))[0]
             rssi = self._send_command_get_response(_GET_IDX_RSSI_CMD, ((i,),))[0]
@@ -509,13 +498,13 @@ def scan_networks(self):
         self.start_scan_networks()
         for _ in range(10):  # attempts
             time.sleep(2)
-            APs = self.get_scan_networks()  # pylint: disable=invalid-name
+            APs = self.get_scan_networks()
             if APs:
                 return APs
         return None
 
     def set_ip_config(self, ip_address, gateway, mask="255.255.255.0"):
-        """Tells the ESP32 to set ip, gateway and network mask b"\xFF"
+        """Tells the ESP32 to set ip, gateway and network mask b"\xff"
 
         :param str ip_address: IP address (as a string).
         :param str gateway: Gateway (as a string).
@@ -598,9 +587,7 @@ def _wifi_set_ap_network(self, ssid, channel):
 
     def _wifi_set_ap_passphrase(self, ssid, passphrase, channel):
         """Creates an Access point with SSID, passphrase, and Channel"""
-        resp = self._send_command_get_response(
-            _SET_AP_PASSPHRASE_CMD, [ssid, passphrase, channel]
-        )
+        resp = self._send_command_get_response(_SET_AP_PASSPHRASE_CMD, [ssid, passphrase, channel])
         if resp[0][0] != 1:
             raise OSError("Failed to setup AP password")
 
@@ -616,9 +603,7 @@ def ap_info(self):
     def network_data(self):
         """A dictionary containing current connection details such as the 'ip_addr',
         'netmask' and 'gateway'"""
-        resp = self._send_command_get_response(
-            _GET_IPADDR_CMD, [b"\xFF"], reply_params=3
-        )
+        resp = self._send_command_get_response(_GET_IPADDR_CMD, [b"\xff"], reply_params=3)
         return {"ip_addr": resp[0], "netmask": resp[1], "gateway": resp[2]}
 
     @property
@@ -671,7 +656,7 @@ def connect(self, ssid, password=None, timeout=10):
             ssid, password = ssid["ssid"], ssid.get("password")
         self.connect_AP(ssid, password, timeout_s=timeout)
 
-    def connect_AP(self, ssid, password, timeout_s=10):  # pylint: disable=invalid-name
+    def connect_AP(self, ssid, password, timeout_s=10):
         """Connect to an access point with given name and password.
         Will wait until specified timeout seconds and return on success
         or raise an exception on failure.
@@ -699,15 +684,13 @@ def connect_AP(self, ssid, password, timeout_s=10):  # pylint: disable=invalid-n
             if stat == WL_CONNECTED:
                 return stat
             time.sleep(0.05)
-        if stat in (WL_CONNECT_FAILED, WL_CONNECTION_LOST, WL_DISCONNECTED):
+        if stat in {WL_CONNECT_FAILED, WL_CONNECTION_LOST, WL_DISCONNECTED}:
             raise ConnectionError("Failed to connect to ssid", ssid)
         if stat == WL_NO_SSID_AVAIL:
             raise ConnectionError("No such ssid", ssid)
-        raise OSError("Unknown error 0x%02X" % stat)
+        raise OSError(f"Unknown error 0x{stat:02X}")
 
-    def create_AP(
-        self, ssid, password, channel=1, timeout=10
-    ):  # pylint: disable=invalid-name
+    def create_AP(self, ssid, password, channel=1, timeout=10):
         """Create an access point with the given name, password, and channel.
         Will wait until specified timeout seconds and return on success
         or raise an exception on failure.
@@ -743,18 +726,18 @@ def create_AP(
             time.sleep(0.05)
         if stat == WL_AP_FAILED:
             raise ConnectionError("Failed to create AP", ssid)
-        raise OSError("Unknown error 0x%02x" % stat)
+        raise OSError(f"Unknown error 0x{stat:02x}")
 
     @property
     def ipv4_address(self):
         """IP address of the station when connected to an access point."""
         return self.pretty_ip(self.ip_address)
 
-    def pretty_ip(self, ip):  # pylint: disable=no-self-use, invalid-name
+    def pretty_ip(self, ip):  # noqa: PLR6301
         """Converts a bytearray IP address to a dotted-quad string for printing"""
-        return "%d.%d.%d.%d" % (ip[0], ip[1], ip[2], ip[3])
+        return f"{ip[0]}.{ip[1]}.{ip[2]}.{ip[3]}"
 
-    def unpretty_ip(self, ip):  # pylint: disable=no-self-use, invalid-name
+    def unpretty_ip(self, ip):  # noqa: PLR6301
         """Converts a dotted-quad string to a bytearray IP address"""
         octets = [int(x) for x in ip.split(".")]
         return bytes(octets)
@@ -834,9 +817,7 @@ def socket_status(self, socket_num):
         SOCKET_FIN_WAIT_2, SOCKET_CLOSE_WAIT, SOCKET_CLOSING, SOCKET_LAST_ACK, or
         SOCKET_TIME_WAIT"""
         self._socknum_ll[0][0] = socket_num
-        resp = self._send_command_get_response(
-            _GET_CLIENT_STATE_TCP_CMD, self._socknum_ll
-        )
+        resp = self._send_command_get_response(_GET_CLIENT_STATE_TCP_CMD, self._socknum_ll)
         return resp[0][0]
 
     def socket_connected(self, socket_num):
@@ -867,9 +848,7 @@ def socket_write(self, socket_num, buffer, conn_mode=TCP_MODE):
         if conn_mode == self.UDP_MODE:
             # UDP verifies chunks on write, not bytes
             if sent != total_chunks:
-                raise ConnectionError(
-                    "Failed to write %d chunks (sent %d)" % (total_chunks, sent)
-                )
+                raise ConnectionError("Failed to write %d chunks (sent %d)" % (total_chunks, sent))
             # UDP needs to finalize with this command, does the actual sending
             resp = self._send_command_get_response(_SEND_UDP_DATA_CMD, self._socknum_ll)
             if resp[0][0] != 1:
@@ -878,9 +857,7 @@ def socket_write(self, socket_num, buffer, conn_mode=TCP_MODE):
 
         if sent != len(buffer):
             self.socket_close(socket_num)
-            raise ConnectionError(
-                "Failed to send %d bytes (sent %d)" % (len(buffer), sent)
-            )
+            raise ConnectionError("Failed to send %d bytes (sent %d)" % (len(buffer), sent))
 
         resp = self._send_command_get_response(_DATA_SENT_TCP_CMD, self._socknum_ll)
         if resp[0][0] != 1:
@@ -945,9 +922,7 @@ def socket_close(self, socket_num):
         if socket_num == self._tls_socket:
             self._tls_socket = None
 
-    def start_server(
-        self, port, socket_num, conn_mode=TCP_MODE, ip=None
-    ):  # pylint: disable=invalid-name
+    def start_server(self, port, socket_num, conn_mode=TCP_MODE, ip=None):  # pylint: disable=invalid-name
         """Opens a server on the specified port, using the ESP32's internal reference number"""
         if self._debug:
             print("*** starting server")
@@ -1003,9 +978,7 @@ def set_digital_write(self, pin, value):
         :param int pin: ESP32 GPIO pin to write to.
         :param bool value: Value for the pin.
         """
-        resp = self._send_command_get_response(
-            _SET_DIGITAL_WRITE_CMD, ((pin,), (value,))
-        )
+        resp = self._send_command_get_response(_SET_DIGITAL_WRITE_CMD, ((pin,), (value,)))
         if resp[0][0] != 1:
             raise OSError("Failed to write to pin")
 
@@ -1016,9 +989,7 @@ def set_analog_write(self, pin, analog_value):
         :param float value: 0=off 1.0=full on
         """
         value = int(255 * analog_value)
-        resp = self._send_command_get_response(
-            _SET_ANALOG_WRITE_CMD, ((pin,), (value,))
-        )
+        resp = self._send_command_get_response(_SET_ANALOG_WRITE_CMD, ((pin,), (value,)))
         if resp[0][0] != 1:
             raise OSError("Failed to write to pin")
 
@@ -1036,9 +1007,7 @@ def set_digital_read(self, pin):
             return False
         if resp[0] == 1:
             return True
-        raise OSError(
-            "_SET_DIGITAL_READ response error: response is not boolean", resp[0]
-        )
+        raise OSError("_SET_DIGITAL_READ response error: response is not boolean", resp[0])
 
     def set_analog_read(self, pin, atten=ADC_ATTEN_DB_11):
         """Get the analog input value of pin. Returns an int between 0 and 65536.
@@ -1053,9 +1022,7 @@ def set_analog_read(self, pin, atten=ADC_ATTEN_DB_11):
         resp = self._send_command_get_response(_SET_ANALOG_READ_CMD, ((pin,), (atten,)))
         resp_analog = struct.unpack("<i", resp[0])
         if resp_analog[0] < 0:
-            raise ValueError(
-                "_SET_ANALOG_READ parameter error: invalid pin", resp_analog[0]
-            )
+            raise ValueError("_SET_ANALOG_READ parameter error: invalid pin", resp_analog[0])
         if self._debug:
             print(resp, resp_analog, resp_analog[0], 16 * resp_analog[0])
         return 16 * resp_analog[0]
@@ -1068,10 +1035,8 @@ def get_time(self):
             if resp_time == (0,):
                 raise OSError("_GET_TIME returned 0")
             return resp_time
-        if self.status in (WL_AP_LISTENING, WL_AP_CONNECTED):
-            raise OSError(
-                "Cannot obtain NTP while in AP mode, must be connected to internet"
-            )
+        if self.status in {WL_AP_LISTENING, WL_AP_CONNECTED}:
+            raise OSError("Cannot obtain NTP while in AP mode, must be connected to internet")
         raise OSError("Must be connected to WiFi before obtaining NTP.")
 
     def set_certificate(self, client_certificate):
@@ -1083,9 +1048,7 @@ def set_certificate(self, client_certificate):
         if self._debug:
             print("** Setting client certificate")
         if self.status == WL_CONNECTED:
-            raise ValueError(
-                "set_certificate must be called BEFORE a connection is established."
-            )
+            raise ValueError("set_certificate must be called BEFORE a connection is established.")
         if isinstance(client_certificate, str):
             client_certificate = bytes(client_certificate, "utf-8")
         if "-----BEGIN CERTIFICATE" not in client_certificate:
@@ -1106,9 +1069,7 @@ def set_private_key(self, private_key):
         if self._debug:
             print("** Setting client's private key.")
         if self.status == WL_CONNECTED:
-            raise ValueError(
-                "set_private_key must be called BEFORE a connection is established."
-            )
+            raise ValueError("set_private_key must be called BEFORE a connection is established.")
         if isinstance(private_key, str):
             private_key = bytes(private_key, "utf-8")
         if "-----BEGIN RSA" not in private_key:

adafruit_esp32spi/adafruit_esp32spi.py

@@ -10,21 +10,24 @@
 
 * Author(s): ladyada
 """
+
 from __future__ import annotations
 
 try:
     from typing import TYPE_CHECKING, Optional
 
     if TYPE_CHECKING:
-        from esp32spi.adafruit_esp32spi import ESP_SPIcontrol
+        from esp32spi.adafruit_esp32spi import ESP_SPIcontrol  # noqa: UP007
 except ImportError:
     pass
 
 
 import errno
-import time
 import gc
+import time
+
 from micropython import const
+
 from adafruit_esp32spi import adafruit_esp32spi as esp32spi
 
 _global_socketpool = {}
@@ -49,17 +52,15 @@ def __new__(cls, iface: ESP_SPIcontrol):
     def __init__(self, iface: ESP_SPIcontrol):
         self._interface = iface
 
-    def getaddrinfo(  # pylint: disable=too-many-arguments,unused-argument
-        self, host, port, family=0, socktype=0, proto=0, flags=0
-    ):
+    def getaddrinfo(self, host, port, family=0, socktype=0, proto=0, flags=0):
         """Given a hostname and a port name, return a 'socket.getaddrinfo'
         compatible list of tuples. Honestly, we ignore anything but host & port"""
         if not isinstance(port, int):
             raise ValueError("Port must be an integer")
         ipaddr = self._interface.get_host_by_name(host)
         return [(SocketPool.AF_INET, socktype, proto, "", (ipaddr, port))]
 
-    def socket(  # pylint: disable=redefined-builtin
+    def socket(
         self,
         family=AF_INET,
         type=SOCK_STREAM,
@@ -74,13 +75,13 @@ class Socket:
     """A simplified implementation of the Python 'socket' class, for connecting
     through an interface to a remote device"""
 
-    def __init__(  # pylint: disable=redefined-builtin,too-many-arguments,unused-argument
+    def __init__(
         self,
         socket_pool: SocketPool,
         family: int = SocketPool.AF_INET,
         type: int = SocketPool.SOCK_STREAM,
         proto: int = 0,
-        fileno: Optional[int] = None,
+        fileno: Optional[int] = None,  # noqa: UP007
     ):
         if family != SocketPool.AF_INET:
             raise ValueError("Only AF_INET family supported")
@@ -110,9 +111,7 @@ def connect(self, address, conntype=None):
                 if self._type == SocketPool.SOCK_DGRAM
                 else self._interface.TCP_MODE
             )
-        if not self._interface.socket_connect(
-            self._socknum, host, port, conn_mode=conntype
-        ):
+        if not self._interface.socket_connect(self._socknum, host, port, conn_mode=conntype):
             raise ConnectionError("Failed to connect to host", host)
         self._buffer = b""
 
@@ -159,9 +158,7 @@ def recv_into(self, buffer, nbytes: int = 0):
             # esp32spi_wsgiserver: socket_readline
             if len(self._buffer) > 0:
                 bytes_to_read = min(num_to_read, len(self._buffer))
-                buffer[num_read : num_read + bytes_to_read] = self._buffer[
-                    :bytes_to_read
-                ]
+                buffer[num_read : num_read + bytes_to_read] = self._buffer[:bytes_to_read]
                 num_read += bytes_to_read
                 num_to_read -= bytes_to_read
                 self._buffer = self._buffer[bytes_to_read:]
@@ -171,9 +168,7 @@ def recv_into(self, buffer, nbytes: int = 0):
             num_avail = self._available()
             if num_avail > 0:
                 last_read_time = time.monotonic()
-                bytes_read = self._interface.socket_read(
-                    self._socknum, min(num_to_read, num_avail)
-                )
+                bytes_read = self._interface.socket_read(self._socknum, min(num_to_read, num_avail))
                 buffer[num_read : num_read + len(bytes_read)] = bytes_read
                 num_read += len(bytes_read)
                 num_to_read -= len(bytes_read)
@@ -194,9 +189,7 @@ def settimeout(self, value):
     def _available(self):
         """Returns how many bytes of data are available to be read (up to the MAX_PACKET length)"""
         if self._socknum != SocketPool.NO_SOCKET_AVAIL:
-            return min(
-                self._interface.socket_available(self._socknum), SocketPool.MAX_PACKET
-            )
+            return min(self._interface.socket_available(self._socknum), SocketPool.MAX_PACKET)
         return 0
 
     def _connected(self):
@@ -206,7 +199,7 @@ def _connected(self):
         if self._available():
             return True
         status = self._interface.socket_status(self._socknum)
-        result = status not in (
+        result = status not in {
             esp32spi.SOCKET_LISTEN,
             esp32spi.SOCKET_CLOSED,
             esp32spi.SOCKET_FIN_WAIT_1,
@@ -215,7 +208,7 @@ def _connected(self):
             esp32spi.SOCKET_SYN_SENT,
             esp32spi.SOCKET_SYN_RCVD,
             esp32spi.SOCKET_CLOSE_WAIT,
-        )
+        }
         if not result:
             self.close()
             self._socknum = SocketPool.NO_SOCKET_AVAIL

adafruit_esp32spi/adafruit_esp32spi_socketpool.py

@@ -11,17 +11,16 @@
 * Author(s): Melissa LeBlanc-Williams, ladyada
 """
 
-# pylint: disable=no-name-in-module
-
 import warnings
 from time import sleep
-from micropython import const
+
 import adafruit_connection_manager
 import adafruit_requests
+from micropython import const
+
 from adafruit_esp32spi import adafruit_esp32spi
 
 
-# pylint: disable=too-many-instance-attributes
 class WiFiManager:
     """
     A class to help manage the Wifi connection
@@ -30,7 +29,6 @@ class WiFiManager:
     NORMAL = const(1)
     ENTERPRISE = const(2)
 
-    # pylint: disable=too-many-arguments
     def __init__(
         self,
         esp,
@@ -112,9 +110,7 @@ def connect(self):
             raise TypeError("Invalid WiFi connection type specified")
 
     def _get_next_ap(self):
-        if isinstance(self.ssid, (tuple, list)) and isinstance(
-            self.password, (tuple, list)
-        ):
+        if isinstance(self.ssid, (tuple, list)) and isinstance(self.password, (tuple, list)):
             if not self.ssid or not self.password:
                 raise ValueError("SSID and Password should contain at least 1 value")
             if len(self.ssid) != len(self.password):
@@ -124,9 +120,7 @@ def _get_next_ap(self):
             if self._ap_index >= len(self.ssid):
                 self._ap_index = 0
             return access_point
-        if isinstance(self.ssid, (tuple, list)) or isinstance(
-            self.password, (tuple, list)
-        ):
+        if isinstance(self.ssid, (tuple, list)) or isinstance(self.password, (tuple, list)):
             raise NotImplementedError(
                 "If using multiple passwords, both SSID and Password should be lists or tuples"
             )
@@ -168,9 +162,7 @@ def create_ap(self):
                     print("Waiting for AP to be initialized...")
                 self.pixel_status((100, 0, 0))
                 if self.password:
-                    self.esp.create_AP(
-                        bytes(self.ssid, "utf-8"), bytes(self.password, "utf-8")
-                    )
+                    self.esp.create_AP(bytes(self.ssid, "utf-8"), bytes(self.password, "utf-8"))
                 else:
                     self.esp.create_AP(bytes(self.ssid, "utf-8"), None)
                 failure_count = 0
@@ -182,7 +174,7 @@ def create_ap(self):
                     failure_count = 0
                     self.reset()
                 continue
-        print("Access Point created! Connect to ssid:\n {}".format(self.ssid))
+        print(f"Access Point created! Connect to ssid:\n {self.ssid}")
 
     def connect_enterprise(self):
         """
@@ -197,9 +189,7 @@ def connect_enterprise(self):
         while not self.esp.is_connected:
             try:
                 if self.debug:
-                    print(
-                        "Waiting for the ESP32 to connect to the WPA2 Enterprise AP..."
-                    )
+                    print("Waiting for the ESP32 to connect to the WPA2 Enterprise AP...")
                 self.pixel_status((100, 0, 0))
                 sleep(1)
                 failure_count = 0
@@ -356,13 +346,11 @@ def signal_strength(self):
         return self.esp.ap_info.rssi
 
 
-# pylint: disable=too-many-instance-attributes
 class ESPSPI_WiFiManager(WiFiManager):
     """
     A legacy class to help manage the Wifi connection. Please update to using WiFiManager
     """
 
-    # pylint: disable=too-many-arguments
     def __init__(
         self,
         esp,

adafruit_esp32spi/adafruit_esp32spi_wifimanager.py

@@ -13,6 +13,7 @@
 https://github.com/adafruit/Adafruit_Blinka/blob/master/src/adafruit_blinka/microcontroller/bcm283x/pin.py
 https://github.com/adafruit/Adafruit_Blinka/blob/master/src/digitalio.py
 """
+
 from micropython import const
 
 
@@ -28,7 +29,6 @@ class Pin:
     or the use of internal pull-up resistors.
     """
 
-    # pylint: disable=invalid-name
     IN = const(0x00)
     OUT = const(0x01)
     LOW = const(0x00)
@@ -78,15 +78,12 @@ def value(self, val=None):
             else:
                 raise ValueError("Invalid value for pin")
         else:
-            raise NotImplementedError(
-                "digitalRead not currently implemented in esp32spi"
-            )
+            raise NotImplementedError("digitalRead not currently implemented in esp32spi")
 
     def __repr__(self):
         return str(self.pin_id)
 
 
-# pylint: disable = too-few-public-methods
 class DriveMode:
     """DriveMode Enum."""
 
@@ -118,7 +115,6 @@ class DigitalInOut:
 
     _pin = None
 
-    # pylint: disable = attribute-defined-outside-init
     def __init__(self, esp, pin):
         self._esp = esp
         self._pin = Pin(pin, self._esp)
@@ -149,9 +145,7 @@ def switch_to_input(self, pull=None):
 
         :param Pull pull: Pull configuration for the input.
         """
-        raise NotImplementedError(
-            "Digital reads are not currently supported in ESP32SPI."
-        )
+        raise NotImplementedError("Digital reads are not currently supported in ESP32SPI.")
 
     @property
     def direction(self):
@@ -207,8 +201,6 @@ def drive_mode(self, mode):
                                Either PUSH_PULL or OPEN_DRAIN
         """
         if mode is DriveMode.OPEN_DRAIN:
-            raise NotImplementedError(
-                "Drive mode %s not implemented in ESP32SPI." % mode
-            )
+            raise NotImplementedError("Drive mode %s not implemented in ESP32SPI." % mode)
         if mode is DriveMode.PUSH_PULL:
             self._pin.init(mode=Pin.OUT)

adafruit_esp32spi/digitalio.py

@@ -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_esp32spi.adafruit_esp32spi
    :members:
 

docs/api.rst

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -52,9 +50,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 + " ladyada"
 author = "ladyada"

docs/conf.py

@@ -3,10 +3,12 @@
 
 import time
 from os import getenv
+
 import board
 import busio
-from digitalio import DigitalInOut
 import neopixel
+from digitalio import DigitalInOut
+
 from adafruit_esp32spi import adafruit_esp32spi
 from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager
 
@@ -60,11 +62,7 @@
         feed = "test"
         payload = {"value": data}
         response = wifi.post(
-            "https://io.adafruit.com/api/v2/"
-            + aio_username
-            + "/feeds/"
-            + feed
-            + "/data",
+            "https://io.adafruit.com/api/v2/" + aio_username + "/feeds/" + feed + "/data",
             json=payload,
             headers={"X-AIO-KEY": aio_key},
         )

examples/esp32spi_aio_post.py

@@ -3,12 +3,12 @@
 
 import time
 from os import getenv
+
+import adafruit_fancyled.adafruit_fancyled as fancy
 import board
 import busio
-from digitalio import DigitalInOut
-
 import neopixel
-import adafruit_fancyled.adafruit_fancyled as fancy
+from digitalio import DigitalInOut
 
 from adafruit_esp32spi import adafruit_esp32spi
 from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager

examples/esp32spi_cheerlights.py

@@ -3,9 +3,11 @@
 
 import time
 from os import getenv
+
 import board
 import busio
 from digitalio import DigitalInOut
+
 import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool
 from adafruit_esp32spi import adafruit_esp32spi
 

examples/esp32spi_ipconfig.py

@@ -3,11 +3,13 @@
 
 import time
 from os import getenv
+
 import board
 import busio
-from digitalio import DigitalInOut
 import neopixel
 import rtc
+from digitalio import DigitalInOut
+
 from adafruit_esp32spi import adafruit_esp32spi
 from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager
 
@@ -66,18 +68,16 @@
 json = response.json()
 current_time = json["datetime"]
 the_date, the_time = current_time.split("T")
-year, month, mday = [int(x) for x in the_date.split("-")]
+year, month, mday = (int(x) for x in the_date.split("-"))
 the_time = the_time.split(".")[0]
-hours, minutes, seconds = [int(x) for x in the_time.split(":")]
+hours, minutes, seconds = (int(x) for x in the_time.split(":"))
 
 # We can also fill in these extra nice things
 year_day = json["day_of_year"]
 week_day = json["day_of_week"]
 is_dst = json["dst"]
 
-now = time.struct_time(
-    (year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst)
-)
+now = time.struct_time((year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst))
 print(now)
 the_rtc.datetime = now
 

examples/esp32spi_localtime.py

@@ -2,11 +2,13 @@
 # SPDX-License-Identifier: MIT
 
 from os import getenv
+
+import adafruit_connection_manager
+import adafruit_requests
 import board
 import busio
 from digitalio import DigitalInOut
-import adafruit_connection_manager
-import adafruit_requests
+
 from adafruit_esp32spi import adafruit_esp32spi
 
 # Get wifi details and more from a settings.toml file
@@ -69,9 +71,7 @@
         continue
 print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi)
 print("My IP address is", esp.ipv4_address)
-print(
-    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))
-)
+print("IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")))
 print("Ping google.com: %d ms" % esp.ping("google.com"))
 
 # esp._debug = True

examples/esp32spi_simpletest.py

@@ -2,11 +2,13 @@
 # SPDX-License-Identifier: MIT
 
 from os import getenv
+
+import adafruit_connection_manager
+import adafruit_requests
 import board
 import busio
 from digitalio import DigitalInOut
-import adafruit_connection_manager
-import adafruit_requests
+
 from adafruit_esp32spi import adafruit_esp32spi
 
 # Get wifi details and more from a settings.toml file
@@ -48,9 +50,7 @@
         continue
 print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi)
 print("My IP address is", esp.ipv4_address)
-print(
-    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))
-)
+print("IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")))
 print("Ping google.com: %d ms" % esp.ping("google.com"))
 
 # esp._debug = True

examples/esp32spi_simpletest_rp2040.py

@@ -2,11 +2,13 @@
 # SPDX-License-Identifier: MIT
 
 from os import getenv
+
 import board
 import busio
 from digitalio import DigitalInOut
-from adafruit_esp32spi import adafruit_esp32spi
+
 import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool
+from adafruit_esp32spi import adafruit_esp32spi
 
 # Get wifi details and more from a settings.toml file
 # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
@@ -21,11 +23,10 @@
 # Secondary (SCK1) SPI used to connect to WiFi board on Arduino Nano Connect RP2040
 if "SCK1" in dir(board):
     spi = busio.SPI(board.SCK1, board.MOSI1, board.MISO1)
+elif "SPI" in dir(board):
+    spi = board.SPI()
 else:
-    if "SPI" in dir(board):
-        spi = board.SPI()
-    else:
-        spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
+    spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 # PyPortal or similar; edit pins as needed
 esp32_cs = DigitalInOut(board.ESP_CS)
 esp32_ready = DigitalInOut(board.ESP_BUSY)

examples/esp32spi_tcp_client.py

@@ -4,11 +4,13 @@
 import struct
 import time
 from os import getenv
+
 import board
 import busio
 from digitalio import DigitalInOut
-from adafruit_esp32spi import adafruit_esp32spi
+
 import adafruit_esp32spi.adafruit_esp32spi_socketpool as socketpool
+from adafruit_esp32spi import adafruit_esp32spi
 
 # Get wifi details and more from a settings.toml file
 # tokens used by this Demo: CIRCUITPY_WIFI_SSID, CIRCUITPY_WIFI_PASSWORD
@@ -24,11 +26,10 @@
 # Secondary (SCK1) SPI used to connect to WiFi board on Arduino Nano Connect RP2040
 if "SCK1" in dir(board):
     spi = busio.SPI(board.SCK1, board.MOSI1, board.MISO1)
+elif "SPI" in dir(board):
+    spi = board.SPI()
 else:
-    if "SPI" in dir(board):
-        spi = board.SPI()
-    else:
-        spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
+    spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 # PyPortal or similar; edit pins as needed
 esp32_cs = DigitalInOut(board.ESP_CS)
 esp32_ready = DigitalInOut(board.ESP_BUSY)

examples/esp32spi_udp_client.py

@@ -3,10 +3,12 @@
 
 import time
 from os import getenv
+
 import board
 import busio
-from digitalio import DigitalInOut
 import neopixel
+from digitalio import DigitalInOut
+
 from adafruit_esp32spi import adafruit_esp32spi
 from adafruit_esp32spi.adafruit_esp32spi_wifimanager import WiFiManager
 
@@ -74,11 +76,7 @@
         feed = "test"
         payload = {"value": data}
         response = wifi.post(
-            "https://io.adafruit.com/api/v2/"
-            + aio_username
-            + "/feeds/"
-            + feed
-            + "/data",
+            "https://io.adafruit.com/api/v2/" + aio_username + "/feeds/" + feed + "/data",
             json=payload,
             headers={"X-AIO-KEY": aio_key},
         )

examples/esp32spi_wpa2ent_aio_post.py

@@ -11,11 +11,13 @@
 
 import re
 import time
+
+import adafruit_connection_manager
+import adafruit_requests
 import board
 import busio
 from digitalio import DigitalInOut
-import adafruit_connection_manager
-import adafruit_requests
+
 from adafruit_esp32spi import adafruit_esp32spi
 
 
@@ -26,9 +28,7 @@ def version_compare(version1, version2):
     def normalize(v):
         return [int(x) for x in re.sub(r"(\.0+)*$", "", v).split(".")]
 
-    return (normalize(version1) > normalize(version2)) - (
-        normalize(version1) < normalize(version2)
-    )
+    return (normalize(version1) > normalize(version2)) - (normalize(version1) < normalize(version2))
 
 
 print("ESP32 SPI WPA2 Enterprise test")
@@ -98,9 +98,7 @@ def normalize(v):
 print("")
 print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi)
 print("My IP address is", esp.ipv4_address)
-print(
-    "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com"))
-)
+print("IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")))
 print("Ping google.com: %d ms" % esp.ping("google.com"))
 
 print("Done!")

examples/esp32spi_wpa2ent_simpletest.py

@@ -2,13 +2,14 @@
 #
 # SPDX-License-Identifier: MIT
 
-import time
 import random
+import time
+
 import board
-from digitalio import DigitalInOut, Direction
 import pulseio
-from adafruit_esp32spi import adafruit_esp32spi
+from digitalio import DigitalInOut, Direction
 
+from adafruit_esp32spi import adafruit_esp32spi
 
 # ESP32SPI Digital and Analog Pin Reads & Writes
 
@@ -69,11 +70,7 @@ def esp_init_pin_modes(din, dout):
 
 print("ESP32 Firmware:", esp.firmware_version)
 
-print(
-    "ESP32 MAC:      {5:02X}:{4:02X}:{3:02X}:{2:02X}:{1:02X}:{0:02X}".format(
-        *esp.MAC_address
-    )
-)
+print("ESP32 MAC:      {5:02X}:{4:02X}:{3:02X}:{2:02X}:{1:02X}:{0:02X}".format(*esp.MAC_address))
 
 # initial digital write values
 m4_d_w_val = False
@@ -113,7 +110,7 @@ def esp_init_pin_modes(din, dout):
             "Potentiometer --> ESP read: ",
             esp_a_r_val,
             " (",
-            "{:1.1f}".format(esp_a_r_val * 3.3 / 65536),
+            f"{esp_a_r_val * 3.3 / 65536:1.1f}",
             "v)",
             sep="",
         )
@@ -128,12 +125,12 @@ def esp_init_pin_modes(din, dout):
         esp.set_analog_write(ESP_A_W_PIN, esp_a_w_val)
         print(
             "ESP wrote: ",
-            "{:1.2f}".format(esp_a_w_val),
+            f"{esp_a_w_val:1.2f}",
             " (",
-            "{:d}".format(int(esp_a_w_val * 65536)),
+            f"{int(esp_a_w_val * 65536):d}",
             ")",
             " (",
-            "{:1.1f}".format(esp_a_w_val * 3.3),
+            f"{esp_a_w_val * 3.3:1.1f}",
             "v)",
             sep="",
             end=" ",
@@ -149,12 +146,12 @@ def esp_init_pin_modes(din, dout):
         duty = M4_A_R_PIN[0] / (M4_A_R_PIN[0] + M4_A_R_PIN[1])
         print(
             "--> M4 read: ",
-            "{:1.2f}".format(duty),
+            f"{duty:1.2f}",
             " (",
-            "{:d}".format(int(duty * 65536)),
+            f"{int(duty * 65536):d}",
             ")",
             " (",
-            "{:1.1f}".format(duty * 3.3),
+            f"{duty * 3.3:1.1f}",
             "v)",
             " [len=",
             len(M4_A_R_PIN),

examples/gpio/esp32spi_gpio.py

@@ -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"