Merge pull request #7 from adafruit/pylint-update

Pylint update

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 pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

adafruit_lifx.py

@@ -43,50 +43,52 @@
 __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.
         :param wifi_manager wifi_manager: WiFiManager from ESPSPI_WiFiManager/ESPAT_WiFiManager
         :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):
         """Parses and returns the JSON response returned
         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):
         """POST data to the LIFX API.
         :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,50 +116,45 @@ 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.
         :param str move_direction: Move direction, forward or backward.
         :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

docs/conf.py

@@ -2,44 +2,48 @@
 
 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",
 ]
 
 
-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,68 +82,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 = '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 ---------------------------------------
 
 # 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",
+    ),
 ]