Merge pull request #2 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_cycling_speed_and_cadence.py

@@ -54,10 +54,13 @@
 
 CSCMeasurementValues = namedtuple(
     "CSCMeasurementValues",
-    ("cumulative_wheel_revolutions",
-     "last_wheel_event_time",
-     "cumulative_crank_revolutions",
-     "last_crank_event_time"))
+    (
+        "cumulative_wheel_revolutions",
+        "last_wheel_event_time",
+        "cumulative_crank_revolutions",
+        "last_crank_event_time",
+    ),
+)
 """Namedtuple for measurement values.
 
 .. py:attribute:: CSCMeasurementValues.cumulative_wheel_revolutions
@@ -83,8 +86,10 @@
     wheel_revs = svc.csc_measurement_values.cumulative_wheel_revolutions
 """
 
+
 class _CSCMeasurement(ComplexCharacteristic):
     """Notify-only characteristic of speed and cadence data."""
+
     uuid = StandardUUID(0x2A5B)
 
     def __init__(self):
@@ -107,23 +112,40 @@ class CyclingSpeedAndCadenceService(Service):
     # Mandatory.
     csc_measurement = _CSCMeasurement()
 
-    csc_feature = Uint8Characteristic(uuid=StandardUUID(0x2A5C),
-                                      properties=Characteristic.READ)
-    sensor_location = Uint8Characteristic(uuid=StandardUUID(0x2A5D),
-                                          properties=Characteristic.READ)
-
-    sc_control_point = Characteristic(uuid=StandardUUID(0x2A39),
-                                      properties=Characteristic.WRITE)
-
-    _SENSOR_LOCATIONS = ("Other", "Top of shoe", "In shoe", "Hip",
-                         "Front Wheel", "Left Crank", "Right Crank",
-                         "Left Pedal", "Right Pedal", "Front Hub",
-                         "Rear Dropout", "Chainstay", "Rear Wheel",
-                         "Rear Hub", "Chest", "Spider", "Chain Ring")
+    csc_feature = Uint8Characteristic(
+        uuid=StandardUUID(0x2A5C), properties=Characteristic.READ
+    )
+    sensor_location = Uint8Characteristic(
+        uuid=StandardUUID(0x2A5D), properties=Characteristic.READ
+    )
+
+    sc_control_point = Characteristic(
+        uuid=StandardUUID(0x2A39), properties=Characteristic.WRITE
+    )
+
+    _SENSOR_LOCATIONS = (
+        "Other",
+        "Top of shoe",
+        "In shoe",
+        "Hip",
+        "Front Wheel",
+        "Left Crank",
+        "Right Crank",
+        "Left Pedal",
+        "Right Pedal",
+        "Front Hub",
+        "Rear Dropout",
+        "Chainstay",
+        "Rear Wheel",
+        "Rear Hub",
+        "Chest",
+        "Spider",
+        "Chain Ring",
+    )
 
     def __init__(self, service=None):
         super().__init__(service=service)
-        self._measurement_buf = bytearray(self.csc_measurement.packet_size)
+        self._measurement_buf = bytearray(self.csc_measurement.packet_size) #pylint: disable=no-member
 
     @property
     def measurement_values(self):
@@ -146,7 +168,7 @@ def measurement_values(self):
         #
 
         buf = self._measurement_buf
-        packet_length = self.csc_measurement.readinto(buf)
+        packet_length = self.csc_measurement.readinto(buf) #pylint: disable=no-member
         if packet_length == 0:
             return None
         flags = buf[0]
@@ -187,5 +209,6 @@ def location(self):
         except IndexError:
             return "InvalidLocation"
 
+
 #    def set_cumulative_wheel_revolutions(self, value):
 #        self._control_point_request(self.pack("<BLBB", 1, value, 0, )

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_Cycling_Speed_and_Cadence Library'
-copyright = u'2020 Adafruit Industries'
-author = u'Adafruit Industries'
+project = u"Adafruit BLE_Cycling_Speed_and_Cadence Library"
+copyright = u"2020 Adafruit Industries"
+author = u"Adafruit Industries"
 
 # 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_cycling_speed_and_cadenceLibrarydoc'
+htmlhelp_basename = "AdafruitBle_cycling_speed_and_cadenceLibrarydoc"
 
 # -- 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_Cycling_Speed_And_CadenceLibrary.tex', u'AdafruitBLE_Cycling_Speed_And_Cadence Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBLE_Cycling_Speed_And_CadenceLibrary.tex",
+        u"AdafruitBLE_Cycling_Speed_And_Cadence 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_Cycling_Speed_And_Cadencelibrary', u'Adafruit BLE_Cycling_Speed_And_Cadence Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBLE_Cycling_Speed_And_Cadencelibrary",
+        u"Adafruit BLE_Cycling_Speed_And_Cadence 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_Cycling_Speed_And_CadenceLibrary', u'Adafruit BLE_Cycling_Speed_And_Cadence Library Documentation',
-     author, 'AdafruitBLE_Cycling_Speed_And_CadenceLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBLE_Cycling_Speed_And_CadenceLibrary",
+        u"Adafruit BLE_Cycling_Speed_And_Cadence Library Documentation",
+        author,
+        "AdafruitBLE_Cycling_Speed_And_CadenceLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ble_cycling_speed_and_cadence_simpletest.py

@@ -11,7 +11,7 @@
 from adafruit_ble_cycling_speed_and_cadence import CyclingSpeedAndCadenceService
 
 # PyLint can't find BLERadio for some reason so special case it here.
-ble = adafruit_ble.BLERadio()    # pylint: disable=no-member
+ble = adafruit_ble.BLERadio()  # pylint: disable=no-member
 
 
 while True: