Merge pull request #9 from adafruit/pylint-update

Pylint update

.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_bitmapsaver.py

@@ -54,39 +54,44 @@
 
 
 def _write_bmp_header(output_file, filesize):
-    output_file.write(bytes('BM', 'ascii'))
-    output_file.write(struct.pack('<I', filesize))
-    output_file.write(b'\00\x00')
-    output_file.write(b'\00\x00')
-    output_file.write(struct.pack('<I', 54))
+    output_file.write(bytes("BM", "ascii"))
+    output_file.write(struct.pack("<I", filesize))
+    output_file.write(b"\00\x00")
+    output_file.write(b"\00\x00")
+    output_file.write(struct.pack("<I", 54))
+
 
 def _write_dib_header(output_file, width, height):
-    output_file.write(struct.pack('<I', 40))
-    output_file.write(struct.pack('<I', width))
-    output_file.write(struct.pack('<I', height))
-    output_file.write(struct.pack('<H', 1))
-    output_file.write(struct.pack('<H', 24))
+    output_file.write(struct.pack("<I", 40))
+    output_file.write(struct.pack("<I", width))
+    output_file.write(struct.pack("<I", height))
+    output_file.write(struct.pack("<H", 1))
+    output_file.write(struct.pack("<H", 24))
     for _ in range(24):
-        output_file.write(b'\x00')
+        output_file.write(b"\x00")
+
 
 def _bytes_per_row(source_width):
     pixel_bytes = 3 * source_width
     padding_bytes = (4 - (pixel_bytes % 4)) % 4
     return pixel_bytes + padding_bytes
 
+
 def _rotated_height_and_width(pixel_source):
     # flip axis if the display is rotated
     if isinstance(pixel_source, Display) and (pixel_source.rotation % 180 != 0):
         return (pixel_source.height, pixel_source.width)
     return (pixel_source.width, pixel_source.height)
 
+
 def _rgb565_to_bgr_tuple(color):
-    blue = (color << 3) & 0x00F8    # extract each of the RGB tripple into it's own byte
+    blue = (color << 3) & 0x00F8  # extract each of the RGB tripple into it's own byte
     green = (color >> 3) & 0x00FC
     red = (color >> 8) & 0x00F8
     return (blue, green, red)
 
-#pylint:disable=too-many-locals
+
+# pylint:disable=too-many-locals
 def _write_pixels(output_file, pixel_source, palette):
     saving_bitmap = isinstance(pixel_source, Bitmap)
     width, height = _rotated_height_and_width(pixel_source)
@@ -96,22 +101,25 @@ def _write_pixels(output_file, pixel_source, palette):
         buffer_index = 0
         if saving_bitmap:
             for x in range(width):
-                pixel = pixel_source[x, y-1]
+                pixel = pixel_source[x, y - 1]
                 color = palette[pixel]
                 for _ in range(3):
                     row_buffer[buffer_index] = color & 0xFF
                     color >>= 8
                     buffer_index += 1
         else:
-            data = pixel_source.fill_row(y-1, result_buffer)
+            data = pixel_source.fill_row(y - 1, result_buffer)
             for i in range(width):
                 pixel565 = (data[i * 2] << 8) + data[i * 2 + 1]
                 for b in _rgb565_to_bgr_tuple(pixel565):
                     row_buffer[buffer_index] = b & 0xFF
                     buffer_index += 1
         output_file.write(row_buffer)
         gc.collect()
-#pylint:enable=too-many-locals
+
+
+# pylint:enable=too-many-locals
+
 
 def save_pixels(file_or_filename, pixel_source=board.DISPLAY, palette=None):
     """Save pixels to a 24 bit per pixel BMP file.
@@ -124,12 +132,12 @@ def save_pixels(file_or_filename, pixel_source=board.DISPLAY, palette=None):
     """
     if isinstance(pixel_source, Bitmap):
         if not isinstance(palette, Palette):
-            raise ValueError('Third argument must be a Palette for a Bitmap save')
+            raise ValueError("Third argument must be a Palette for a Bitmap save")
     elif not isinstance(pixel_source, Display):
-        raise ValueError('Second argument must be a Bitmap or Display')
+        raise ValueError("Second argument must be a Bitmap or Display")
     try:
         if isinstance(file_or_filename, str):
-            output_file = open(file_or_filename, 'wb')
+            output_file = open(file_or_filename, "wb")
         else:
             output_file = file_or_filename
 

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", "digitalio", "busio", "board"]
 
 
-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 BitmapSaver Library'
-copyright = u'2019 Dave Astels'
-author = u'Dave Astels'
+project = "Adafruit BitmapSaver Library"
+copyright = "2019 Dave Astels"
+author = "Dave Astels"
 
 # 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 = 'AdafruitBitmapsaverLibrarydoc'
+htmlhelp_basename = "AdafruitBitmapsaverLibrarydoc"
 
 # -- 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, 'AdafruitBitmapSaverLibrary.tex', u'AdafruitBitmapSaver Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBitmapSaverLibrary.tex",
+        "AdafruitBitmapSaver 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, 'AdafruitBitmapSaverlibrary', u'Adafruit BitmapSaver Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBitmapSaverlibrary",
+        "Adafruit BitmapSaver 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, 'AdafruitBitmapSaverLibrary', u'Adafruit BitmapSaver Library Documentation',
-     author, 'AdafruitBitmapSaverLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBitmapSaverLibrary",
+        "Adafruit BitmapSaver Library Documentation",
+        author,
+        "AdafruitBitmapSaverLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/bitmapsaver_screenshot_simpletest.py

@@ -22,7 +22,7 @@
 
 """Example of taking a screenshot."""
 
-#pylint:disable=invalid-name
+# pylint:disable=invalid-name
 import board
 import digitalio
 import busio
@@ -37,6 +37,6 @@
 vfs = storage.VfsFat(sdcard)
 storage.mount(vfs, "/sd")
 
-print('Taking Screenshot...')
-save_pixels('/sd/screenshot.bmp')
-print('Screenshot taken')
+print("Taking Screenshot...")
+save_pixels("/sd/screenshot.bmp")
+print("Screenshot taken")

examples/bitmapsaver_simpletest.py

@@ -30,9 +30,9 @@
 import storage
 from adafruit_bitmapsaver import save_pixels
 
-#pylint:disable=invalid-name
+# pylint:disable=invalid-name
 
-print('Setting up SD card')
+print("Setting up SD card")
 spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
 cs = digitalio.DigitalInOut(board.SD_CS)
 sdcard = adafruit_sdcard.SDCard(spi, cs)
@@ -51,7 +51,7 @@
 
 colors = (BLACK, RED, ORANGE, YELLOW, GREEN, BLUE, PURPLE, WHITE)
 
-print('Building sample bitmap and palette')
+print("Building sample bitmap and palette")
 bitmap = Bitmap(16, 16, 9)
 palette = Palette(len(colors))
 for i, c in enumerate(colors):
@@ -68,5 +68,5 @@
         else:
             bitmap[x, y] = 0
 
-print('Saving bitmap')
-save_pixels('/sd/test.bmp', bitmap, palette)
+print("Saving bitmap")
+save_pixels("/sd/test.bmp", bitmap, palette)