Black and lint

Author: tannewt

adafruit_ble_midi.py

@@ -39,46 +39,69 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE_MIDI.git"
 
+
 class _MidiCharacteristic(ComplexCharacteristic):
     """Endpoint for sending commands to a media player. The value read will list all available
 
        commands."""
+
     uuid = VendorUUID("7772E5DB-3868-4112-A1A9-F2669D106BF3")
 
     def __init__(self):
-        super().__init__(properties=Characteristic.WRITE_NO_RESPONSE | Characteristic.READ | Characteristic.NOTIFY,
-                         read_perm=Attribute.ENCRYPT_NO_MITM, write_perm=Attribute.ENCRYPT_NO_MITM,
-                         max_length=512,
-                         fixed_length=False)
+        super().__init__(
+            properties=Characteristic.WRITE_NO_RESPONSE
+            | Characteristic.READ
+            | Characteristic.NOTIFY,
+            read_perm=Attribute.ENCRYPT_NO_MITM,
+            write_perm=Attribute.ENCRYPT_NO_MITM,
+            max_length=512,
+            fixed_length=False,
+        )
 
     def bind(self, service):
         """Binds the characteristic to the given Service."""
         bound_characteristic = super().bind(service)
-        return _bleio.PacketBuffer(bound_characteristic,
-                                   buffer_size=4)
+        return _bleio.PacketBuffer(bound_characteristic, buffer_size=4)
+
 
 class MIDIService(Service):
+    """BLE MIDI service. It acts just like a USB MIDI PortIn and PortOut and can be used as a drop
+       in replacement.
+
+       BLE MIDI's protocol includes timestamps for MIDI messages. This class automatically adds them
+       to MIDI data written out and strips them from MIDI data read in."""
+
     uuid = VendorUUID("03B80E5A-EDE8-4B33-A751-6CE34EC4C700")
     _raw = _MidiCharacteristic()
+    # _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
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self._in_buffer = bytearray(self._raw.packet_size)
         self._out_buffer = None
         shared_buffer = memoryview(bytearray(4))
-        self._buffers = [None, shared_buffer[:1], shared_buffer[:2], shared_buffer[:3], shared_buffer[:4]]
+        self._buffers = [
+            None,
+            shared_buffer[:1],
+            shared_buffer[:2],
+            shared_buffer[:3],
+            shared_buffer[:4],
+        ]
         self._header = bytearray(1)
         self._in_sysex = False
         self._message_target_length = None
         self._message_length = 0
         self._pending_realtime = None
         self._in_length = 0
         self._in_index = 1
-        self._last_read = time.monotonic_ns() // 1000000
-        self._last_low_ms = None
         self._last_data = True
 
     def readinto(self, buf, length):
+        """Reads up to ``length`` bytes into ``buf`` starting at index 0.
+
+           Returns the number of bytes written into ``buf``."""
         i = 0
         while i < length:
             if self._in_index < self._in_length:
@@ -109,45 +132,53 @@ def readinto(self, buf, length):
         return i
 
     def read(self, length):
+        """Reads up to ``length`` bytes and returns them."""
         result = bytearray(length)
         i = self.readinto(result, length)
         return result[:i]
 
     def write(self, buf, length):
+        """Writes ``length`` bytes out."""
+        # pylint: disable=too-many-branches
         timestamp_ms = time.monotonic_ns() // 1000000
-        self._header[0] = (timestamp_ms >> 7 & 0x3f) | 0x80
+        self._header[0] = (timestamp_ms >> 7 & 0x3F) | 0x80
         i = 0
         while i < length:
             data = buf[i]
             command = data & 0x80 != 0
             if self._in_sysex:
-                if command: # End of sysex or real time
+                if command:  # End of sysex or real time
                     b = self._buffers[2]
-                    b[0] = 0x80 | (timestamp_ms & 0x7f)
-                    b[1] = 0xf7
+                    b[0] = 0x80 | (timestamp_ms & 0x7F)
+                    b[1] = 0xF7
                     self._raw.write(b, header=self._header)
-                    self._in_sysex = data == 0xf7
+                    self._in_sysex = data == 0xF7
                 else:
                     b = self._buffers[1]
                     b[0] = data
                     self._raw.write(b, header=self._header)
             elif command:
-                self._in_sysex = data == 0xf0
+                self._in_sysex = data == 0xF0
                 b = self._buffers[2]
-                b[0] = 0x80 | (timestamp_ms & 0x7f)
+                b[0] = 0x80 | (timestamp_ms & 0x7F)
                 b[1] = data
-                if 0xf6 <= data <= 0xff or self._in_sysex: # Real time, command only or start sysex
+                if (
+                    0xF6 <= data <= 0xFF or self._in_sysex
+                ):  # Real time, command only or start sysex
                     if self._message_target_length:
                         self._pending_realtime = b
                     else:
                         self._raw.write(b, self._header)
                 else:
-                    if 0x80 <= data <= 0xbf or 0xe0 <= data <= 0xef or data == 0xf2: # Two following bytes
+                    if (
+                        0x80 <= data <= 0xBF or 0xE0 <= data <= 0xEF or data == 0xF2
+                    ):  # Two following bytes
                         self._message_target_length = 4
                     else:
                         self._message_target_length = 3
                     b = self._buffers[self._message_target_length]
-                    # All of the buffers share memory so the timestamp and data have already been set.
+                    # All of the buffers share memory so the timestamp and data have already been
+                    # set.
                     self._message_length = 2
                     self._out_buffer = b
             else:

docs/conf.py

@@ -2,18 +2,19 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
 ]
 
 # TODO: Please Read!
@@ -23,29 +24,32 @@
 # autodoc_mock_imports = ["digitalio", "busio"]
 
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit BLE_MIDI Library'
-copyright = u'2020 Scott Shawcroft'
-author = u'Scott Shawcroft'
+project = "Adafruit BLE_MIDI Library"
+copyright = "2020 Scott Shawcroft"
+author = "Scott Shawcroft"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = "1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -57,7 +61,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -69,7 +73,7 @@
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -84,68 +88,76 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
-        html_theme = 'sphinx_rtd_theme'
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
     except:
-        html_theme = 'default'
-        html_theme_path = ['.']
+        html_theme = "default"
+        html_theme_path = ["."]
 else:
-    html_theme_path = ['.']
+    html_theme_path = ["."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitBle_midiLibrarydoc'
+htmlhelp_basename = "AdafruitBle_midiLibrarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitBLE_MIDILibrary.tex', u'AdafruitBLE_MIDI Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBLE_MIDILibrary.tex",
+        "AdafruitBLE_MIDI Library Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'AdafruitBLE_MIDIlibrary', u'Adafruit BLE_MIDI Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBLE_MIDIlibrary",
+        "Adafruit BLE_MIDI Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +166,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitBLE_MIDILibrary', u'Adafruit BLE_MIDI Library Documentation',
-     author, 'AdafruitBLE_MIDILibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBLE_MIDILibrary",
+        "Adafruit BLE_MIDI Library Documentation",
+        author,
+        "AdafruitBLE_MIDILibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ble_midi_simplein.py

@@ -4,10 +4,12 @@
 
 import time
 import adafruit_ble
+from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
 import adafruit_ble_midi
 import adafruit_midi
-from adafruit_ble.advertising import Advertisement
-from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
+
+# These import auto-register the message type with the MIDI machinery.
+# pylint: disable=unused-import
 from adafruit_midi.control_change import ControlChange
 from adafruit_midi.midi_message import MIDIUnknownEvent
 from adafruit_midi.note_off import NoteOff