From bf7b4b650d7986fe86f41e7250e25d2d59c37405 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 9 Mar 2020 17:35:11 -0400 Subject: [PATCH 1/2] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 6 +- .pylintrc | 2 +- adafruit_lifx.py | 65 +++++++++------------ docs/conf.py | 112 +++++++++++++++++++++--------------- examples/lifx_simpletest.py | 14 ++--- setup.py | 53 +++++++---------- 6 files changed, 126 insertions(+), 126 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 11ce574..fff3aa9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,9 +34,13 @@ jobs: with: repository: adafruit/actions-ci-circuitpython-libs path: actions-ci - - name: Install deps + - name: Install dependencies + # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | 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 - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/.pylintrc b/.pylintrc index 039eaec..d8f0ee8 100644 --- a/.pylintrc +++ b/.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 diff --git a/adafruit_lifx.py b/adafruit_lifx.py index 212c0cb..8593132 100644 --- a/adafruit_lifx.py +++ b/adafruit_lifx.py @@ -43,12 +43,14 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_lifx.git" -LIFX_URL = 'https://api.lifx.com/v1/lights/' +LIFX_URL = "https://api.lifx.com/v1/lights/" + class LIFX: """ HTTP Interface for interacting with the LIFX API """ + def __init__(self, wifi_manager, lifx_token): """ Creates an instance of the LIFX HTTP API client. @@ -56,12 +58,14 @@ def __init__(self, wifi_manager, lifx_token): :param str lifx_token: LIFX API token (https://api.developer.lifx.com/docs/authentication) """ wifi_type = str(type(wifi_manager)) - if ('ESPSPI_WiFiManager' in wifi_type or 'ESPAT_WiFiManager' in wifi_type): + if "ESPSPI_WiFiManager" in wifi_type or "ESPAT_WiFiManager" in wifi_type: self._wifi = wifi_manager else: raise TypeError("This library requires a WiFiManager object.") self._lifx_token = lifx_token - self._auth_header = {"Authorization": "Bearer %s" % self._lifx_token,} + self._auth_header = { + "Authorization": "Bearer %s" % self._lifx_token, + } @staticmethod def _parse_resp(response): @@ -69,12 +73,14 @@ def _parse_resp(response): from the LIFX HTTP API. """ if response.status_code == 422: - raise Exception('Error: light(s) could not be toggled: '+ response['error']) + raise Exception( + "Error: light(s) could not be toggled: " + response["error"] + ) try: - for res in response.json()['results']: - return res['status'] + for res in response.json()["results"]: + return res["status"] except KeyError: - raise KeyError(response.json()['error']) + raise KeyError(response.json()["error"]) # HTTP Requests def _post(self, path, data): @@ -82,11 +88,7 @@ def _post(self, path, data): :param str path: Formatted LIFX API URL :param json data: JSON data to POST to the LIFX API. """ - response = self._wifi.post( - path, - json=data, - headers=self._auth_header - ) + response = self._wifi.post(path, json=data, headers=self._auth_header) response = self._parse_resp(response) return response @@ -95,11 +97,7 @@ def _put(self, path, data): :param str path: Formatted LIFX API URL :param json data: JSON data to PUT to the LIFX API. """ - response = self._wifi.put( - path, - json=data, - headers=self._auth_header - ) + response = self._wifi.put(path, json=data, headers=self._auth_header) response = self._parse_resp(response) return response @@ -108,11 +106,7 @@ def _get(self, path, data): :param str path: Formatted LIFX API URL :param json data: JSON data to GET from the LIFX API. """ - response = self._wifi.get( - path, - json=data, - headers=self._auth_header - ) + response = self._wifi.get(path, json=data, headers=self._auth_header) return response.json() def toggle_light(self, selector, all_lights=False, duration=0): @@ -122,9 +116,9 @@ def toggle_light(self, selector, all_lights=False, duration=0): :param double duration: Time (in seconds) to spend performing a toggle. Defaults to 0. """ if all_lights: - selector = 'all' - data = {'duration':duration} - return self._post(LIFX_URL+selector+'/toggle', data) + selector = "all" + data = {"duration": duration} + return self._post(LIFX_URL + selector + "/toggle", data) def move_effect(self, selector, move_direction, period, power_on): """Performs a linear move effect on a light, or lights. @@ -132,40 +126,35 @@ def move_effect(self, selector, move_direction, period, power_on): :param double period: Time in second per effect cycle. :param bool power_on: Turn on a light before performing the move. """ - data = {'direction':move_direction, - 'period':period, - 'power_on':power_on} - return self._post(LIFX_URL+selector+'/effects/move', data) + data = {"direction": move_direction, "period": period, "power_on": power_on} + return self._post(LIFX_URL + selector + "/effects/move", data) def effects_off(self, selector, power_off=False): """Turns off any running effects on the selected device. :param dict selector: Selector to control which lights are requested. :param bool power_off: If true, the devices will also be turned off. """ - data = {'power_off', power_off} - return self._post(LIFX_URL+selector+'/effects/off', data) + data = {"power_off", power_off} + return self._post(LIFX_URL + selector + "/effects/off", data) def set_brightness(self, selector, brightness): """Sets the state of the lights within the selector. :param dict selector: Selector to control which lights are requested. :param double brightness: Brightness level of the light, from 0.0 to 1.0. """ - data = {'brightness':brightness} - return self._put(LIFX_URL+selector+'/state', data) + data = {"brightness": brightness} + return self._put(LIFX_URL + selector + "/state", data) def set_color(self, selector, **kwargs): """Sets the state of the light's color within the selector. Valid arguments: https://api.developer.lifx.com/docs/set-state """ - return self._put(LIFX_URL+selector+'/state', kwargs) + return self._put(LIFX_URL + selector + "/state", kwargs) def list_lights(self): """Enumerates all the lights associated with the LIFX Cloud Account """ - response = self._wifi.get( - url=LIFX_URL+'all', - headers=self._auth_header - ) + response = self._wifi.get(url=LIFX_URL + "all", headers=self._auth_header) resp = response.json() response.close() return resp diff --git a/docs/conf.py b/docs/conf.py index 3b5ab76..c664c16 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,36 +11,39 @@ # 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", ] -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 LIFX Library' -copyright = u'2019 Brent Rubell' -author = u'Brent Rubell' +project = "Adafruit LIFX Library" +copyright = "2019 Brent Rubell" +author = "Brent Rubell" # 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. @@ -51,7 +55,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. @@ -63,7 +67,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 @@ -78,59 +82,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 = 'AdafruitLifxLibrarydoc' +htmlhelp_basename = "AdafruitLifxLibrarydoc" # -- 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, 'AdafruitlifxLibrary.tex', u'Adafruitlifx Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitlifxLibrary.tex", + "Adafruitlifx Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -138,8 +145,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Adafruitlifxlibrary', u'Adafruit lifx Library Documentation', - [author], 1) + ( + master_doc, + "Adafruitlifxlibrary", + "Adafruit lifx Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -148,7 +160,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitlifxLibrary', u'Adafruit lifx Library Documentation', - author, 'AdafruitlifxLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitlifxLibrary", + "Adafruit lifx Library Documentation", + author, + "AdafruitlifxLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/lifx_simpletest.py b/examples/lifx_simpletest.py index 6ef30c8..1e9d2bc 100644 --- a/examples/lifx_simpletest.py +++ b/examples/lifx_simpletest.py @@ -25,11 +25,11 @@ # Add your LIFX Personal Access token to secrets.py # (to obtain a token, visit: https://cloud.lifx.com/settings) -lifx_token = secrets['lifx_token'] +lifx_token = secrets["lifx_token"] # Set this to your LIFX light separator label # https://api.developer.lifx.com/docs/selectors -lifx_light = 'label:Lamp' +lifx_light = "label:Lamp" # Initialize the LIFX API Client lifx = adafruit_lifx.LIFX(wifi, lifx_token) @@ -38,7 +38,7 @@ lights = lifx.list_lights() # Turn on the light -print('Turning on light...') +print("Turning on light...") lifx.toggle_light(lifx_light) # Set the light's brightness to 50% @@ -46,11 +46,11 @@ lifx.set_brightness(lifx_light, light_brightness) # Cycle the light using the colors of the Python logo -colors = ['yellow', 'blue', 'white'] +colors = ["yellow", "blue", "white"] for color in colors: - print('Setting light to: ', color) - lifx.set_color(lifx_light, power='on', color=color, brightness=light_brightness) + print("Setting light to: ", color) + lifx.set_color(lifx_light, power="on", color=color, brightness=light_brightness) # Turn off the light -print('Turning off light...') +print("Turning off light...") lifx.toggle_light(lifx_light) diff --git a/setup.py b/setup.py index 88de5c7..1a01334 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-lifx', - + name="adafruit-circuitpython-lifx", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='LIFX Smart Lighting API Helper', + setup_requires=["setuptools_scm"], + description="LIFX Smart Lighting API Helper", 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_lifx', - + url="https://github.com/adafruit/Adafruit_CircuitPython_lifx", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=[ - 'Adafruit-Blinka', - 'Adafruit_CircuitPython_ESP32SPI' - ], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka", "Adafruit_CircuitPython_ESP32SPI"], # 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 lifx', - + keywords="adafruit blinka circuitpython micropython lifx", # 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_lifx'], + py_modules=["adafruit_lifx"], ) From 3bd6eb06c7c95d204bbabaecb264f5822fd4514c Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 9 Mar 2020 18:55:01 -0400 Subject: [PATCH 2/2] Set pylint to latest version --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 100644 --- a/.github/workflows/build.yml +++ b/.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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint