Ran black, updated to pylint 2.x

Author: evaherrada

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

@@ -45,15 +45,16 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TFmini.git"
 
-_STARTCONFIG = b'\x42\x57\x02\x00\x00\x00\x01\x02'
-_STARTREPLY = b'\x57\x02\x01\x00\x00\x01\x02'  # minus header 0x42
-_CONFIGPARAM = b'\x42\x57\x02\x00'
-_ENDCONFIG = b'\x42\x57\x02\x00\x00\x00\x00\x02'
-_ENDREPLY = b'\x42\x57\x02\x01\x00\x00\x00\x02'
+_STARTCONFIG = b"\x42\x57\x02\x00\x00\x00\x01\x02"
+_STARTREPLY = b"\x57\x02\x01\x00\x00\x01\x02"  # minus header 0x42
+_CONFIGPARAM = b"\x42\x57\x02\x00"
+_ENDCONFIG = b"\x42\x57\x02\x00\x00\x00\x00\x02"
+_ENDREPLY = b"\x42\x57\x02\x01\x00\x00\x00\x02"
 
 MODE_SHORT = 2
 MODE_LONG = 7
 
+
 class TFmini:
     """TF mini communication module, use with just RX or TX+RX for advanced
     command & control.
@@ -87,7 +88,9 @@ def distance(self):
             # get remaining packet
             data = self._uart.read(8)
             # check first byte is magicbyte
-            frame, dist, self._strength, self._mode, _, checksum = struct.unpack("<BHHBBB", data)
+            frame, dist, self._strength, self._mode, _, checksum = struct.unpack(
+                "<BHHBBB", data
+            )
             # look for second 0x59 frame indicator
             if frame != 0x59:
                 continue
@@ -127,24 +130,24 @@ def _set_config(self, command):
             if not x or x[0] != 0x42:
                 continue
             echo = self._uart.read(len(_STARTREPLY))
-            #print("start ", [hex(i) for i in echo])
+            # print("start ", [hex(i) for i in echo])
             if echo != _STARTREPLY:
                 raise RuntimeError("Did not receive config start echo")
             break
 
         # Finally, send the command
         self._uart.write(command)
-        #print([hex(i) for i in command])
+        # print([hex(i) for i in command])
         echo = self._uart.read(len(command))
         cmdreply = bytearray(len(command))
         cmdreply[:] = command
         cmdreply[3] = 0x1
-        #print("cmd ", [hex(i) for i in echo])
+        # print("cmd ", [hex(i) for i in echo])
         if echo != cmdreply:
             raise RuntimeError("Did not receive config command echo")
 
         self._uart.write(_ENDCONFIG)
         echo = self._uart.read(len(_ENDREPLY))
-        #print("end ", [hex(i) for i in echo])
+        # print("end ", [hex(i) for i in echo])
         if echo != _ENDREPLY:
             raise RuntimeError("Did not receive config end echo")

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 TFmini Library'
-copyright = u'2018 ladyada'
-author = u'ladyada'
+project = u"Adafruit TFmini 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 = 'AdafruitTfminiLibrarydoc'
+htmlhelp_basename = "AdafruitTfminiLibrarydoc"
 
 # -- 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, 'AdafruitTFminiLibrary.tex', u'AdafruitTFmini Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitTFminiLibrary.tex",
+        u"AdafruitTFmini 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, 'AdafruitTFminilibrary', u'Adafruit TFmini Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitTFminilibrary",
+        u"Adafruit TFmini 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, 'AdafruitTFminiLibrary', u'Adafruit TFmini Library Documentation',
-     author, 'AdafruitTFminiLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitTFminiLibrary",
+        u"Adafruit TFmini Library Documentation",
+        author,
+        "AdafruitTFminiLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/tfmini_simpletest.py

@@ -7,8 +7,8 @@
 uart = busio.UART(board.TX, board.RX)
 
 # Or, you can use pyserial on any computer
-#import serial
-#uart = serial.Serial("/dev/ttyS2", timeout=1)
+# import serial
+# uart = serial.Serial("/dev/ttyS2", timeout=1)
 
 # Simplest use, connect with the uart bus object
 tfmini = adafruit_tfmini.TFmini(uart)
@@ -18,6 +18,8 @@
 print("Now in mode", tfmini.mode)
 
 while True:
-    print("Distance: %d cm (strength %d, mode %x)" %
-          (tfmini.distance, tfmini.strength, tfmini.mode))
+    print(
+        "Distance: %d cm (strength %d, mode %x)"
+        % (tfmini.distance, tfmini.strength, tfmini.mode)
+    )
     time.sleep(0.1)

setup.py

@@ -7,54 +7,46 @@
 
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
+
 # To use a consistent encoding
 from codecs import open
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-tfmini',
-
+    name="adafruit-circuitpython-tfmini",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='A CircuitPython/Python library for Benewake`s TF mini distance sensor',
+    setup_requires=["setuptools_scm"],
+    description="A CircuitPython/Python library for Benewake`s TF mini distance sensor",
     long_description=long_description,
-    long_description_content_type='text/x-rst',
-
+    long_description_content_type="text/x-rst",
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_TFmini',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_TFmini",
     # Author details
-    author='Adafruit Industries',
-    author_email='[email protected]',
-
-    install_requires=['Adafruit-Blinka', 'pyserial'],
-
+    author="Adafruit Industries",
+    author_email="[email protected]",
+    install_requires=["Adafruit-Blinka", "pyserial"],
     # Choose your license
-    license='MIT',
-
+    license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: System :: Hardware',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
     ],
-
     # What does your project relate to?
-    keywords='adafruit tfmini benewake distance sensor hardware micropython circuitpython',
-
+    keywords="adafruit tfmini benewake distance sensor hardware micropython circuitpython",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    py_modules=['adafruit_tfmini'],
-)
+    py_modules=["adafruit_tfmini"],
+)