From 9941f1607b5dff7dfd7e3ab79bba0665b3498a10 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 9 Mar 2020 20:34:15 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- adafruit_ble_magic_light.py | 17 ++-- docs/conf.py | 112 ++++++++++++++----------- examples/ble_magic_light_simpletest.py | 6 +- setup.py | 53 +++++------- 4 files changed, 101 insertions(+), 87 deletions(-) diff --git a/adafruit_ble_magic_light.py b/adafruit_ble_magic_light.py index 1382238..02ff397 100644 --- a/adafruit_ble_magic_light.py +++ b/adafruit_ble_magic_light.py @@ -35,20 +35,23 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light.git" + class MagicLightService(Service): """Service for controlling a Magic Light RGB bulb.""" # These UUIDs actually use the standard base UUID even though they aren't standard. uuid = VendorUUID("0000ffe5-0000-1000-8000-00805f9b34fb") - _control = Characteristic(uuid=VendorUUID("0000ffe9-0000-1000-8000-00805f9b34fb"), max_length=7) + _control = Characteristic( + uuid=VendorUUID("0000ffe9-0000-1000-8000-00805f9b34fb"), max_length=7 + ) def __init__(self, service=None): super().__init__(service=service) - self._color = 0xffffff + self._color = 0xFFFFFF self._buf = bytearray(7) self._buf[0] = 0x56 - self._buf[6] = 0xaa + self._buf[6] = 0xAA self._brightness = 1.0 def __getitem__(self, index): @@ -60,16 +63,16 @@ def __setitem__(self, index, value): if index > 0: raise IndexError() if isinstance(value, int): - r = (value >> 16) & 0xff - g = (value >> 8) & 0xff - b = value & 0xff + r = (value >> 16) & 0xFF + g = (value >> 8) & 0xFF + b = value & 0xFF else: r, g, b = value self._buf[1] = r self._buf[2] = g self._buf[3] = b self._buf[4] = 0x00 - self._buf[5] = 0xf0 + self._buf[5] = 0xF0 self._control = self._buf self._color = value diff --git a/docs/conf.py b/docs/conf.py index dabece1..dd8d10e 100644 --- a/docs/conf.py +++ b/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,10 +11,10 @@ # 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 = ["adafruit_ble"] -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_Magic_Light Library' -copyright = u'2019 Scott Shawcroft' -author = u'Scott Shawcroft' +project = "Adafruit BLE_Magic_Light 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 @@ # 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,59 +88,62 @@ # 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_magic_lightLibrarydoc' +htmlhelp_basename = "AdafruitBle_magic_lightLibrarydoc" # -- 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_Magic_LightLibrary.tex', u'AdafruitBLE_Magic_Light Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitBLE_Magic_LightLibrary.tex", + "AdafruitBLE_Magic_Light Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitBLE_Magic_Lightlibrary', u'Adafruit BLE_Magic_Light Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitBLE_Magic_Lightlibrary", + "Adafruit BLE_Magic_Light 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_Magic_LightLibrary', u'Adafruit BLE_Magic_Light Library Documentation', - author, 'AdafruitBLE_Magic_LightLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitBLE_Magic_LightLibrary", + "Adafruit BLE_Magic_Light Library Documentation", + author, + "AdafruitBLE_Magic_LightLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/ble_magic_light_simpletest.py b/examples/ble_magic_light_simpletest.py index 67969b7..868f4f7 100644 --- a/examples/ble_magic_light_simpletest.py +++ b/examples/ble_magic_light_simpletest.py @@ -5,6 +5,7 @@ from adafruit_ble.advertising.standard import ProvideServicesAdvertisement from adafruit_ble_magic_light import MagicLightService + def find_connection(): for connection in radio.connections: if MagicLightService not in connection: @@ -12,9 +13,11 @@ def find_connection(): return connection, connection[MagicLightService] return None, None + # Start advertising before messing with the display so that we can connect immediately. radio = adafruit_ble.BLERadio() + def wheel(pos): # Input a value 0 to 255 to get a color value. # The colours are a transition r - g - b - back to r. @@ -28,6 +31,7 @@ def wheel(pos): pos -= 170 return (pos * 3, 0, 255 - pos * 3) + active_connection, pixels = find_connection() current_notification = None app_icon_file = None @@ -39,7 +43,7 @@ def wheel(pos): active_connection = radio.connect(scan) try: pixels = active_connection[MagicLightService] - except _bleio.ConnectionError: + except _bleio.ConnectionError: # pylint: disable=no-member print("disconnected") continue break diff --git a/setup.py b/setup.py index 7a8f705..de04c42 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,52 +14,40 @@ 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-magic-light', - + name="adafruit-circuitpython-ble-magic-light", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='BLE service for Magic Light BLE RGB bulbs', + setup_requires=["setuptools_scm"], + description="BLE service for Magic Light BLE RGB bulbs", 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_Magic_Light', - + url="https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light", # 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_magic_light ble rgb', - + keywords="adafruit blinka circuitpython micropython ble_magic_light ble rgb", # 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_magic_light'], + py_modules=["adafruit_ble_magic_light"], )