Merge pull request #18 from adafruit/pylint-update

Pylint update

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 pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

adafruit_cursorcontrol/cursorcontrol.py

@@ -65,8 +65,17 @@ class Cursor():
         # initialize the mouse cursor object
         mouse_cursor = Cursor(display, display_group=splash)
     """
+
     # pylint: disable=too-many-arguments,line-too-long
-    def __init__(self, display=None, display_group=None, bmp=None, is_hidden=False, cursor_speed=5, scale=1):
+    def __init__(
+        self,
+        display=None,
+        display_group=None,
+        bmp=None,
+        is_hidden=False,
+        cursor_speed=5,
+        scale=1,
+    ):
         self._display = display
         self._scale = scale
         self._speed = cursor_speed
@@ -79,6 +88,7 @@ def __init__(self, display=None, display_group=None, bmp=None, is_hidden=False,
         else:
             self._cursor_bitmap = bmp
         self.generate_cursor(self._cursor_bitmap)
+
     # pylint: enable=too-many-arguments,line-too-long
 
     def __enter__(self):
@@ -96,8 +106,10 @@ def deinit(self):
     def _is_deinited(self):
         """checks cursor deinitialization"""
         if self._scale is None:
-            raise ValueError("Cursor object has been deinitialized and can no longer "
-                             "be used. Create a new cursor object.")
+            raise ValueError(
+                "Cursor object has been deinitialized and can no longer "
+                "be used. Create a new cursor object."
+            )
 
     @property
     def scale(self):
@@ -187,7 +199,7 @@ def show(self):
         """Show the cursor."""
         self.hidden = False
 
-    #pylint:disable=no-self-use
+    # pylint:disable=no-self-use
     def _default_cursor_bitmap(self):
         bmp = displayio.Bitmap(20, 20, 3)
         # left edge, outline
@@ -196,20 +208,21 @@ def _default_cursor_bitmap(self):
         # right diag outline, inside fill
         for j in range(1, 15):
             bmp[j, j] = 2
-            for i in range(j+1, bmp.height - j):
+            for i in range(j + 1, bmp.height - j):
                 bmp[j, i] = 1
         # bottom diag., outline
         for i in range(1, 5):
-            bmp[i, bmp.height-i] = 2
+            bmp[i, bmp.height - i] = 2
         # bottom flat line, right side fill
         for i in range(5, 15):
             bmp[i, 15] = 2
-            bmp[i-1, 14] = 1
-            bmp[i-2, 13] = 1
-            bmp[i-3, 12] = 1
-            bmp[i-4, 11] = 1
+            bmp[i - 1, 14] = 1
+            bmp[i - 2, 13] = 1
+            bmp[i - 3, 12] = 1
+            bmp[i - 4, 11] = 1
         return bmp
-    #pylint:enable=no-self-use
+
+    # pylint:enable=no-self-use
 
     @property
     def cursor_bitmap(self):
@@ -224,8 +237,7 @@ def cursor_bitmap(self, bmp):
         """
         self._cursor_bitmap = bmp
         self._cursor_grp.remove(self._cur_sprite)
-        self._cur_sprite = displayio.TileGrid(bmp,
-                                              pixel_shader=self._cur_palette)
+        self._cur_sprite = displayio.TileGrid(bmp, pixel_shader=self._cur_palette)
         self._cursor_grp.append(self._cur_sprite)
 
     def generate_cursor(self, bmp):
@@ -236,7 +248,6 @@ def generate_cursor(self, bmp):
         self._cur_palette.make_transparent(0)
         self._cur_palette[1] = 0xFFFFFF
         self._cur_palette[2] = 0x0000
-        self._cur_sprite = displayio.TileGrid(bmp,
-                                              pixel_shader=self._cur_palette)
+        self._cur_sprite = displayio.TileGrid(bmp, pixel_shader=self._cur_palette)
         self._cursor_grp.append(self._cur_sprite)
         self._display_grp.append(self._cursor_grp)

adafruit_cursorcontrol/cursorcontrol_cursormanager.py

@@ -41,7 +41,8 @@
 # PyBadge & PyGamer
 PYBADGE_BUTTON_A = const(2)
 
-class CursorManager():
+
+class CursorManager:
     """Simple interaction user interface interaction for Adafruit_CursorControl.
 
     :param adafruit_cursorcontrol cursor: The cursor object we are using.

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"]
 
 
-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 CursorControl Library'
-copyright = u'2019 Brent Rubell'
-author = u'Brent Rubell'
+project = "Adafruit CursorControl Library"
+copyright = "2019 Brent Rubell"
+author = "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 = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = "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 = 'AdafruitCursorcontrolLibrarydoc'
+htmlhelp_basename = "AdafruitCursorcontrolLibrarydoc"
 
 # -- 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, 'AdafruitCursorControlLibrary.tex', u'AdafruitCursorControl Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitCursorControlLibrary.tex",
+        "AdafruitCursorControl 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, 'AdafruitCursorControllibrary', u'Adafruit CursorControl Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitCursorControllibrary",
+        "Adafruit CursorControl 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, 'AdafruitCursorControlLibrary', u'Adafruit CursorControl Library Documentation',
-     author, 'AdafruitCursorControlLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitCursorControlLibrary",
+        "Adafruit CursorControl Library Documentation",
+        author,
+        "AdafruitCursorControlLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]