Merge pull request #18 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_button.py

@@ -52,7 +52,7 @@ def _check_color(color):
     # if a tuple is supplied, convert it to a RGB number
     if isinstance(color, tuple):
         r, g, b = color
-        return int((r << 16) + (g << 8) + (b & 0xff))
+        return int((r << 16) + (g << 8) + (b & 0xFF))
     return color
 
 
@@ -82,11 +82,24 @@ class Button(displayio.Group):
     SHADOWRECT = const(2)
     SHADOWROUNDRECT = const(3)
 
-    def __init__(self, *, x, y, width, height, name=None, style=RECT,
-                 fill_color=0xFFFFFF, outline_color=0x0,
-                 label=None, label_font=None, label_color=0x0,
-                 selected_fill=None, selected_outline=None,
-                 selected_label=None):
+    def __init__(
+        self,
+        *,
+        x,
+        y,
+        width,
+        height,
+        name=None,
+        style=RECT,
+        fill_color=0xFFFFFF,
+        outline_color=0x0,
+        label=None,
+        label_font=None,
+        label_color=0x0,
+        selected_fill=None,
+        selected_outline=None,
+        selected_label=None
+    ):
         super().__init__()
         self.x = x
         self.y = y
@@ -115,21 +128,49 @@ def __init__(self, *, x, y, width, height, name=None, style=RECT,
 
         if (outline_color is not None) or (fill_color is not None):
             if style == Button.RECT:
-                self.body = Rect(x, y, width, height,
-                                 fill=self.fill_color, outline=self.outline_color)
+                self.body = Rect(
+                    x,
+                    y,
+                    width,
+                    height,
+                    fill=self.fill_color,
+                    outline=self.outline_color,
+                )
             elif style == Button.ROUNDRECT:
-                self.body = RoundRect(x, y, width, height, r=10,
-                                      fill=self.fill_color, outline=self.outline_color)
+                self.body = RoundRect(
+                    x,
+                    y,
+                    width,
+                    height,
+                    r=10,
+                    fill=self.fill_color,
+                    outline=self.outline_color,
+                )
             elif style == Button.SHADOWRECT:
-                self.shadow = Rect(x + 2, y + 2, width - 2, height - 2,
-                                   fill=outline_color)
-                self.body = Rect(x, y, width - 2, height - 2,
-                                 fill=self.fill_color, outline=self.outline_color)
+                self.shadow = Rect(
+                    x + 2, y + 2, width - 2, height - 2, fill=outline_color
+                )
+                self.body = Rect(
+                    x,
+                    y,
+                    width - 2,
+                    height - 2,
+                    fill=self.fill_color,
+                    outline=self.outline_color,
+                )
             elif style == Button.SHADOWROUNDRECT:
-                self.shadow = RoundRect(x + 2, y + 2, width - 2, height - 2, r=10,
-                                        fill=self.outline_color)
-                self.body = RoundRect(x, y, width - 2, height - 2, r=10,
-                                      fill=self.fill_color, outline=self.outline_color)
+                self.shadow = RoundRect(
+                    x + 2, y + 2, width - 2, height - 2, r=10, fill=self.outline_color
+                )
+                self.body = RoundRect(
+                    x,
+                    y,
+                    width - 2,
+                    height - 2,
+                    r=10,
+                    fill=self.fill_color,
+                    outline=self.outline_color,
+                )
             if self.shadow:
                 self.group.append(self.shadow)
             self.group.append(self.body)
@@ -148,7 +189,7 @@ def label(self, newtext):
 
         self._label = None
         if not newtext or (self._label_color is None):  # no new text
-            return     # nothing to do!
+            return  # nothing to do!
 
         if not self._label_font:
             raise RuntimeError("Please provide label font")
@@ -164,7 +205,6 @@ def label(self, newtext):
         if (self.selected_label is None) and (self._label_color is not None):
             self.selected_label = (~self._label_color) & 0xFFFFFF
 
-
     @property
     def selected(self):
         """Selected inverts the colors."""
@@ -173,7 +213,7 @@ def selected(self):
     @selected.setter
     def selected(self, value):
         if value == self._selected:
-            return   # bail now, nothing more to do
+            return  # bail now, nothing more to do
         self._selected = value
         if self._selected:
             new_fill = self.selected_fill
@@ -195,5 +235,6 @@ def contains(self, point):
         ``button.contains(touch)`` where ``touch`` is the touch point on the screen will allow for
         determining that a button has been touched.
         """
-        return (self.x <= point[0] <= self.x + self.width) and (self.y <= point[1] <=
-                                                                self.y + self.height)
+        return (self.x <= point[0] <= self.x + self.width) and (
+            self.y <= point[1] <= self.y + self.height
+        )

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 = ["displayio", "adafruit_display_text", "adafruit_display_shapes"]
 
 
-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 Display_Button Library'
-copyright = u'2019 Limor Fried'
-author = u'Limor Fried'
+project = u"Adafruit Display_Button Library"
+copyright = u"2019 Limor Fried"
+author = u"Limor Fried"
 
 # 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 = 'AdafruitDisplay_buttonLibrarydoc'
+htmlhelp_basename = "AdafruitDisplay_buttonLibrarydoc"
 
 # -- 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, 'AdafruitDisplay_ButtonLibrary.tex', u'AdafruitDisplay_Button Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitDisplay_ButtonLibrary.tex",
+        u"AdafruitDisplay_Button 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, 'AdafruitDisplay_Buttonlibrary', u'Adafruit Display_Button Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitDisplay_Buttonlibrary",
+        u"Adafruit Display_Button 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, 'AdafruitDisplay_ButtonLibrary', u'Adafruit Display_Button Library Documentation',
-     author, 'AdafruitDisplay_ButtonLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitDisplay_ButtonLibrary",
+        u"Adafruit Display_Button Library Documentation",
+        author,
+        "AdafruitDisplay_ButtonLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]