Merge pull request #11 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_sharpmemorydisplay.py

@@ -56,20 +56,22 @@
 _SHARPMEM_BIT_VCOM = const(0x40)  # in lsb
 _SHARPMEM_BIT_CLEAR = const(0x20)  # in lsb
 
+
 def reverse_bit(num):
     """Turn an LSB byte to an MSB byte, and vice versa. Used for SPI as
     it is LSB for the SHARP, but 99% of SPI implementations are MSB only!"""
     result = 0
     for _ in range(8):
         result <<= 1
-        result += (num & 1)
+        result += num & 1
         num >>= 1
     return result
 
 
 class SharpMemoryDisplay(adafruit_framebuf.FrameBuffer):
     """A driver for sharp memory displays, you can use any size but the
     full display must be buffered in memory!"""
+
     # pylint: disable=too-many-instance-attributes,abstract-method
 
     def __init__(self, spi, scs_pin, width, height, *, baudrate=8000000):
@@ -108,11 +110,11 @@ def show(self):
         self._spi.write(self._buf)
 
         slice_from = 0
-        line_len = self.width//8
+        line_len = self.width // 8
         for line in range(self.height):
-            self._buf[0] = reverse_bit(line+1)
+            self._buf[0] = reverse_bit(line + 1)
             self._spi.write(self._buf)
-            self._spi.write(memoryview(self.buffer[slice_from:slice_from+line_len]))
+            self._spi.write(memoryview(self.buffer[slice_from : slice_from + line_len]))
             slice_from += line_len
             self._buf[0] = 0
             self._spi.write(self._buf)

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 = ["digitalio", "busio"]
 
 
-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 SHARPMemoryDisplay Library'
-copyright = u'2018 ladyada'
-author = u'ladyada'
+project = u"Adafruit SHARPMemoryDisplay Library"
+copyright = u"2018 ladyada"
+author = u"ladyada"
 
 # 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 +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 = 'AdafruitSharpmemorydisplayLibrarydoc'
+htmlhelp_basename = "AdafruitSharpmemorydisplayLibrarydoc"
 
 # -- 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, 'AdafruitSHARPMemoryDisplayLibrary.tex', u'AdafruitSHARPMemoryDisplay Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitSHARPMemoryDisplayLibrary.tex",
+        u"AdafruitSHARPMemoryDisplay 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, 'AdafruitSHARPMemoryDisplaylibrary', u'Adafruit SHARPMemoryDisplay Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitSHARPMemoryDisplaylibrary",
+        u"Adafruit SHARPMemoryDisplay 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, 'AdafruitSHARPMemoryDisplayLibrary', u'Adafruit SHARPMemoryDisplay Library Documentation',
-     author, 'AdafruitSHARPMemoryDisplayLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitSHARPMemoryDisplayLibrary",
+        u"Adafruit SHARPMemoryDisplay Library Documentation",
+        author,
+        "AdafruitSHARPMemoryDisplayLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/sharpmemorydisplay_pillow_demo.py

@@ -22,9 +22,9 @@
 FONTSIZE = 10
 
 spi = busio.SPI(board.SCK, MOSI=board.MOSI)
-scs = digitalio.DigitalInOut(board.D6) # inverted chip select
+scs = digitalio.DigitalInOut(board.D6)  # inverted chip select
 
-#display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96)
+# display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96)
 display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 144, 168)
 
 # Clear display.
@@ -33,7 +33,7 @@
 
 # Create blank image for drawing.
 # Make sure to create image with mode '1' for 1-bit color.
-image = Image.new('1', (display.width, display.height))
+image = Image.new("1", (display.width, display.height))
 
 # Get drawing object to draw on image.
 draw = ImageDraw.Draw(image)
@@ -42,17 +42,24 @@
 draw.rectangle((0, 0, display.width, display.height), outline=BLACK, fill=BLACK)
 
 # Draw a smaller inner rectangle
-draw.rectangle((BORDER, BORDER, display.width - BORDER - 1, display.height - BORDER - 1),
-               outline=WHITE, fill=WHITE)
+draw.rectangle(
+    (BORDER, BORDER, display.width - BORDER - 1, display.height - BORDER - 1),
+    outline=WHITE,
+    fill=WHITE,
+)
 
 # Load a TTF font.
-font = ImageFont.truetype('/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf', FONTSIZE)
+font = ImageFont.truetype("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf", FONTSIZE)
 
 # Draw Some Text
 text = "Hello World!"
 (font_width, font_height) = font.getsize(text)
-draw.text((display.width//2 - font_width//2, display.height//2 - font_height//2),
-          text, font=font, fill=BLACK)
+draw.text(
+    (display.width // 2 - font_width // 2, display.height // 2 - font_height // 2),
+    text,
+    font=font,
+    fill=BLACK,
+)
 
 # Display image
 display.image(image)

examples/sharpmemorydisplay_simpletest.py

@@ -7,7 +7,7 @@
 
 # Initialize SPI bus and control pins
 spi = busio.SPI(board.SCK, MOSI=board.MOSI)
-scs = digitalio.DigitalInOut(board.D6) # inverted chip select
+scs = digitalio.DigitalInOut(board.D6)  # inverted chip select
 
 # pass in the display size, width and height, as well
 # display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96)
@@ -23,22 +23,25 @@
 # Set a pixel in the origin 0,0 position.
 display.pixel(0, 0, 0)
 # Set a pixel in the middle position.
-display.pixel(display.width//2, display.width//2, 0)
+display.pixel(display.width // 2, display.width // 2, 0)
 # Set a pixel in the opposite corner position.
-display.pixel(display.width-1, display.height-1, 0)
+display.pixel(display.width - 1, display.height - 1, 0)
 display.show()
 time.sleep(2)
 
 print("Lines test")
 # we'll draw from corner to corner, lets define all the pair coordinates here
-corners = ((0, 0), (0, display.height-1), (display.width-1, 0),
-           (display.width-1, display.height-1))
+corners = (
+    (0, 0),
+    (0, display.height - 1),
+    (display.width - 1, 0),
+    (display.width - 1, display.height - 1),
+)
 
 display.fill(1)
 for corner_from in corners:
     for corner_to in corners:
-        display.line(corner_from[0], corner_from[1],
-                     corner_to[0], corner_to[1], 0)
+        display.line(corner_from[0], corner_from[1], corner_to[0], corner_to[1], 0)
 display.show()
 time.sleep(2)
 
@@ -47,16 +50,16 @@
 w_delta = display.width / 10
 h_delta = display.height / 10
 for i in range(11):
-    display.rect(0, 0, int(w_delta*i), int(h_delta*i), 0)
+    display.rect(0, 0, int(w_delta * i), int(h_delta * i), 0)
 display.show()
 time.sleep(2)
 
 print("Text test")
 display.fill(1)
-display.text(' hello world!', 0, 0, 0)
-display.text(' This is the', 0, 8, 0)
-display.text(' CircuitPython', 0, 16, 0)
-display.text('adafruit library', 0, 24, 0)
-display.text(' for the SHARP', 0, 32, 0)
-display.text(' Memory Display :) ', 0, 40, 0)
+display.text(" hello world!", 0, 0, 0)
+display.text(" This is the", 0, 8, 0)
+display.text(" CircuitPython", 0, 16, 0)
+display.text("adafruit library", 0, 24, 0)
+display.text(" for the SHARP", 0, 32, 0)
+display.text(" Memory Display :) ", 0, 40, 0)
 display.show()