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

@@ -430,4 +430,4 @@ min-public-methods=1
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=Exception

adafruit_progressbar.py

@@ -60,10 +60,19 @@ class ProgressBar(displayio.TileGrid):
     :param int stroke: Used for the outline_color
 
     """
-    #pylint: disable=invalid-name
-    def __init__(self, x, y, width, height,
-                 progress=0.0, bar_color=0x00FF00,
-                 outline_color=0xFFFFFF, stroke=1):
+
+    # pylint: disable=invalid-name
+    def __init__(
+        self,
+        x,
+        y,
+        width,
+        height,
+        progress=0.0,
+        bar_color=0x00FF00,
+        outline_color=0xFFFFFF,
+        stroke=1,
+    ):
         assert isinstance(progress, float), "Progress must be a floating point value."
         self._bitmap = displayio.Bitmap(width, height, 3)
         self._palette = displayio.Palette(3)
@@ -81,11 +90,11 @@ def __init__(self, x, y, width, height,
         for _w in range(width):
             for line in range(stroke):
                 self._bitmap[_w, line] = 1
-                self._bitmap[_w, height-1-line] = 1
+                self._bitmap[_w, height - 1 - line] = 1
         for _h in range(height):
             for line in range(stroke):
                 self._bitmap[line, _h] = 1
-                self._bitmap[width-1-line, _h] = 1
+                self._bitmap[width - 1 - line, _h] = 1
         super().__init__(self._bitmap, pixel_shader=self._palette, x=x, y=y)
 
     @property
@@ -103,16 +112,18 @@ def progress(self, value):
         :param float value: Progress bar value.
         """
         assert value <= 1.0, "Progress value may not be > 100%"
-        assert isinstance(value, float), "Progress value must be a floating point value."
+        assert isinstance(
+            value, float
+        ), "Progress value must be a floating point value."
         if self._progress_val > value:
             # uncolorize range from width*value+margin to width-margin
-            for _w in range(int(value*self._width+2), self._width-2):
-                for _h in range(2, self._height-2):
+            for _w in range(int(value * self._width + 2), self._width - 2):
+                for _h in range(2, self._height - 2):
                     self._bitmap[_w, _h] = 0
         else:
             # fully fill progress bar color
-            for _w in range(2, self._width*value-2):
-                for _h in range(2, self._height-2):
+            for _w in range(2, self._width * value - 2):
+                for _h in range(2, self._height - 2):
                     self._bitmap[_w, _h] = 2
         self._progress_val = value
 

docs/conf.py

@@ -2,48 +2,52 @@
 
 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",
 ]
 
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
 autodoc_mock_imports = ["displayio"]
 
-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 ProgressBar Library'
-copyright = u'2020 Brent Rubell'
-author = u'Brent Rubell'
+project = u"Adafruit ProgressBar Library"
+copyright = u"2020 Brent Rubell"
+author = u"Brent Rubell"
 
 # 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.
@@ -55,7 +59,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.
@@ -67,7 +71,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
@@ -82,68 +86,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 = 'AdafruitProgressbarLibrarydoc'
+htmlhelp_basename = "AdafruitProgressbarLibrarydoc"
 
 # -- 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, 'AdafruitProgressBarLibrary.tex', u'AdafruitProgressBar Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitProgressBarLibrary.tex",
+        u"AdafruitProgressBar 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, 'AdafruitProgressBarlibrary', u'Adafruit ProgressBar Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitProgressBarlibrary",
+        u"Adafruit ProgressBar Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -152,7 +164,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitProgressBarLibrary', u'Adafruit ProgressBar Library Documentation',
-     author, 'AdafruitProgressBarLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitProgressBarLibrary",
+        u"Adafruit ProgressBar Library Documentation",
+        author,
+        "AdafruitProgressBarLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/progressbar_simpletest.py

@@ -11,14 +11,13 @@
 color_bitmap = displayio.Bitmap(320, 240, 1)
 color_palette = displayio.Palette(1)
 color_palette[0] = 0x0
-bg_sprite = displayio.TileGrid(color_bitmap, x=0, y=0,
-                               pixel_shader=color_palette)
+bg_sprite = displayio.TileGrid(color_bitmap, x=0, y=0, pixel_shader=color_palette)
 splash.append(bg_sprite)
 ##########################################################################
 
 # set progress bar width and height relative to board's display
-x = board.DISPLAY.width//5
-y = board.DISPLAY.height//3
+x = board.DISPLAY.width // 5
+y = board.DISPLAY.height // 3
 
 # Create a new progress_bar object at (x, y)
 progress_bar = ProgressBar(x, y, 200, 30, 1.0)
@@ -29,9 +28,9 @@
 current_progress = 0.0
 while True:
     while current_progress <= 1.0:
-        print("Progress: {}%".format(current_progress*100))
+        print("Progress: {}%".format(current_progress * 100))
         progress_bar.progress = current_progress
-        current_progress+=0.05
+        current_progress += 0.05
         if current_progress >= 1.0:
             current_progress = 0.0
         time.sleep(0.01)

setup.py

@@ -6,59 +6,49 @@
 """
 
 from setuptools import setup, find_packages
+
 # To use a consistent encoding
 from codecs import open
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-progressbar',
-
+    name="adafruit-circuitpython-progressbar",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='Dynamic progress bar widget for CircuitPython displays',
+    setup_requires=["setuptools_scm"],
+    description="Dynamic progress bar widget for CircuitPython displays",
     long_description=long_description,
-    long_description_content_type='text/x-rst',
-
+    long_description_content_type="text/x-rst",
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar",
     # Author details
-    author='Adafruit Industries',
-    author_email='[email protected]',
-
-    install_requires=[
-        'Adafruit-Blinka'
-    ],
-
+    author="Adafruit Industries",
+    author_email="[email protected]",
+    install_requires=["Adafruit-Blinka"],
     # Choose your license
-    license='MIT',
-
+    license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: System :: Hardware',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
     ],
-
     # What does your project relate to?
-    keywords='adafruit blinka circuitpython micropython progressbar widget, displayio, '
-             'progress, bar, element',
-
+    keywords="adafruit blinka circuitpython micropython progressbar widget, displayio, "
+    "progress, bar, element",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
     #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=['adafruit_progressbar'],
+    py_modules=["adafruit_progressbar"],
 )