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

adafruit_displayio_ssd1306.py

@@ -53,12 +53,12 @@
 
 # Sequence from page 19 here: https://cdn-shop.adafruit.com/datasheets/UG-2864HSWEG01+user+guide.pdf
 _INIT_SEQUENCE = (
-    b"\xAE\x00"      # DISPLAY_OFF
+    b"\xAE\x00"  # DISPLAY_OFF
     b"\x20\x01\x00"  # Set memory addressing to horizontal mode.
-    b"\x81\x01\xcf" # set contrast control
-    b"\xA1\x00"      # Column 127 is segment 0
-    b"\xA6\x00"      # Normal display
-    b"\xc8\x00"      # Normal display
+    b"\x81\x01\xcf"  # set contrast control
+    b"\xA1\x00"  # Column 127 is segment 0
+    b"\xA6\x00"  # Normal display
+    b"\xc8\x00"  # Normal display
     b"\xA8\x01\x3f"  # Mux ratio is 1/64
     b"\xd5\x01\x80"  # Set divide ratio
     b"\xd9\x01\xf1"  # Set pre-charge period
@@ -71,17 +71,27 @@
 # pylint: disable=too-few-public-methods
 class SSD1306(displayio.Display):
     """SSD1306 driver"""
+
     def __init__(self, bus, **kwargs):
         # Patch the init sequence for 32 pixel high displays.
         init_sequence = bytearray(_INIT_SEQUENCE)
         height = kwargs["height"]
         if "rotation" in kwargs and kwargs["rotation"] % 180 != 0:
             height = kwargs["width"]
-        init_sequence[16] = height - 1 # patch mux ratio
+        init_sequence[16] = height - 1  # patch mux ratio
         if kwargs["height"] == 32:
-            init_sequence[25] = 0x02 # patch com configuration
-        super().__init__(bus, init_sequence, **kwargs, color_depth=1, grayscale=True,
-                         pixels_in_byte_share_row=False,
-                         set_column_command=0x21, set_row_command=0x22, data_as_commands=True,
-                         set_vertical_scroll=0xd3, brightness_command=0x81,
-                         single_byte_bounds=True)
+            init_sequence[25] = 0x02  # patch com configuration
+        super().__init__(
+            bus,
+            init_sequence,
+            **kwargs,
+            color_depth=1,
+            grayscale=True,
+            pixels_in_byte_share_row=False,
+            set_column_command=0x21,
+            set_row_command=0x22,
+            data_as_commands=True,
+            set_vertical_scroll=0xD3,
+            brightness_command=0x81,
+            single_byte_bounds=True,
+        )

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 DisplayIO_SSD1306 Library'
-copyright = u'2019 Scott Shawcroft'
-author = u'Scott Shawcroft'
+project = "Adafruit DisplayIO_SSD1306 Library"
+copyright = "2019 Scott Shawcroft"
+author = "Scott Shawcroft"
 
 # 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 = 'AdafruitDisplayio_ssd1306Librarydoc'
+htmlhelp_basename = "AdafruitDisplayio_ssd1306Librarydoc"
 
 # -- 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, 'AdafruitDisplayIO_SSD1306Library.tex', u'AdafruitDisplayIO_SSD1306 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitDisplayIO_SSD1306Library.tex",
+        "AdafruitDisplayIO_SSD1306 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, 'AdafruitDisplayIO_SSD1306library', u'Adafruit DisplayIO_SSD1306 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitDisplayIO_SSD1306library",
+        "Adafruit DisplayIO_SSD1306 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, 'AdafruitDisplayIO_SSD1306Library', u'Adafruit DisplayIO_SSD1306 Library Documentation',
-     author, 'AdafruitDisplayIO_SSD1306Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitDisplayIO_SSD1306Library",
+        "Adafruit DisplayIO_SSD1306 Library Documentation",
+        author,
+        "AdafruitDisplayIO_SSD1306Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/displayio_ssd1306_featherwing.py

@@ -12,7 +12,7 @@
 displayio.release_displays()
 
 i2c = board.I2C()
-display_bus = displayio.I2CDisplay(i2c, device_address=0x3c)
+display_bus = displayio.I2CDisplay(i2c, device_address=0x3C)
 display = adafruit_displayio_ssd1306.SSD1306(display_bus, width=128, height=32)
 
 # Make the display context
@@ -21,20 +21,16 @@
 
 color_bitmap = displayio.Bitmap(128, 32, 1)
 color_palette = displayio.Palette(1)
-color_palette[0] = 0xFFFFFF # White
+color_palette[0] = 0xFFFFFF  # White
 
-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(118, 24, 1)
 inner_palette = displayio.Palette(1)
-inner_palette[0] = 0x000000 # Black
-inner_sprite = displayio.TileGrid(inner_bitmap,
-                                  pixel_shader=inner_palette,
-                                  x=5, y=4)
+inner_palette[0] = 0x000000  # Black
+inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=5, y=4)
 splash.append(inner_sprite)
 
 # Draw a label

examples/displayio_ssd1306_simpletest.py

@@ -15,17 +15,17 @@
 
 # Use for I2C
 i2c = board.I2C()
-display_bus = displayio.I2CDisplay(i2c, device_address=0x3c, reset=oled_reset)
+display_bus = displayio.I2CDisplay(i2c, device_address=0x3C, reset=oled_reset)
 
 # Use for SPI
-#spi = board.SPI()
-#oled_cs = board.D5
-#oled_dc = board.D6
-#display_bus = displayio.FourWire(spi, command=oled_dc, chip_select=oled_cs,
+# spi = board.SPI()
+# oled_cs = board.D5
+# oled_dc = board.D6
+# display_bus = displayio.FourWire(spi, command=oled_dc, chip_select=oled_cs,
 #                                 reset=oled_reset, baudrate=1000000)
 
 WIDTH = 128
-HEIGHT = 32     # Change to 64 if needed
+HEIGHT = 32  # Change to 64 if needed
 BORDER = 5
 
 display = adafruit_displayio_ssd1306.SSD1306(display_bus, width=WIDTH, height=HEIGHT)
@@ -36,25 +36,25 @@
 
 color_bitmap = displayio.Bitmap(WIDTH, HEIGHT, 1)
 color_palette = displayio.Palette(1)
-color_palette[0] = 0xFFFFFF # White
+color_palette[0] = 0xFFFFFF  # White
 
-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(WIDTH-BORDER*2, HEIGHT-BORDER*2, 1)
+inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1)
 inner_palette = displayio.Palette(1)
-inner_palette[0] = 0x000000 # Black
-inner_sprite = displayio.TileGrid(inner_bitmap,
-                                  pixel_shader=inner_palette,
-                                  x=BORDER, y=BORDER)
+inner_palette[0] = 0x000000  # Black
+inner_sprite = displayio.TileGrid(
+    inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER
+)
 splash.append(inner_sprite)
 
 # Draw a label
 text = "Hello World!"
-text_area = label.Label(terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT//2-1)
+text_area = label.Label(
+    terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT // 2 - 1
+)
 splash.append(text_area)
 
 while True: