Merge pull request #78 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

.pylintrc

@@ -119,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]

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.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 autodoc_mock_imports = ["neopixel_write"]
 
-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 CircuitPython NeoPixel Library'
-copyright = u'2017 Scott Shawcroft & Damien P. George'
-author = u'Scott Shawcroft & Damien P. George'
+project = u"Adafruit CircuitPython NeoPixel Library"
+copyright = u"2017 Scott Shawcroft & Damien P. George"
+author = u"Scott Shawcroft & Damien P. George"
 
 # 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.
@@ -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
@@ -76,68 +80,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 = 'AdafruitNEOPIXEL2Librarydoc'
+htmlhelp_basename = "AdafruitNEOPIXEL2Librarydoc"
 
 # -- 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, 'AdafruitNeoPixelLibrary.tex', u'Adafruit NeoPixel Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitNeoPixelLibrary.tex",
+        u"Adafruit NeoPixel 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, 'adafruitneoPixellibrary', u'Adafruit NeoPixel Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "adafruitneoPixellibrary",
+        u"Adafruit NeoPixel Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -146,7 +158,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitNeoPixelLibrary', u'Adafruit NeoPixel Library Documentation',
-     author, 'AdafruitNeoPixelLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitNeoPixelLibrary",
+        u"Adafruit NeoPixel Library Documentation",
+        author,
+        "AdafruitNeoPixelLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/neopixel_pixel.py

@@ -7,11 +7,11 @@
 import neopixel
 
 # Configure the setup
-PIXEL_PIN = board.D1   # pin that the NeoPixel is connected to
-ORDER = neopixel.RGB   # pixel color channel order
-COLOR = (100, 50, 150) # color to blink
-CLEAR = (0, 0, 0)      # clear (or second color)
-DELAY = 0.25           # blink rate in seconds
+PIXEL_PIN = board.D1  # pin that the NeoPixel is connected to
+ORDER = neopixel.RGB  # pixel color channel order
+COLOR = (100, 50, 150)  # color to blink
+CLEAR = (0, 0, 0)  # clear (or second color)
+DELAY = 0.25  # blink rate in seconds
 
 # Create the NeoPixel object
 pixel = neopixel.NeoPixel(PIXEL_PIN, 1, pixel_order=ORDER)

examples/neopixel_rpi_simpletest.py

@@ -15,8 +15,9 @@
 # For RGBW NeoPixels, simply change the ORDER to RGBW or GRBW.
 ORDER = neopixel.GRB
 
-pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.2, auto_write=False,
-                           pixel_order=ORDER)
+pixels = neopixel.NeoPixel(
+    pixel_pin, num_pixels, brightness=0.2, auto_write=False, pixel_order=ORDER
+)
 
 
 def wheel(pos):
@@ -26,19 +27,19 @@ def wheel(pos):
         r = g = b = 0
     elif pos < 85:
         r = int(pos * 3)
-        g = int(255 - pos*3)
+        g = int(255 - pos * 3)
         b = 0
     elif pos < 170:
         pos -= 85
-        r = int(255 - pos*3)
+        r = int(255 - pos * 3)
         g = 0
-        b = int(pos*3)
+        b = int(pos * 3)
     else:
         pos -= 170
         r = 0
-        g = int(pos*3)
-        b = int(255 - pos*3)
-    return (r, g, b) if ORDER == neopixel.RGB or ORDER == neopixel.GRB else (r, g, b, 0)
+        g = int(pos * 3)
+        b = int(255 - pos * 3)
+    return (r, g, b) if ORDER in (neopixel.RGB, neopixel.GRB) else (r, g, b, 0)
 
 
 def rainbow_cycle(wait):
@@ -72,4 +73,4 @@ def rainbow_cycle(wait):
     pixels.show()
     time.sleep(1)
 
-    rainbow_cycle(0.001)    # rainbow cycle with 1ms delay per step
+    rainbow_cycle(0.001)  # rainbow cycle with 1ms delay per step

examples/neopixel_simpletest.py

@@ -8,7 +8,7 @@
 pixel_pin = board.NEOPIXEL
 
 # On a Raspberry pi, use this instead, not all pins are supported
-#pixel_pin = board.D18
+# pixel_pin = board.D18
 
 # The number of NeoPixels
 num_pixels = 10
@@ -17,8 +17,9 @@
 # For RGBW NeoPixels, simply change the ORDER to RGBW or GRBW.
 ORDER = neopixel.GRB
 
-pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.2, auto_write=False,
-                           pixel_order=ORDER)
+pixels = neopixel.NeoPixel(
+    pixel_pin, num_pixels, brightness=0.2, auto_write=False, pixel_order=ORDER
+)
 
 
 def wheel(pos):
@@ -28,19 +29,19 @@ def wheel(pos):
         r = g = b = 0
     elif pos < 85:
         r = int(pos * 3)
-        g = int(255 - pos*3)
+        g = int(255 - pos * 3)
         b = 0
     elif pos < 170:
         pos -= 85
-        r = int(255 - pos*3)
+        r = int(255 - pos * 3)
         g = 0
-        b = int(pos*3)
+        b = int(pos * 3)
     else:
         pos -= 170
         r = 0
-        g = int(pos*3)
-        b = int(255 - pos*3)
-    return (r, g, b) if ORDER == neopixel.RGB or ORDER == neopixel.GRB else (r, g, b, 0)
+        g = int(pos * 3)
+        b = int(255 - pos * 3)
+    return (r, g, b) if ORDER in (neopixel.RGB, neopixel.GRB) else (r, g, b, 0)
 
 
 def rainbow_cycle(wait):
@@ -74,4 +75,4 @@ def rainbow_cycle(wait):
     pixels.show()
     time.sleep(1)
 
-    rainbow_cycle(0.001)    # rainbow cycle with 1ms delay per step
+    rainbow_cycle(0.001)  # rainbow cycle with 1ms delay per step