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

adafruit_pypixelbuf.py

@@ -35,7 +35,7 @@
 DOTSTAR_LED_BRIGHTNESS = 0b00011111
 
 
-class PixelBuf(object):  # pylint: disable=too-many-instance-attributes
+class PixelBuf:  # pylint: disable=too-many-instance-attributes
     """
     A sequence of RGB/RGBW pixels.
 
@@ -49,8 +49,17 @@ class PixelBuf(object):  # pylint: disable=too-many-instance-attributes
     :param ~int offset: Offset from start of buffer (default 0)
     :param ~bool auto_write: Whether to automatically write pixels (Default False)
     """
-    def __init__(self, n, buf, byteorder="BGR", brightness=1.0,  # pylint: disable=too-many-locals,too-many-arguments
-                 rawbuf=None, offset=0, auto_write=False):
+
+    def __init__(  # pylint: disable=too-many-locals,too-many-arguments
+        self,
+        n,
+        buf,
+        byteorder="BGR",
+        brightness=1.0,
+        rawbuf=None,
+        offset=0,
+        auto_write=False,
+    ):
 
         bpp, byteorder_tuple, has_white, dotstar_mode = self.parse_byteorder(byteorder)
         if not isinstance(buf, bytearray):
@@ -67,7 +76,7 @@ def __init__(self, n, buf, byteorder="BGR", brightness=1.0,  # pylint: disable=t
         if (len(buf) + offset) < _bytes:
             raise TypeError("buf is too small")
         if two_buffers and (len(rawbuf) + offset) < _bytes:
-            raise TypeError("buf is too small. need %d bytes" % (_bytes, ))
+            raise TypeError("buf is too small. need %d bytes" % (_bytes,))
 
         self._pixels = n
         self._bytes = _bytes
@@ -85,8 +94,12 @@ def __init__(self, n, buf, byteorder="BGR", brightness=1.0,  # pylint: disable=t
         self.auto_write = auto_write
 
         if dotstar_mode:
-            self._byteorder_tuple = (byteorder_tuple[0] + 1, byteorder_tuple[1] + 1,
-                                     byteorder_tuple[2] + 1, 0)
+            self._byteorder_tuple = (
+                byteorder_tuple[0] + 1,
+                byteorder_tuple[1] + 1,
+                byteorder_tuple[2] + 1,
+                0,
+            )
 
         self._brightness = min(1.0, max(0, brightness))
 
@@ -128,10 +141,10 @@ def parse_byteorder(byteorder):
             b = byteorder.index("B")
         except ValueError:
             raise ValueError("Invalid Byteorder string")
-        if 'W' in byteorder:
+        if "W" in byteorder:
             w = byteorder.index("W")
             byteorder = (r, g, b, w)
-        elif 'P' in byteorder:
+        elif "P" in byteorder:
             lum = byteorder.index("P")
             byteorder = (r, g, b, lum)
             dotstar_mode = True
@@ -192,7 +205,9 @@ def show(self):
         """
         raise NotImplementedError("Must be subclassed")
 
-    def _set_item(self, index, value):  # pylint: disable=too-many-locals,too-many-branches
+    def _set_item(
+        self, index, value
+    ):  # pylint: disable=too-many-locals,too-many-branches
         if index < 0:
             index += len(self)
         if index >= self._pixels or index < 0:
@@ -205,8 +220,8 @@ def _set_item(self, index, value):  # pylint: disable=too-many-locals,too-many-b
         has_w = False
         if isinstance(value, int):
             r = value >> 16
-            g = (value >> 8) & 0xff
-            b = value & 0xff
+            g = (value >> 8) & 0xFF
+            b = value & 0xFF
             w = 0
             # If all components are the same and we have a white pixel then use it
             # instead of the individual components.
@@ -243,12 +258,14 @@ def _set_item(self, index, value):  # pylint: disable=too-many-locals,too-many-b
                 # same as math.ceil(brightness * 31) & 0b00011111
                 # Idea from https://www.codeproject.com/Tips/700780/Fast-floor-ceiling-functions
                 self._bytearray[offset + self._byteorder[3]] = (
-                    32 - int(32 - w * 31) & 0b00011111) | DOTSTAR_LED_START
+                    32 - int(32 - w * 31) & 0b00011111
+                ) | DOTSTAR_LED_START
             else:
                 self._bytearray[offset + self._byteorder[3]] = int(w * self._brightness)
             if self._two_buffers:
                 self._rawbytearray[offset + self._byteorder[3]] = self._bytearray[
-                    offset + self._byteorder[3]]
+                    offset + self._byteorder[3]
+                ]
         elif self._dotstar_mode:
             self._bytearray[offset + self._byteorder[3]] = DOTSTAR_LED_START_FULL_BRIGHT
 
@@ -273,8 +290,10 @@ def _getitem(self, index):
         if self._has_white:
             value.append(self._bytearray[start + self._byteorder[2]])
         elif self._dotstar_mode:
-            value.append((self._bytearray[start + self._byteorder[3]] & DOTSTAR_LED_BRIGHTNESS) /
-                         31.0)
+            value.append(
+                (self._bytearray[start + self._byteorder[3]] & DOTSTAR_LED_BRIGHTNESS)
+                / 31.0
+            )
         return value
 
     def __getitem__(self, index):

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,32 @@
 # autodoc_mock_imports = ["digitalio", "busio"]
 
 
-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 PyPixelBuf Library'
-copyright = u'2020 Roy Hooper'
-author = u'Roy Hooper'
+project = u"Adafruit PyPixelBuf Library"
+copyright = u"2020 Roy Hooper"
+author = u"Roy Hooper"
 
 # 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 +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,68 +88,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 = 'AdafruitPypixelbufLibrarydoc'
+htmlhelp_basename = "AdafruitPypixelbufLibrarydoc"
 
 # -- 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, 'AdafruitPyPixelBufLibrary.tex', u'AdafruitPyPixelBuf Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitPyPixelBufLibrary.tex",
+        u"AdafruitPyPixelBuf 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, 'AdafruitPyPixelBuflibrary', u'Adafruit PyPixelBuf Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitPyPixelBuflibrary",
+        u"Adafruit PyPixelBuf 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, 'AdafruitPyPixelBufLibrary', u'Adafruit PyPixelBuf Library Documentation',
-     author, 'AdafruitPyPixelBufLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitPyPixelBufLibrary",
+        u"Adafruit PyPixelBuf Library Documentation",
+        author,
+        "AdafruitPyPixelBufLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]