Blacken everything

Author: tannewt

.github/workflows/build.yml

@@ -39,6 +39,9 @@ jobs:
         source actions-ci/install.sh
     - 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' )

adafruit_ble_broadcastnet.py

@@ -55,6 +55,8 @@
 
 _ble = adafruit_ble.BLERadio()
 _sequence_number = 0
+
+
 def broadcast(measurement, *, broadcast_time=0.1, extended=False):
     """Broadcasts the given measurement for the given broadcast time. If extended is False and the
        measurement would be too long, it will be split into multiple measurements for transmission."""
@@ -66,71 +68,75 @@ def broadcast(measurement, *, broadcast_time=0.1, extended=False):
         _ble.stop_advertising()
         _sequence_number = (_sequence_number + 1) % 256
 
-device_address = "{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}".format(*_ble._adapter.address.address_bytes)
 
-_MANUFACTURING_DATA_ADT = const(0xff)
+device_address = "{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}".format(
+    *_ble._adapter.address.address_bytes
+)
+
+_MANUFACTURING_DATA_ADT = const(0xFF)
 _ADAFRUIT_COMPANY_ID = const(0x0822)
 
+
 class AdafruitSensorMeasurement(Advertisement):
     """Broadcast a single RGB color."""
+
     # This prefix matches all
-    prefix = struct.pack("<BBH",
-                         3,
-                         _MANUFACTURING_DATA_ADT,
-                         _ADAFRUIT_COMPANY_ID)
+    prefix = struct.pack("<BBH", 3, _MANUFACTURING_DATA_ADT, _ADAFRUIT_COMPANY_ID)
 
-    manufacturer_data = LazyObjectField(ManufacturerData,
-                                        "manufacturer_data",
-                                        advertising_data_type=_MANUFACTURING_DATA_ADT,
-                                        company_id=_ADAFRUIT_COMPANY_ID,
-                                        key_encoding="<H")
+    manufacturer_data = LazyObjectField(
+        ManufacturerData,
+        "manufacturer_data",
+        advertising_data_type=_MANUFACTURING_DATA_ADT,
+        company_id=_ADAFRUIT_COMPANY_ID,
+        key_encoding="<H",
+    )
 
     sequence_number = ManufacturerDataField(0x0003, "<B")
     """Sequence number of the measurement. Used to detect missed packets."""
 
-    acceleration = ManufacturerDataField(0x0a00, "<fff", ("x", "y", "z"))
+    acceleration = ManufacturerDataField(0x0A00, "<fff", ("x", "y", "z"))
     """Acceleration as (x, y, z) tuple of floats in meters per second per second."""
 
-    magnetic = ManufacturerDataField(0x0a01, "<fff", ("x", "y", "z"))
+    magnetic = ManufacturerDataField(0x0A01, "<fff", ("x", "y", "z"))
     """Magnetism as (x, y, z) tuple of floats in micro-Tesla."""
 
-    orientation = ManufacturerDataField(0x0a02, "<fff", ("x", "y", "z"))
+    orientation = ManufacturerDataField(0x0A02, "<fff", ("x", "y", "z"))
     """Absolution orientation as (x, y, z) tuple of floats in degrees."""
 
-    gyro = ManufacturerDataField(0x0a03, "<fff", ("x", "y", "z"))
+    gyro = ManufacturerDataField(0x0A03, "<fff", ("x", "y", "z"))
     """Gyro motion as (x, y, z) tuple of floats in radians per second."""
 
-    temperature = ManufacturerDataField(0x0a04, "<f")
+    temperature = ManufacturerDataField(0x0A04, "<f")
     """Temperature as a float in degrees centigrade."""
 
-    eCO2 = ManufacturerDataField(0x0a05, "<f")
+    eCO2 = ManufacturerDataField(0x0A05, "<f")
     """Equivalent CO2 as a float in parts per million."""
 
-    TVOC = ManufacturerDataField(0x0a06, "<f")
+    TVOC = ManufacturerDataField(0x0A06, "<f")
     """Total Volatile Organic Compounds as a float in parts per billion."""
 
-    distance = ManufacturerDataField(0x0a07, "<f")
+    distance = ManufacturerDataField(0x0A07, "<f")
     """Distance as a float in centimeters."""
 
-    light = ManufacturerDataField(0x0a08, "<f")
+    light = ManufacturerDataField(0x0A08, "<f")
     """Brightness as a float without units."""
 
-    lux = ManufacturerDataField(0x0a09, "<f")
+    lux = ManufacturerDataField(0x0A09, "<f")
     """Brightness as a float in SI lux."""
 
-    pressure = ManufacturerDataField(0x0a0a, "<f")
+    pressure = ManufacturerDataField(0x0A0A, "<f")
     """Pressure as a float in hectopascals."""
 
-    relative_humidity = ManufacturerDataField(0x0a0b, "<f")
+    relative_humidity = ManufacturerDataField(0x0A0B, "<f")
     """Relative humidity as a float percentage."""
 
-    current = ManufacturerDataField(0x0a0c, "<f")
+    current = ManufacturerDataField(0x0A0C, "<f")
     """Current as a float in milliamps."""
 
-    voltage = ManufacturerDataField(0x0a0d, "<f")
+    voltage = ManufacturerDataField(0x0A0D, "<f")
     """Voltage as a float in Volts."""
 
-    color = ManufacturerDataField(0x0a0e, "<f")
+    color = ManufacturerDataField(0x0A0E, "<f")
     """Color as RGB integer."""
 
     # alarm = ManufacturerDataField(0x0a0f, "<f")
@@ -139,19 +145,19 @@ class AdafruitSensorMeasurement(Advertisement):
     # datetime = ManufacturerDataField(0x0a10, "<f")
     """Date and time as a struct. Not supported."""
 
-    duty_cycle = ManufacturerDataField(0x0a11, "<f")
+    duty_cycle = ManufacturerDataField(0x0A11, "<f")
     """16-bit PWM duty cycle. Independent of frequency."""
 
-    frequency = ManufacturerDataField(0x0a12, "<f")
+    frequency = ManufacturerDataField(0x0A12, "<f")
     """As integer Hertz"""
 
-    value = ManufacturerDataField(0x0a13, "<f")
+    value = ManufacturerDataField(0x0A13, "<f")
     """16-bit unit-less value. Used for analog values and for booleans."""
 
-    weight = ManufacturerDataField(0x0a14, "<f")
+    weight = ManufacturerDataField(0x0A14, "<f")
     """Weight as a float in grams."""
 
-    battery_voltage = ManufacturerDataField(0x0a15, "<H")
+    battery_voltage = ManufacturerDataField(0x0A15, "<H")
     """Battery voltage in millivolts. Saves two bytes over voltage and is more readable in bare
        packets."""
 
@@ -171,7 +177,7 @@ def __str__(self):
         return "<{} {} >".format(self.__class__.__name__, " ".join(parts))
 
     def split(self, max_packet_size=31):
-        current_size = 8 # baseline for mfg data and sequence number
+        current_size = 8  # baseline for mfg data and sequence number
         if current_size + len(self.manufacturer_data) < max_packet_size:
             yield self
             return

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_BroadcastNet Library'
-copyright = u'2020 Scott Shawcroft'
-author = u'Scott Shawcroft'
+project = "Adafruit BLE_BroadcastNet 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_broadcastnetLibrarydoc'
+htmlhelp_basename = "AdafruitBle_broadcastnetLibrarydoc"
 
 # -- 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_BroadcastNetLibrary.tex', u'AdafruitBLE_BroadcastNet Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBLE_BroadcastNetLibrary.tex",
+        "AdafruitBLE_BroadcastNet 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_BroadcastNetlibrary', u'Adafruit BLE_BroadcastNet Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBLE_BroadcastNetlibrary",
+        "Adafruit BLE_BroadcastNet 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_BroadcastNetLibrary', u'Adafruit BLE_BroadcastNet Library Documentation',
-     author, 'AdafruitBLE_BroadcastNetLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBLE_BroadcastNetLibrary",
+        "Adafruit BLE_BroadcastNet Library Documentation",
+        author,
+        "AdafruitBLE_BroadcastNetLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ble_broadcastnet_battery_level.py

@@ -12,7 +12,9 @@
 
 while True:
     measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement()
-    battery_voltage = battery.value / 2**16 * divider_ratio * battery.reference_voltage
+    battery_voltage = (
+        battery.value / 2 ** 16 * divider_ratio * battery.reference_voltage
+    )
     measurement.battery_voltage = int(battery_voltage * 1000)
     measurement.temperature = microcontroller.cpu.temperature
     print(measurement)