Merge pull request #18 from adafruit/pylint-update

Ran black, updated to pylint 2.x

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

@@ -32,18 +32,19 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS18x20.git"
 
 import time
-from adafruit_onewire.device import OneWireDevice
 from micropython import const
+from adafruit_onewire.device import OneWireDevice
 
-_CONVERT = b'\x44'
-_RD_SCRATCH = b'\xBE'
-_WR_SCRATCH = b'\x4E'
+_CONVERT = b"\x44"
+_RD_SCRATCH = b"\xBE"
+_WR_SCRATCH = b"\x4E"
 _CONVERSION_TIMEOUT = const(1)
 RESOLUTION = (9, 10, 11, 12)
 # Maximum conversion delay in seconds, from DS18B20 datasheet.
-_CONVERSION_DELAY = {9:0.09375, 10:0.1875, 11:0.375, 12:0.750}
+_CONVERSION_DELAY = {9: 0.09375, 10: 0.1875, 11: 0.375, 12: 0.750}
 
-class DS18X20(object):
+
+class DS18X20:
     """Class which provides interface to DS18X20 temperature sensor."""
 
     def __init__(self, bus, address):
@@ -53,7 +54,7 @@ def __init__(self, bus, address):
             self._buf = bytearray(9)
             self._conv_delay = _CONVERSION_DELAY[12]  # pessimistic default
         else:
-            raise ValueError('Incorrect family code in device address.')
+            raise ValueError("Incorrect family code in device address.")
 
     @property
     def temperature(self):
@@ -69,10 +70,10 @@ def resolution(self):
     @resolution.setter
     def resolution(self, bits):
         if bits not in RESOLUTION:
-            raise ValueError('Incorrect resolution. Must be 9, 10, 11, or 12.')
+            raise ValueError("Incorrect resolution. Must be 9, 10, 11, or 12.")
         self._buf[0] = 0  # TH register
         self._buf[1] = 0  # TL register
-        self._buf[2] = RESOLUTION.index(bits) << 5 | 0x1F # configuration register
+        self._buf[2] = RESOLUTION.index(bits) << 5 | 0x1F  # configuration register
         self._write_scratch(self._buf)
 
     def _convert_temp(self, timeout=_CONVERSION_TIMEOUT):
@@ -84,7 +85,9 @@ def _convert_temp(self, timeout=_CONVERSION_TIMEOUT):
                 # 0 = conversion in progress, 1 = conversion done
                 while self._buf[0] == 0x00:
                     if time.monotonic() - start_time > timeout:
-                        raise RuntimeError('Timeout waiting for conversion to complete.')
+                        raise RuntimeError(
+                            "Timeout waiting for conversion to complete."
+                        )
                     dev.readinto(self._buf, end=1)
         return time.monotonic() - start_time
 
@@ -94,15 +97,14 @@ def _read_temp(self):
         if self._address.family_code == 0x10:
             if buf[1]:
                 t = buf[0] >> 1 | 0x80
-                t = -((~t + 1) & 0xff)
+                t = -((~t + 1) & 0xFF)
             else:
                 t = buf[0] >> 1
             return t - 0.25 + (buf[7] - buf[6]) / buf[7]
-        else:
-            t = buf[1] << 8 | buf[0]
-            if t & 0x8000: # sign bit set
-                t = -((t ^ 0xffff) + 1)
-            return t / 16
+        t = buf[1] << 8 | buf[0]
+        if t & 0x8000:  # sign bit set
+            t = -((t ^ 0xFFFF) + 1)
+        return t / 16
 
     def _read_scratch(self):
         with self._device as dev:

docs/conf.py

@@ -2,47 +2,51 @@
 
 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_onewire", "micropython", "time"]
 
-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 DS18X20 Library'
-copyright = u'2017 Carter Nelson'
-author = u'Carter Nelson'
+project = u"Adafruit DS18X20 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 +58,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 +70,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 +84,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 = 'AdafruitDs18x20Librarydoc'
+htmlhelp_basename = "AdafruitDs18x20Librarydoc"
 
 # -- 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, 'AdafruitDS18X20Library.tex', u'AdafruitDS18X20 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitDS18X20Library.tex",
+        u"AdafruitDS18X20 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, 'AdafruitDS18X20library', u'Adafruit DS18X20 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitDS18X20library",
+        u"Adafruit DS18X20 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -150,7 +162,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitDS18X20Library', u'Adafruit DS18X20 Library Documentation',
-     author, 'AdafruitDS18X20Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitDS18X20Library",
+        u"Adafruit DS18X20 Library Documentation",
+        author,
+        "AdafruitDS18X20Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/ds18x20_asynctest.py

@@ -27,5 +27,5 @@
     while time.monotonic() < conversion_ready_at:
         print(".", end="")
         time.sleep(0.1)
-    print('\nTemperature: {0:0.3f}C\n'.format(ds18.read_temperature()))
+    print("\nTemperature: {0:0.3f}C\n".format(ds18.read_temperature()))
     time.sleep(1.0)

examples/ds18x20_simpletest.py

@@ -17,5 +17,5 @@
 
 # Main loop to print the temperature every second.
 while True:
-    print('Temperature: {0:0.3f}C'.format(ds18.temperature))
+    print("Temperature: {0:0.3f}C".format(ds18.temperature))
     time.sleep(1.0)

setup.py

@@ -7,55 +7,47 @@
 
 # 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-ds18x20',
-
+    name="adafruit-circuitpython-ds18x20",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='CircuitPython driver for Dallas 1-Wire temperature sensor.',
+    setup_requires=["setuptools_scm"],
+    description="CircuitPython driver for Dallas 1-Wire temperature 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_DS18X20',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_DS18X20",
     # Author details
-    author='Adafruit Industries',
-    author_email='circuitpython@adafruit.com',
-
-    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-onewire'],
-
+    author="Adafruit Industries",
+    author_email="circuitpython@adafruit.com",
+    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-onewire"],
     # 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 1-wire temperature sensor ds18x20 '
-             'hardware breakout micropython circuitpython',
-
+    keywords="adafruit 1-wire temperature sensor ds18x20 "
+    "hardware breakout micropython circuitpython",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    py_modules=['adafruit_ds18x20'],
+    py_modules=["adafruit_ds18x20"],
 )