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

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,36 @@
 # autodoc_mock_imports = ["digitalio", "busio"]
 
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        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 NeoPixel_SPI Library'
-copyright = u'2019 Carter Nelson'
-author = u'Carter Nelson'
+project = u"Adafruit NeoPixel_SPI Library"
+copyright = u"2019 Carter Nelson"
+author = u"Carter Nelson"
 
 # 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.
@@ -57,7 +65,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 +77,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 +92,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 = 'AdafruitNeopixel_spiLibrarydoc'
+htmlhelp_basename = "AdafruitNeopixel_spiLibrarydoc"
 
 # -- 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, 'AdafruitNeoPixel_SPILibrary.tex', u'AdafruitNeoPixel_SPI Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitNeoPixel_SPILibrary.tex",
+        u"AdafruitNeoPixel_SPI 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, 'AdafruitNeoPixel_SPIlibrary', u'Adafruit NeoPixel_SPI Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitNeoPixel_SPIlibrary",
+        u"Adafruit NeoPixel_SPI Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +170,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitNeoPixel_SPILibrary', u'Adafruit NeoPixel_SPI Library Documentation',
-     author, 'AdafruitNeoPixel_SPILibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitNeoPixel_SPILibrary",
+        u"Adafruit NeoPixel_SPI Library Documentation",
+        author,
+        "AdafruitNeoPixel_SPILibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/neopixel_spi_simpletest.py

@@ -9,10 +9,9 @@
 
 spi = board.SPI()
 
-pixels = neopixel.NeoPixel_SPI(spi,
-                               NUM_PIXELS,
-                               pixel_order=PIXEL_ORDER,
-                               auto_write=False)
+pixels = neopixel.NeoPixel_SPI(
+    spi, NUM_PIXELS, pixel_order=PIXEL_ORDER, auto_write=False
+)
 
 while True:
     for color in COLORS:

neopixel_spi.py

@@ -43,22 +43,23 @@
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 """
 
-from adafruit_pypixelbuf import PixelBuf, fill
 from adafruit_bus_device.spi_device import SPIDevice
+from adafruit_pypixelbuf import PixelBuf, fill
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI.git"
 
 # Pixel color order constants
-RGB = 'RGB'
+RGB = "RGB"
 """Red Green Blue"""
-GRB = 'GRB'
+GRB = "GRB"
 """Green Red Blue"""
-RGBW = 'RGBW'
+RGBW = "RGBW"
 """Red Green Blue White"""
-GRBW = 'GRBW'
+GRBW = "GRBW"
 """Green Red Blue White"""
 
+
 class NeoPixel_SPI(PixelBuf):
     """
     A sequence of neopixels.
@@ -84,9 +85,11 @@ class NeoPixel_SPI(PixelBuf):
     """
 
     FREQ = 6400000  # 800kHz * 8, actual may be different
-    TRST = 80e-6    # Reset code low level time
+    TRST = 80e-6  # Reset code low level time
 
-    def __init__(self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None):
+    def __init__(
+        self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None
+    ):
 
         # configure bpp and pixel_order
         if not pixel_order:
@@ -103,15 +106,18 @@ def __init__(self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_orde
             except AttributeError:
                 # use nominal
                 freq = self.FREQ
-        self._reset = bytes([0]*round(freq * self.TRST / 8))
+        self._reset = bytes([0] * round(freq * self.TRST / 8))
         self.spibuf = bytearray(8 * n * bpp)
 
         # everything else taken care of by base class
-        super().__init__(n, bytearray(n * bpp),
-                         brightness=brightness,
-                         rawbuf=bytearray(n * bpp),
-                         byteorder=pixel_order,
-                         auto_write=auto_write)
+        super().__init__(
+            n,
+            bytearray(n * bpp),
+            brightness=brightness,
+            rawbuf=bytearray(n * bpp),
+            byteorder=pixel_order,
+            auto_write=auto_write,
+        )
 
     def deinit(self):
         """Blank out the NeoPixels."""
@@ -122,7 +128,7 @@ def show(self):
         """Shows the new colors on the pixels themselves if they haven't already
         been autowritten."""
         self._transmogrify()
-        #pylint: disable=no-member
+        # pylint: disable=no-member
         with self._spi as spi:
             # write out special byte sequence surrounded by RESET
             # leading RESET needed for cases where MOSI rests HI
@@ -136,9 +142,9 @@ def _transmogrify(self):
             # MSB first
             for i in range(7, -1, -1):
                 if byte >> i & 0x01:
-                    self.spibuf[k] = 0b11110000 # A NeoPixel 1 bit
+                    self.spibuf[k] = 0b11110000  # A NeoPixel 1 bit
                 else:
-                    self.spibuf[k] = 0b11000000 # A NeoPixel 0 bit
+                    self.spibuf[k] = 0b11000000  # A NeoPixel 0 bit
                 k += 1
 
     def fill(self, color):