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_gizmo/eink_gizmo.py

@@ -44,20 +44,24 @@ class EInk_Gizmo(IL0373):
     def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None):
         displayio.release_displays()
         if spi is None:
-            import busio
+            import busio  # pylint: disable=import-outside-toplevel
+
             spi = busio.SPI(board.SCL, MOSI=board.SDA)
         if cs is None:
             cs = board.RX
         if dc is None:
             dc = board.TX
         if reset is None:
             reset = board.A3
-        self._display_bus = displayio.FourWire(spi,
-                                               command=dc,
-                                               chip_select=cs,
-                                               reset=reset,
-                                               baudrate=1000000)
+        self._display_bus = displayio.FourWire(
+            spi, command=dc, chip_select=cs, reset=reset, baudrate=1000000
+        )
         sleep(1)
-        super().__init__(self._display_bus, width=152, height=152,
-                         busy_pin=busy, rotation=180,
-                         highlight_color=0xff0000)
+        super().__init__(
+            self._display_bus,
+            width=152,
+            height=152,
+            busy_pin=busy,
+            rotation=180,
+            highlight_color=0xFF0000,
+        )

adafruit_gizmo/tft_gizmo.py

@@ -40,15 +40,20 @@
 class TFT_Gizmo(ST7789):
     """Class representing a TFT Gizmo."""
 
-    def __init__(self, *, spi=None, cs=board.RX, dc=board.TX,
-                 backlight=board.A3, rotation=180):
+    def __init__(
+        self, *, spi=None, cs=board.RX, dc=board.TX, backlight=board.A3, rotation=180
+    ):
         displayio.release_displays()
         if spi is None:
-            import busio
+            import busio  # pylint: disable=import-outside-toplevel
+
             spi = busio.SPI(board.SCL, MOSI=board.SDA)
-        self._display_bus = displayio.FourWire(spi,
-                                               command=dc,
-                                               chip_select=cs)
-        super().__init__(self._display_bus, width=240, height=240,
-                         rowstart=80, backlight_pin=backlight,
-                         rotation=rotation)
+        self._display_bus = displayio.FourWire(spi, command=dc, chip_select=cs)
+        super().__init__(
+            self._display_bus,
+            width=240,
+            height=240,
+            rowstart=80,
+            backlight_pin=backlight,
+            rotation=rotation,
+        )

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 = ["adafruit_st7789", "digitalio", "busio", "displayio", "board"]
 
 
-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 Gizmo Library'
-copyright = u'2019 Carter Nelson'
-author = u'Carter Nelson'
+project = u"Adafruit Gizmo 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 = 'AdafruitGizmoLibrarydoc'
+htmlhelp_basename = "AdafruitGizmoLibrarydoc"
 
 # -- 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, 'AdafruitGizmoLibrary.tex', u'AdafruitGizmo Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitGizmoLibrary.tex",
+        u"AdafruitGizmo 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, 'AdafruitGizmolibrary', u'Adafruit Gizmo Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitGizmolibrary",
+        u"Adafruit Gizmo 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, 'AdafruitGizmoLibrary', u'Adafruit Gizmo Library Documentation',
-     author, 'AdafruitGizmoLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitGizmoLibrary",
+        u"Adafruit Gizmo Library Documentation",
+        author,
+        "AdafruitGizmoLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/gizmo_simpletest.py

@@ -15,7 +15,7 @@
 # Create a two color palette
 palette = displayio.Palette(2)
 palette[0] = 0x000000
-palette[1] = 0xffffff
+palette[1] = 0xFFFFFF
 
 # Create a TileGrid using the Bitmap and Palette
 tile_grid = displayio.TileGrid(bitmap, pixel_shader=palette)

examples/gizmo_tft_demo.py

@@ -16,27 +16,23 @@
 
 color_bitmap = displayio.Bitmap(240, 240, 1)
 color_palette = displayio.Palette(1)
-color_palette[0] = 0x00FF00 # Bright Green
+color_palette[0] = 0x00FF00  # Bright Green
 
-bg_sprite = displayio.TileGrid(color_bitmap,
-                               pixel_shader=color_palette,
-                               x=0, y=0)
+bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)
 splash.append(bg_sprite)
 
 # Draw a smaller inner rectangle
 inner_bitmap = displayio.Bitmap(200, 200, 1)
 inner_palette = displayio.Palette(1)
-inner_palette[0] = 0xAA0088 # Purple
-inner_sprite = displayio.TileGrid(inner_bitmap,
-                                  pixel_shader=inner_palette,
-                                  x=20, y=20)
+inner_palette[0] = 0xAA0088  # Purple
+inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20)
 splash.append(inner_sprite)
 
 # Draw a label
 text_group = displayio.Group(max_size=10, scale=2, x=50, y=120)
 text = "Hello World!"
 text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00)
-text_group.append(text_area) # Subgroup for text scaling
+text_group.append(text_area)  # Subgroup for text scaling
 splash.append(text_group)
 
 while True:

examples/gizmo_tft_termometer.py

@@ -15,6 +15,7 @@
 import terminalio
 from adafruit_display_text import label
 from adafruit_gizmo import tft_gizmo
+
 display = tft_gizmo.TFT_Gizmo()
 
 
@@ -30,7 +31,7 @@
 
 # function to convert celsius degrees to fahrenheit
 def c_to_f(c_val):
-    return (c_val * 9/5) + 32
+    return (c_val * 9 / 5) + 32
 
 
 # Open the background image file
@@ -61,7 +62,7 @@ def c_to_f(c_val):
     text_area.anchor_point = (0.5, 0.0)
 
     # Set the location to center of display, accounting for text_scale
-    text_area.anchored_position = (240/(2*TEXT_SCALE), 240/(2*TEXT_SCALE))
+    text_area.anchored_position = (240 / (2 * TEXT_SCALE), 240 / (2 * TEXT_SCALE))
 
     # Subgroup for text scaling
     text_group.append(text_area)
@@ -77,7 +78,7 @@ def c_to_f(c_val):
         # set current button state to variable
         cur_a_val = cp.button_a
         if cur_a_val and not old_a_val:  # if the button was released
-            print('Just released')
+            print("Just released")
             # flip the units boolean to the opposite value
             show_c_units = not show_c_units