pylint and black fixes

Author: todbot

adafruit_usb_host_midi.py

@@ -20,7 +20,18 @@
 
 DIR_IN = 0x80
 
+
 class MIDI:
+    """
+    Stream-like MIDI device for use with `adafruit_midi` and similar upstream
+    MIDI parser libraries.
+
+    :param device: a ``usb.core.Device` object which implements
+        ``read(endpoint, buffer)`` and ``write(endpoint,buffer)``
+    :param float timeout: timeout in seconds to wait for read or write operation
+        to succeeds. Default to None, i.e. reads and writes will block.
+    """
+
     def __init__(self, device, timeout=None):
         self.interface_number = 0
         self.in_ep = 0
@@ -42,14 +53,16 @@ def __init__(self, device, timeout=None):
             descriptor_len = config_descriptor[i]
             descriptor_type = config_descriptor[i + 1]
             if descriptor_type == adafruit_usb_host_descriptors.DESC_CONFIGURATION:
+                # pylint: disable=unused-variable
                 config_value = config_descriptor[i + 5]
+                # pylint: enable=unused-variable
             elif descriptor_type == adafruit_usb_host_descriptors.DESC_INTERFACE:
                 interface_number = config_descriptor[i + 2]
                 interface_class = config_descriptor[i + 5]
                 interface_subclass = config_descriptor[i + 6]
                 midi_interface = interface_class == 0x1 and interface_subclass == 0x3
                 if midi_interface:
-                    self.interface_number= interface_number
+                    self.interface_number = interface_number
 
             elif descriptor_type == adafruit_usb_host_descriptors.DESC_ENDPOINT:
                 endpoint_address = config_descriptor[i + 2]
@@ -65,20 +78,39 @@ def __init__(self, device, timeout=None):
         device.detach_kernel_driver(self.interface_number)
 
     def read(self, size):
+        """
+        Read bytes.  If ``nbytes`` is specified then read at most that many
+        bytes. Otherwise, read everything that arrives until the connection
+        times out. Providing the number of bytes expected is highly recommended
+        because it will be faster. If no bytes are read, return ``None``.
+
+        .. note:: When no bytes are read due to a timeout, this function returns ``None``.
+          This matches the behavior of `io.RawIOBase.read` in Python 3, but
+          differs from pyserial which returns ``b''`` in that situation.
+
+        :return: Data read
+        :rtype: bytes or None
+        """
+
         if self._remaining == 0:
             try:
                 n = self.device.read(self.in_ep, self.buf, self.timeout_ms)
                 self._remaining = n - 1
                 self.start = 1
-            except usb.core.USBTimeoutError as e:
+            except usb.core.USBTimeoutError:
                 pass
         size = min(size, self._remaining)
-        b = self.buf[self.start:self.start + size]
+        b = self.buf[self.start : self.start + size]
         self.start += size
         self._remaining -= size
         return b
 
     def readinto(self, buf):
+        """Read bytes into the ``buf``. Read at most ``len(buf)`` bytes.
+
+        :return: number of bytes read and stored into ``buf``
+        :rtype: int or None (on a non-blocking error)
+        """
         b = self.read(len(buf))
         n = len(b)
         if n:
@@ -87,4 +119,9 @@ def readinto(self, buf):
 
     def __repr__(self):
         # also idProduct/idVendor for vid/pid
-        return "MIDI Device " + str(self.device.manufacturer) + "/" + str(self.device.product)
+        return (
+            "MIDI Device "
+            + str(self.device.manufacturer)
+            + "/"
+            + str(self.device.product)
+        )

examples/usb_host_midi_simpletest.py

@@ -5,12 +5,12 @@
 import audiobusio
 import board
 import synthio
-import adafruit_midi
-import adafruit_usb_host_midi
 import usb.core
+import wm8960
+import adafruit_midi
 from adafruit_midi.note_on import NoteOn
 from adafruit_midi.note_off import NoteOff
-import wm8960
+import adafruit_usb_host_midi
 
 print("Looking for midi device")
 raw_midi = None
@@ -26,7 +26,9 @@
 # This setup is for the headphone output on the iMX RT 1060 EVK.
 dac = wm8960.WM8960(board.I2C())
 dac.start_i2s_out()
-audio = audiobusio.I2SOut(board.AUDIO_BCLK, board.AUDIO_SYNC, board.AUDIO_TXD, main_clock=board.AUDIO_MCLK)
+audio = audiobusio.I2SOut(
+    board.AUDIO_BCLK, board.AUDIO_SYNC, board.AUDIO_TXD, main_clock=board.AUDIO_MCLK
+)
 synth = synthio.Synthesizer(sample_rate=44100)
 audio.play(synth)
 
@@ -41,7 +43,9 @@
         print("noteOn: ", msg.note, "vel:", msg.velocity)
         synth.press(note)
         pressed[msg.note] = note
-    elif (isinstance(msg,NoteOff) or (isinstance(msg,NoteOn) and msg.velocity==0)) and msg.note in pressed:
+    elif (
+        isinstance(msg, NoteOff) or (isinstance(msg, NoteOn) and msg.velocity == 0)
+    ) and msg.note in pressed:
         print("noteOff:", msg.note, "vel:", msg.velocity)
         note = pressed[msg.note]
         synth.release(note)

examples/usb_host_midi_simpletest_rp2040usbfeather.py

@@ -1,17 +1,17 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
+# pylint: disable=unused-import
 
 import board
 import busio
-import synthio
-import adafruit_midi
-import adafruit_usb_host_midi
 import usb.core
+import adafruit_midi
 from adafruit_midi.note_on import NoteOn
 from adafruit_midi.note_off import NoteOff
 from adafruit_midi.control_change import ControlChange
 from adafruit_midi.pitch_bend import PitchBend
+import adafruit_usb_host_midi
 
 print("Looking for midi device")
 raw_midi = None
@@ -35,5 +35,5 @@
 while True:
     msg = midi_device.receive()
     if msg:
-        print("midi msg:",msg)
+        print("midi msg:", msg)
         midi_uart.send(msg)