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

adafruit_tmp007.py

@@ -82,8 +82,6 @@ class TMP007:
     # thread safe!
     _BUFFER = bytearray(4)
 
-
-
     def __init__(self, i2c, address=_TMP007_I2CADDR, samplerate=CFG_16SAMPLE):
         """Initialize TMP007 device on the specified I2C address and bus number.
         Address defaults to 0x40 and bus number defaults to the appropriate bus
@@ -96,19 +94,26 @@ def __init__(self, i2c, address=_TMP007_I2CADDR, samplerate=CFG_16SAMPLE):
         """
         self._device = I2CDevice(i2c, address)
         self._write_u16(_TMP007_CONFIG, _TMP007_CFG_RESET)
-        time.sleep(.5)
-        if samplerate not in (CFG_1SAMPLE, CFG_2SAMPLE, CFG_4SAMPLE, CFG_8SAMPLE,
-                              CFG_16SAMPLE):
-            raise ValueError('Unexpected samplerate value! Must be one of: ' \
-                'CFG_1SAMPLE, CFG_2SAMPLE, CFG_4SAMPLE, CFG_8SAMPLE, or CFG_16SAMPLE')
+        time.sleep(0.5)
+        if samplerate not in (
+            CFG_1SAMPLE,
+            CFG_2SAMPLE,
+            CFG_4SAMPLE,
+            CFG_8SAMPLE,
+            CFG_16SAMPLE,
+        ):
+            raise ValueError(
+                "Unexpected samplerate value! Must be one of: "
+                "CFG_1SAMPLE, CFG_2SAMPLE, CFG_4SAMPLE, CFG_8SAMPLE, or CFG_16SAMPLE"
+            )
         # Set configuration register to turn on chip, enable data ready output,
         # and start sampling at the specified rate.
         config = _TMP007_CFG_MODEON | _TMP007_CFG_DRDYEN | samplerate
         self._write_u16(_TMP007_CONFIG, config)
         # Check device ID match expected value.
         dev_id = self.read_register(_TMP007_DEVID)
         if dev_id != 0x78:
-            raise RuntimeError('Init failed - Did not find TMP007')
+            raise RuntimeError("Init failed - Did not find TMP007")
 
     def sleep(self):
         """Put TMP007 into low power sleep mode.  No measurement data will be
@@ -131,7 +136,7 @@ def raw_voltage(self):
         """
         raw = self._read_u16(_TMP007_VOBJ)
         if raw > 32767:
-            raw = (raw & 0x7fff) - 32768
+            raw = (raw & 0x7FFF) - 32768
         return raw
 
     @property
@@ -154,28 +159,25 @@ def temperature(self):
         """
         raw = self._read_u16(_TMP007_TOBJ)
         if raw & 1:
-            return -9999.
+            return -9999.0
         raw = raw >> 2
         return raw * 0.03125
 
     def read_register(self, register):
         """Read sensor Register."""
-        return  self._read_u16(register)
-
+        return self._read_u16(register)
 
     def _read_u8(self, address):
         with self._device as i2c:
             self._BUFFER[0] = address & 0xFF
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER,
-                                    out_end=1, in_end=1)
+            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=1)
         return self._BUFFER[0]
 
     def _read_u16(self, address):
         with self._device as i2c:
             self._BUFFER[0] = address & 0xFF
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER,
-                                    out_end=1, in_end=2)
-        return self._BUFFER[0]<<8 | self._BUFFER[1]
+            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=2)
+        return self._BUFFER[0] << 8 | self._BUFFER[1]
 
     def _write_u8(self, address, val):
         with self._device as i2c:

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,36 @@
 # autodoc_mock_imports = ["micropython", "adafruit_bus_device"]
 
 
-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 TMP007 Library'
-copyright = u'2018 Jerry Needell'
-author = u'Jerry Needell'
+project = u"Adafruit TMP007 Library"
+copyright = u"2018 Jerry Needell"
+author = u"Jerry Needell"
 
 # 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 +65,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 +77,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 +92,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 = 'AdafruitTmp007Librarydoc'
+htmlhelp_basename = "AdafruitTmp007Librarydoc"
 
 # -- 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, 'AdafruitTMP007Library.tex', u'AdafruitTMP007 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitTMP007Library.tex",
+        u"AdafruitTMP007 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, 'AdafruitTMP007library', u'Adafruit TMP007 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitTMP007library",
+        u"Adafruit TMP007 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +170,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitTMP007Library', u'Adafruit TMP007 Library Documentation',
-     author, 'AdafruitTMP007Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitTMP007Library",
+        u"Adafruit TMP007 Library Documentation",
+        author,
+        "AdafruitTMP007Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/tmp007_simpletest.py

@@ -14,19 +14,21 @@ def c_to_f(c):
     return c * 9.0 / 5.0 + 32.0
 
 
-
 # Create library object using our Bus I2C port
 i2c = busio.I2C(board.SCL, board.SDA)
 sensor = adafruit_tmp007.TMP007(i2c)
 
 
-
 # Initialize communication with the sensor, using the default 16 samples per conversion.
 # This is the best accuracy but a little slower at reacting to changes.
 # The first sample will be meaningless
 while True:
     die_temp = sensor.die_temperature
-    print('   Die temperature: {0:0.3F}*C / {1:0.3F}*F'.format(die_temp, c_to_f(die_temp)))
+    print(
+        "   Die temperature: {0:0.3F}*C / {1:0.3F}*F".format(die_temp, c_to_f(die_temp))
+    )
     obj_temp = sensor.temperature
-    print('Object temperature: {0:0.3F}*C / {1:0.3F}*F'.format(obj_temp, c_to_f(obj_temp)))
+    print(
+        "Object temperature: {0:0.3F}*C / {1:0.3F}*F".format(obj_temp, c_to_f(obj_temp))
+    )
     time.sleep(5.0)