Merge pull request #8 from adafruit/pylint-update

Ran black, updated to pylint 2.x

Author: kattni

adafruit_ble_apple_notification_center.py

@@ -63,14 +63,17 @@ def __get__(self, notification, cls):
             pass
 
         _, _ = struct.unpack("<BI", notification.data_source.read(5))
-        attribute_id, attribute_length = struct.unpack("<BH", notification.data_source.read(3))
+        attribute_id, attribute_length = struct.unpack(
+            "<BH", notification.data_source.read(3)
+        )
         if attribute_id != self._id:
             raise RuntimeError("Data for other attribute")
         value = notification.data_source.read(attribute_length)
         value = value.decode("utf-8")
         notification._attribute_cache[self._id] = value
         return value
 
+
 NOTIFICATION_CATEGORIES = (
     "Other",
     "IncomingCall",
@@ -83,11 +86,13 @@ def __get__(self, notification, cls):
     "HealthAndFitness",
     "BusinessAndFinance",
     "Location",
-    "Entertainment"
+    "Entertainment",
 )
 
+
 class Notification:
     """One notification that appears in the iOS notification center."""
+
     # pylint: disable=too-many-instance-attributes
 
     app_id = _NotificationAttribute(0)
@@ -113,15 +118,22 @@ class Notification:
     negative_action_label = _NotificationAttribute(7)
     """Human readable label of the negative action."""
 
-    def __init__(self, notification_id, event_flags, category_id, category_count, *, control_point,
-                 data_source):
-        self.id = notification_id # pylint: disable=invalid-name
+    def __init__(
+        self,
+        notification_id,
+        event_flags,
+        category_id,
+        category_count,
+        *,
+        control_point,
+        data_source
+    ):
+        self.id = notification_id  # pylint: disable=invalid-name
         """Integer id of the notification."""
 
         self.removed = False
         """True when the notification has been cleared on the iOS device."""
 
-
         self.silent = False
         self.important = False
         self.preexisting = False
@@ -178,12 +190,20 @@ def __str__(self):
             flags.append("positive_action")
         if self.negative_action:
             flags.append("negative_action")
-        return (category + " " +
-                " ".join(flags) + " " +
-                self.app_id + " " +
-                str(self.title) + " " +
-                str(self.subtitle) + " " +
-                str(self.message))
+        return (
+            category
+            + " "
+            + " ".join(flags)
+            + " "
+            + self.app_id
+            + " "
+            + str(self.title)
+            + " "
+            + str(self.subtitle)
+            + " "
+            + str(self.message)
+        )
+
 
 class AppleNotificationCenterService(Service):
     """Notification service.
@@ -192,32 +212,42 @@ class AppleNotificationCenterService(Service):
       https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Specification/Specification.html
 
     """
+
     uuid = VendorUUID("7905F431-B5CE-4E99-A40F-4B1E122D00D0")
 
     control_point = StreamIn(uuid=VendorUUID("69D1D8F3-45E1-49A8-9821-9BBDFDAAD9D9"))
-    data_source = StreamOut(uuid=VendorUUID("22EAC6E9-24D6-4BB5-BE44-B36ACE7C7BFB"),
-                            buffer_size=1024)
-    notification_source = StreamOut(uuid=VendorUUID("9FBF120D-6301-42D9-8C58-25E699A21DBD"),
-                                    buffer_size=8*100)
+    data_source = StreamOut(
+        uuid=VendorUUID("22EAC6E9-24D6-4BB5-BE44-B36ACE7C7BFB"), buffer_size=1024
+    )
+    notification_source = StreamOut(
+        uuid=VendorUUID("9FBF120D-6301-42D9-8C58-25E699A21DBD"), buffer_size=8 * 100
+    )
 
     def __init__(self, service=None):
         super().__init__(service=service)
         self._active_notifications = {}
 
     def _update(self):
         # Pylint is incorrectly inferring the type of self.notification_source so disable no-member.
-        while self.notification_source.in_waiting > 7: # pylint: disable=no-member
-            buffer = self.notification_source.read(8) # pylint: disable=no-member
-            event_id, event_flags, category_id, category_count, nid = struct.unpack("<BBBBI",
-                                                                                    buffer)
+        while self.notification_source.in_waiting > 7:  # pylint: disable=no-member
+            buffer = self.notification_source.read(8)  # pylint: disable=no-member
+            event_id, event_flags, category_id, category_count, nid = struct.unpack(
+                "<BBBBI", buffer
+            )
             if event_id == 0:
-                self._active_notifications[nid] = Notification(nid, event_flags, category_id,
-                                                               category_count,
-                                                               control_point=self.control_point,
-                                                               data_source=self.data_source)
+                self._active_notifications[nid] = Notification(
+                    nid,
+                    event_flags,
+                    category_id,
+                    category_count,
+                    control_point=self.control_point,
+                    data_source=self.data_source,
+                )
                 yield self._active_notifications[nid]
             elif event_id == 1:
-                self._active_notifications[nid].update(event_flags, category_id, category_count)
+                self._active_notifications[nid].update(
+                    event_flags, category_id, category_count
+                )
                 yield None
             elif event_id == 2:
                 self._active_notifications[nid].removed = True

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 = []
 
 
-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_Notification_Center Library'
-copyright = u'2019 Scott Shawcroft'
-author = u'Scott Shawcroft'
+project = u"Adafruit BLE_Apple_Notification_Center Library"
+copyright = u"2019 Scott Shawcroft"
+author = u"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 = u"1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = u"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_apple_notification_centerLibrarydoc'
+htmlhelp_basename = "AdafruitBle_apple_notification_centerLibrarydoc"
 
 # -- 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_Notification_CenterLibrary.tex', u'AdafruitBLE_Apple_Notification_Center Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBLE_Apple_Notification_CenterLibrary.tex",
+        u"AdafruitBLE_Apple_Notification_Center 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_Notification_Centerlibrary', u'Adafruit BLE_Apple_Notification_Center Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBLE_Apple_Notification_Centerlibrary",
+        u"Adafruit BLE_Apple_Notification_Center 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_Apple_Notification_CenterLibrary', u'Adafruit BLE_Apple_Notification_Center Library Documentation',
-     author, 'AdafruitBLE_Apple_Notification_CenterLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBLE_Apple_Notification_CenterLibrary",
+        u"Adafruit BLE_Apple_Notification_Center Library Documentation",
+        author,
+        "AdafruitBLE_Apple_Notification_CenterLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ble_apple_notification_center_new.py

@@ -9,7 +9,7 @@
 import adafruit_ble_apple_notification_center as ancs
 
 # 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(ancs.AppleNotificationCenterService)
 radio.start_advertising(a)

examples/ble_apple_notification_center_simpletest.py

@@ -8,7 +8,7 @@
 import adafruit_ble_apple_notification_center as ancs
 
 # 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(ancs.AppleNotificationCenterService)
 radio.start_advertising(a)