Merge pull request #48 from adafruit/pylint-update

Ran black, updated to pylint 2.x

Author: FoamyGuy

.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

@@ -119,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]

adafruit_bus_device/i2c_device.py

@@ -28,6 +28,7 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BusDevice.git"
 
+
 class I2CDevice:
     """
     Represents a single I2C device and manages locking the bus and the device
@@ -61,7 +62,7 @@ class I2CDevice:
     def __init__(self, i2c, device_address, probe=True):
 
         self.i2c = i2c
-        self._has_write_read = hasattr(self.i2c, 'writeto_then_readfrom')
+        self._has_write_read = hasattr(self.i2c, "writeto_then_readfrom")
         self.device_address = device_address
 
         if probe:
@@ -102,9 +103,18 @@ def write(self, buf, *, start=0, end=None, stop=True):
             end = len(buf)
         self.i2c.writeto(self.device_address, buf, start=start, end=end, stop=stop)
 
-#pylint: disable-msg=too-many-arguments
-    def write_then_readinto(self, out_buffer, in_buffer, *,
-                            out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
+    # pylint: disable-msg=too-many-arguments
+    def write_then_readinto(
+        self,
+        out_buffer,
+        in_buffer,
+        *,
+        out_start=0,
+        out_end=None,
+        in_start=0,
+        in_end=None,
+        stop=False
+    ):
         """
         Write the bytes from ``out_buffer`` to the device, then immediately
         reads into ``in_buffer`` from the device. The number of bytes read
@@ -136,16 +146,22 @@ def write_then_readinto(self, out_buffer, in_buffer, *,
             raise ValueError("Stop must be False. Use writeto instead.")
         if self._has_write_read:
             # In linux, at least, this is a special kernel function call
-            self.i2c.writeto_then_readfrom(self.device_address, out_buffer, in_buffer,
-                                           out_start=out_start, out_end=out_end,
-                                           in_start=in_start, in_end=in_end)
+            self.i2c.writeto_then_readfrom(
+                self.device_address,
+                out_buffer,
+                in_buffer,
+                out_start=out_start,
+                out_end=out_end,
+                in_start=in_start,
+                in_end=in_end,
+            )
 
         else:
             # If we don't have a special implementation, we can fake it with two calls
             self.write(out_buffer, start=out_start, end=out_end, stop=False)
             self.readinto(in_buffer, start=in_start, end=in_end)
 
-#pylint: enable-msg=too-many-arguments
+    # pylint: enable-msg=too-many-arguments
 
     def __enter__(self):
         while not self.i2c.try_lock():
@@ -165,7 +181,7 @@ def __probe_for_device(self):
         while not self.i2c.try_lock():
             pass
         try:
-            self.i2c.writeto(self.device_address, b'')
+            self.i2c.writeto(self.device_address, b"")
         except OSError:
             # some OS's dont like writing an empty bytesting...
             # Retry by reading a byte

adafruit_bus_device/spi_device.py

@@ -29,6 +29,7 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BusDevice.git"
 
+
 class SPIDevice:
     """
     Represents a single SPI device and manages locking the bus and the device
@@ -65,8 +66,17 @@ class SPIDevice:
             with device as spi:
                 spi.write(bytes_read)
     """
-    def __init__(self, spi, chip_select=None, *,
-                 baudrate=100000, polarity=0, phase=0, extra_clocks=0):
+
+    def __init__(
+        self,
+        spi,
+        chip_select=None,
+        *,
+        baudrate=100000,
+        polarity=0,
+        phase=0,
+        extra_clocks=0
+    ):
         self.spi = spi
         self.baudrate = baudrate
         self.polarity = polarity
@@ -79,8 +89,9 @@ def __init__(self, spi, chip_select=None, *,
     def __enter__(self):
         while not self.spi.try_lock():
             pass
-        self.spi.configure(baudrate=self.baudrate, polarity=self.polarity,
-                           phase=self.phase)
+        self.spi.configure(
+            baudrate=self.baudrate, polarity=self.polarity, phase=self.phase
+        )
         if self.chip_select:
             self.chip_select.value = False
         return self.spi
@@ -90,7 +101,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
             self.chip_select.value = True
         if self.extra_clocks > 0:
             buf = bytearray(1)
-            buf[0] = 0xff
+            buf[0] = 0xFF
             clocks = self.extra_clocks // 8
             if self.extra_clocks % 8 != 0:
                 clocks += 1

docs/conf.py

@@ -2,47 +2,55 @@
 
 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.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 # 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 = ["adafruit_bus_device", "micropython"]
-
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+# autodoc_mock_imports = ["adafruit_bus_device", "micropython"]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        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 CircuitPython Bus Device'
-copyright = u'2016-2017 Scott Shawcroft and Tony Dicola for Adafruit Industries'
-author = u'Scott Shawcroft and Tony Dicola'
+project = u"Adafruit CircuitPython Bus Device"
+copyright = u"2016-2017 Scott Shawcroft and Tony Dicola for Adafruit Industries"
+author = u"Scott Shawcroft and Tony Dicola"
 
 # 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.
@@ -54,7 +62,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.
@@ -66,7 +74,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
@@ -80,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 = 'AdafruitBusDeviceLibrarydoc'
+htmlhelp_basename = "AdafruitBusDeviceLibrarydoc"
 
 # -- 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, 'AdafruitBusDeviceLibrary.tex', u'Adafruit Bus Device Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBusDeviceLibrary.tex",
+        u"Adafruit Bus Device 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, 'AdafruitBusDeviceLibrary', u'Adafruit Bus Device Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBusDeviceLibrary",
+        u"Adafruit Bus Device Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -150,7 +166,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitBusDeviceLibrary', u'Adafruit Bus Device Library Documentation',
-     author, 'AdafruitBusDeviceLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBusDeviceLibrary",
+        u"Adafruit Bus Device Library Documentation",
+        author,
+        "AdafruitBusDeviceLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]