Merge pull request #10 from adafruit/discord-fix

Using python 3.7 so sphinx is ok with __future__

.github/workflows/build.yml

@@ -18,10 +18,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.6
+    - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
-        python-version: 3.6
+        python-version: 3.7
     - name: Versions
       run: |
         python3 --version
@@ -43,6 +43,9 @@ jobs:
         pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
+    - name: Check formatting
+      run: |
+        black --check --target-version=py35 .
     - name: PyLint
       run: |
         pylint $( find . -path './adafruit*.py' )

.github/workflows/release.yml

@@ -20,10 +20,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.6
+    - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
-        python-version: 3.6
+        python-version: 3.7
     - name: Versions
       run: |
         python3 --version

.pylintrc

@@ -52,7 +52,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

CODE_OF_CONDUCT.md

@@ -34,6 +34,8 @@ Examples of unacceptable behavior by participants include:
 * Excessive or unwelcome helping; answering outside the scope of the question
   asked
 * Trolling, insulting/derogatory comments, and personal or political attacks
+* Promoting or spreading disinformation, lies, or conspiracy theories against
+  a person, group, organisation, project, or community
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
   address, without explicit permission
@@ -41,7 +43,7 @@ Examples of unacceptable behavior by participants include:
 
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
-"technically unimpeachable", but rather try to be your best self.
+"technically unimpeachable", but rather try to be your best self. 
 
 We value many things beyond technical expertise, including collaboration and
 supporting others within our community. Providing a positive experience for
@@ -72,10 +74,10 @@ You may report in the following ways:
 In any situation, you may send an email to <support@adafruit.com>.
 
 On the Adafruit Discord, you may send an open message from any channel
-to all Community Helpers by tagging @community moderators. You may also send an
-open message from any channel, or a direct message to @kattni#1507,
-@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
-@Andon#8175.
+to all Community Moderators by tagging @community moderators. You may 
+also send an open message from any channel, or a direct message to 
+@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 
+@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.
 

README.rst

@@ -6,7 +6,7 @@ Introduction
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
-    :target: https://discord.gg/nBQh6qu
+    :target: https://adafru.it/discord
     :alt: Discord
     
 .. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Apple_Notification_Center/workflows/Build%20CI/badge.svg

adafruit_ble_apple_notification_center.py

@@ -63,7 +63,9 @@ class _NotificationAttribute:
             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)
@@ -71,6 +73,7 @@ class _NotificationAttribute:
         notification._attribute_cache[self._id] = value
         return value
 
+
 NOTIFICATION_CATEGORIES = (
     "Other",
     "IncomingCall",
@@ -83,11 +86,13 @@ NOTIFICATION_CATEGORIES = (
     "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 @@ class Notification:
             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,13 +212,16 @@ 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)
@@ -206,18 +229,25 @@ class AppleNotificationCenterService(Service):
 
     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,7 +2,8 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -10,42 +11,45 @@ sys.path.insert(0, os.path.abspath('..'))
 # 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!
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = []
+autodoc_mock_imports = ["bleak"]
 
 
-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 = "Adafruit BLE_Apple_Notification_Center Library"
+copyright = "2019 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 @@ language = None
 # 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 @@ default_role = "any"
 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,59 +88,62 @@ napoleon_numpy_docstring = False
 # 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",
+        "AdafruitBLE_Apple_Notification_Center Library Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
@@ -144,8 +151,13 @@ latex_documents = [
 # 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",
+        "Adafruit BLE_Apple_Notification_Center Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +166,13 @@ man_pages = [
 # (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",
+        "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 @@ from adafruit_ble.advertising.standard import SolicitServicesAdvertisement
 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 @@ from adafruit_ble.advertising.standard import SolicitServicesAdvertisement
 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)

setup.py

@@ -6,6 +6,7 @@ https://github.com/pypa/sampleproject
 """
 
 from setuptools import setup, find_packages
+
 # To use a consistent encoding
 from codecs import open
 from os import path
@@ -13,53 +14,41 @@ from os import path
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-ble-apple-notification-center',
-
+    name="adafruit-circuitpython-ble-apple-notification-center",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='BLE library for the Apple Notification Center',
+    setup_requires=["setuptools_scm"],
+    description="BLE library for the Apple Notification Center",
     long_description=long_description,
-    long_description_content_type='text/x-rst',
-
+    long_description_content_type="text/x-rst",
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_BLE_Apple_Notification_Center',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_BLE_Apple_Notification_Center",
     # Author details
-    author='Adafruit Industries',
-    author_email='circuitpython@adafruit.com',
-
-    install_requires=[
-        'Adafruit-Blinka',
-        'adafruit-circuitpython-ble'
-    ],
-
+    author="Adafruit Industries",
+    author_email="circuitpython@adafruit.com",
+    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-ble"],
     # Choose your license
-    license='MIT',
-
+    license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: System :: Hardware',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
     ],
-
     # What does your project relate to?
-    keywords='adafruit blinka circuitpython micropython ble_apple_notification_center ble '
-             'ancs apple notification',
-
+    keywords="adafruit blinka circuitpython micropython ble_apple_notification_center ble "
+    "ancs apple notification",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
     #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=['adafruit_ble_apple_notification_center'],
+    py_modules=["adafruit_ble_apple_notification_center"],
 )