Merge pull request #5 from adafruit/pylint-update

Ran black, updated to pylint 2.x

Author: kattni

.github/workflows/build.yml

@@ -40,7 +40,7 @@ jobs:
         source actions-ci/install.sh
     - name: Pip install pylint, black, & Sphinx
       run: |
-        pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
+        pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

adafruit_ble_apple_media.py

@@ -45,49 +45,62 @@
 # Disable protected access checks since our private classes are tightly coupled.
 # pylint: disable=protected-access
 
+
 class _RemoteCommand(ComplexCharacteristic):
     """Endpoint for sending commands to a media player. The value read will list all available
 
        commands."""
+
     uuid = VendorUUID("9B3C81D8-57B1-4A8A-B8DF-0E56F7CA51C2")
 
     def __init__(self):
-        super().__init__(properties=Characteristic.WRITE_NO_RESPONSE | Characteristic.NOTIFY,
-                         read_perm=Attribute.OPEN, write_perm=Attribute.OPEN,
-                         max_length=13,
-                         fixed_length=False)
+        super().__init__(
+            properties=Characteristic.WRITE_NO_RESPONSE | Characteristic.NOTIFY,
+            read_perm=Attribute.OPEN,
+            write_perm=Attribute.OPEN,
+            max_length=13,
+            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=1)
+        return _bleio.PacketBuffer(bound_characteristic, buffer_size=1)
+
 
 class _EntityUpdate(ComplexCharacteristic):
     """UTF-8 Encoded string characteristic."""
+
     uuid = VendorUUID("2F7CABCE-808D-411F-9A0C-BB92BA96C102")
 
     def __init__(self):
-        super().__init__(properties=Characteristic.WRITE | Characteristic.NOTIFY,
-                         read_perm=Attribute.OPEN, write_perm=Attribute.OPEN,
-                         max_length=128,
-                         fixed_length=False)
-
+        super().__init__(
+            properties=Characteristic.WRITE | Characteristic.NOTIFY,
+            read_perm=Attribute.OPEN,
+            write_perm=Attribute.OPEN,
+            max_length=128,
+            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=8)
+        return _bleio.PacketBuffer(bound_characteristic, buffer_size=8)
+
 
-class _EntityAttribute(Characteristic): # pylint: disable=too-few-public-methods
+class _EntityAttribute(Characteristic):  # pylint: disable=too-few-public-methods
     """UTF-8 Encoded string characteristic."""
+
     uuid = VendorUUID("C6B2F38C-23AB-46D8-A6AB-A3A870BBD5D7")
 
     def __init__(self):
-        super().__init__(properties=Characteristic.WRITE | Characteristic.READ,
-                         read_perm=Attribute.OPEN, write_perm=Attribute.OPEN,
-                         fixed_length=False)
+        super().__init__(
+            properties=Characteristic.WRITE | Characteristic.READ,
+            read_perm=Attribute.OPEN,
+            write_perm=Attribute.OPEN,
+            fixed_length=False,
+        )
+
 
 class _MediaAttribute:
     def __init__(self, entity_id, attribute_id):
@@ -103,7 +116,11 @@ def _update(obj):
                 raise RuntimeError("packet too short")
             # Even though flags is currently unused, if it were removed, it would cause there to be
             # too many values to unpack which would raise a ValueError
-            entity_id, attribute_id, flags = struct.unpack_from("<BBB", obj._buffer) # pylint: disable=unused-variable
+            (
+                entity_id,
+                attribute_id,
+                flags,  # pylint: disable=unused-variable
+            ) = struct.unpack_from("<BBB", obj._buffer)
             value = str(obj._buffer[3:length_read], "utf-8")
             obj._attribute_cache[(entity_id, attribute_id)] = value
 
@@ -114,13 +131,14 @@ def __get__(self, obj, cls):
             for k in obj._attribute_cache:
                 if k[0] == self.key[0] and k[1] not in siblings:
                     siblings.append(k[1])
-            buf = struct.pack("<B" + "B"*len(siblings), self.key[0], *siblings)
+            buf = struct.pack("<B" + "B" * len(siblings), self.key[0], *siblings)
             obj._entity_update.write(buf)
             obj._attribute_cache[self.key] = None
             time.sleep(0.05)
             self._update(obj)
         return obj._attribute_cache[self.key]
 
+
 class _MediaAttributePlaybackState:
     def __init__(self, playback_value):
         self._playback_value = playback_value
@@ -131,6 +149,7 @@ def __get__(self, obj, cls):
             return int(info.split(",")[0]) == self._playback_value
         return False
 
+
 class _MediaAttributePlaybackInfo:
     def __init__(self, position):
         self._position = position
@@ -141,9 +160,11 @@ def __get__(self, obj, cls):
             return float(info.split(",")[self._position])
         return 0
 
+
 class UnsupportedCommand(Exception):
     """Raised when the command isn't available with current media player app."""
 
+
 class AppleMediaService(Service):
     """View and control currently playing media.
 
@@ -152,6 +173,7 @@ class AppleMediaService(Service):
     `artist` includes a description of the remote playback.
 
     """
+
     uuid = VendorUUID("89D3502B-0F36-433A-8EF4-C502AD55F8DC")
 
     _remote_command = _RemoteCommand()
@@ -207,7 +229,9 @@ def __init__(self, **kwargs):
     def _send_command(self, command_id):
         if not self._command_buffer:
             self._command_buffer = bytearray(13)
-        i = self._remote_command.readinto(self._command_buffer) # pylint: disable=no-member
+        i = self._remote_command.readinto(  # pylint: disable=no-member
+            self._command_buffer
+        )
         if i > 0:
             self._supported_commands = list(self._command_buffer[:i])
         if command_id not in self._supported_commands:
@@ -217,7 +241,7 @@ def _send_command(self, command_id):
         if not self._cmd:
             self._cmd = bytearray(1)
         self._cmd[0] = command_id
-        self._remote_command.write(self._cmd) # pylint: disable=no-member
+        self._remote_command.write(self._cmd)  # pylint: disable=no-member
 
     def play(self):
         """Plays the current track. Does nothing if already playing."""

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",
 ]
 
 # Uncomment the below if you use native CircuitPython modules such as
@@ -22,29 +23,32 @@
 # autodoc_mock_imports = []
 
 
-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_Apple_Media Library'
-copyright = u'2020 Scott Shawcroft'
-author = u'Scott Shawcroft'
+project = "Adafruit BLE_Apple_Media 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.
@@ -56,7 +60,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.
@@ -68,7 +72,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
@@ -83,68 +87,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_apple_mediaLibrarydoc'
+htmlhelp_basename = "AdafruitBle_apple_mediaLibrarydoc"
 
 # -- 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_Apple_MediaLibrary.tex', u'AdafruitBLE_Apple_Media Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBLE_Apple_MediaLibrary.tex",
+        "AdafruitBLE_Apple_Media 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_Apple_Medialibrary', u'Adafruit BLE_Apple_Media Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBLE_Apple_Medialibrary",
+        "Adafruit BLE_Apple_Media Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -153,7 +165,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitBLE_Apple_MediaLibrary', u'Adafruit BLE_Apple_Media Library Documentation',
-     author, 'AdafruitBLE_Apple_MediaLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBLE_Apple_MediaLibrary",
+        "Adafruit BLE_Apple_Media Library Documentation",
+        author,
+        "AdafruitBLE_Apple_MediaLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ble_apple_media_simpletest.py

@@ -9,7 +9,7 @@
 from adafruit_ble_apple_media import AppleMediaService
 
 # PyLint can't find BLERadio for some reason so special case it here.
-radio = adafruit_ble.BLERadio() # pylint: disable=no-member
+radio = adafruit_ble.BLERadio()  # pylint: disable=no-member
 a = SolicitServicesAdvertisement()
 a.solicited_services.append(AppleMediaService)
 radio.start_advertising(a)