Merge pull request #19 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

.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_onewire/bus.py

@@ -39,11 +39,12 @@
 _SKIP_ROM = const(0xCC)
 _MAX_DEV = const(10)
 
+
 class OneWireError(Exception):
     """A class to represent a 1-Wire exception."""
-    pass
 
-class OneWireAddress(object):
+
+class OneWireAddress:
     """A class to represent a 1-Wire address."""
 
     def __init__(self, rom):
@@ -69,7 +70,8 @@ def family_code(self):
         """The 8 bit family code."""
         return self._rom[0]
 
-class OneWireBus(object):
+
+class OneWireBus:
     """A class to represent a 1-Wire bus."""
 
     def __init__(self, pin):
@@ -90,7 +92,7 @@ def maximum_devices(self):
     def maximum_devices(self, count):
         if not isinstance(count, int):
             raise ValueError("Maximum must be an integer value 1 - 255.")
-        if count < 1 or count > 0xff:
+        if count < 1 or count > 0xFF:
             raise ValueError("Maximum must be an integer value 1 - 255.")
         self._maximum_devices = count
 
@@ -146,14 +148,16 @@ def scan(self):
         diff = 65
         rom = False
         count = 0
-        for _ in range(0xff):
+        for _ in range(0xFF):
             rom, diff = self._search_rom(rom, diff)
             if rom:
                 count += 1
                 if count > self.maximum_devices:
                     raise RuntimeError(
-                        "Maximum device count of {} exceeded."\
-                        .format(self.maximum_devices))
+                        "Maximum device count of {} exceeded.".format(
+                            self.maximum_devices
+                        )
+                    )
                 devices.append(OneWireAddress(rom))
             if diff == 0:
                 break
@@ -169,7 +173,6 @@ def _writebyte(self, value):
         for i in range(8):
             bit = (value >> i) & 0x1
             self._ow.write_bit(bit)
-        return
 
     def _search_rom(self, l_rom, diff):
         if not self.reset():
@@ -185,10 +188,10 @@ def _search_rom(self, l_rom, diff):
             for bit in range(8):
                 b = self._readbit()
                 if self._readbit():
-                    if b: # there are no devices or there is an error on the bus
+                    if b:  # there are no devices or there is an error on the bus
                         return None, 0
                 else:
-                    if not b: # collision, two devices with different bit meaning
+                    if not b:  # collision, two devices with different bit meaning
                         if diff > i or ((l_rom[byte] & (1 << bit)) and diff != i):
                             b = 1
                             next_diff = i

adafruit_onewire/device.py

@@ -31,9 +31,10 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_OneWire.git"
 
-_MATCH_ROM = b'\x55'
+_MATCH_ROM = b"\x55"
 
-class OneWireDevice(object):
+
+class OneWireDevice:
     """A class to represent a single device on the 1-Wire bus."""
 
     def __init__(self, bus, address):
@@ -63,7 +64,7 @@ def readinto(self, buf, *, start=0, end=None):
         self._bus.readinto(buf, start=start, end=end)
         if start == 0 and end is None and len(buf) >= 8:
             if self._bus.crc8(buf):
-                raise RuntimeError('CRC error.')
+                raise RuntimeError("CRC error.")
 
     def write(self, buf, *, start=0, end=None):
         """

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 = ["busio", "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)}
+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 OneWire Library'
-copyright = u'2017 Carter Nelson'
-author = u'Carter Nelson'
+project = u"Adafruit OneWire Library"
+copyright = u"2017 Carter Nelson"
+author = u"Carter Nelson"
 
 # 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 = 'AdafruitOnewireLibrarydoc'
+htmlhelp_basename = "AdafruitOnewireLibrarydoc"
 
 # -- 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, 'AdafruitOneWireLibrary.tex', u'AdafruitOneWire Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitOneWireLibrary.tex",
+        u"AdafruitOneWire 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, 'AdafruitOneWirelibrary', u'Adafruit OneWire Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitOneWirelibrary",
+        u"Adafruit OneWire 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, 'AdafruitOneWireLibrary', u'Adafruit OneWire Library Documentation',
-     author, 'AdafruitOneWireLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitOneWireLibrary",
+        u"Adafruit OneWire Library Documentation",
+        author,
+        "AdafruitOneWireLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/onewire_simpletest.py

@@ -7,24 +7,24 @@
 
 # Reset and check for presence pulse.
 # This is basically - "is there anything out there?"
-print("Resetting bus...", end='')
+print("Resetting bus...", end="")
 if ow_bus.reset():
     print("OK.")
 else:
     raise RuntimeError("Nothing found on bus.")
 
 # Run a scan to get all of the device ROM values
-print("Scanning for devices...", end='')
+print("Scanning for devices...", end="")
 devices = ow_bus.scan()
 print("OK.")
 print("Found {} device(s).".format(len(devices)))
 
 # For each device found, print out some info
 for i, d in enumerate(devices):
     print("Device {:>3}".format(i))
-    print("\tSerial Number = ", end='')
+    print("\tSerial Number = ", end="")
     for byte in d.serial_number:
-        print("0x{:02x} ".format(byte), end='')
+        print("0x{:02x} ".format(byte), end="")
     print("\n\tFamily = 0x{:02x}".format(d.family_code))
 
 # Usage beyond this is device specific. See a CircuitPython library for a 1-Wire