Merge pull request #15 from adafruit/pylint-update

Ran black, updated to pylint 2.x
adafruit · Mar 16, 2020 · eacd022 · eacd022
2 parents d29ac5b + c29d4e3
commit eacd022
Show file tree

Hide file tree

Showing 5 changed files with 150 additions and 129 deletions.
diff --git a/.github/workflows/build.yml b/.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

diff --git a/adafruit_tsl2591.py b/adafruit_tsl2591.py
@@ -51,49 +51,49 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TSL2591.git"
 
 
-#pylint: disable=bad-whitespace
+# pylint: disable=bad-whitespace
 # Internal constants:
-_TSL2591_ADDR                = const(0x29)
-_TSL2591_COMMAND_BIT         = const(0xA0)
-_TSL2591_ENABLE_POWEROFF     = const(0x00)
-_TSL2591_ENABLE_POWERON      = const(0x01)
-_TSL2591_ENABLE_AEN          = const(0x02)
-_TSL2591_ENABLE_AIEN         = const(0x10)
-_TSL2591_ENABLE_NPIEN        = const(0x80)
-_TSL2591_REGISTER_ENABLE     = const(0x00)
-_TSL2591_REGISTER_CONTROL    = const(0x01)
-_TSL2591_REGISTER_DEVICE_ID  = const(0x12)
-_TSL2591_REGISTER_CHAN0_LOW  = const(0x14)
-_TSL2591_REGISTER_CHAN1_LOW  = const(0x16)
-_TSL2591_LUX_DF              = 408.0
-_TSL2591_LUX_COEFB           = 1.64
-_TSL2591_LUX_COEFC           = 0.59
-_TSL2591_LUX_COEFD           = 0.86
-_TSL2591_MAX_COUNT_100MS     = const(36863) # 0x8FFF
-_TSL2591_MAX_COUNT           = const(65535) # 0xFFFF
+_TSL2591_ADDR = const(0x29)
+_TSL2591_COMMAND_BIT = const(0xA0)
+_TSL2591_ENABLE_POWEROFF = const(0x00)
+_TSL2591_ENABLE_POWERON = const(0x01)
+_TSL2591_ENABLE_AEN = const(0x02)
+_TSL2591_ENABLE_AIEN = const(0x10)
+_TSL2591_ENABLE_NPIEN = const(0x80)
+_TSL2591_REGISTER_ENABLE = const(0x00)
+_TSL2591_REGISTER_CONTROL = const(0x01)
+_TSL2591_REGISTER_DEVICE_ID = const(0x12)
+_TSL2591_REGISTER_CHAN0_LOW = const(0x14)
+_TSL2591_REGISTER_CHAN1_LOW = const(0x16)
+_TSL2591_LUX_DF = 408.0
+_TSL2591_LUX_COEFB = 1.64
+_TSL2591_LUX_COEFC = 0.59
+_TSL2591_LUX_COEFD = 0.86
+_TSL2591_MAX_COUNT_100MS = const(36863)  # 0x8FFF
+_TSL2591_MAX_COUNT = const(65535)  # 0xFFFF
 
 # User-facing constants:
-GAIN_LOW                  = 0x00  # low gain (1x)
+GAIN_LOW = 0x00  # low gain (1x)
 """Low gain (1x)"""
-GAIN_MED                  = 0x10  # medium gain (25x)
+GAIN_MED = 0x10  # medium gain (25x)
 """Medium gain (25x)"""
-GAIN_HIGH                 = 0x20  # medium gain (428x)
+GAIN_HIGH = 0x20  # medium gain (428x)
 """High gain (428x)"""
-GAIN_MAX                  = 0x30  # max gain (9876x)
+GAIN_MAX = 0x30  # max gain (9876x)
 """Max gain (9876x)"""
-INTEGRATIONTIME_100MS     = 0x00  # 100 millis
+INTEGRATIONTIME_100MS = 0x00  # 100 millis
 """100 millis"""
-INTEGRATIONTIME_200MS     = 0x01  # 200 millis
+INTEGRATIONTIME_200MS = 0x01  # 200 millis
 """200 millis"""
-INTEGRATIONTIME_300MS     = 0x02  # 300 millis
+INTEGRATIONTIME_300MS = 0x02  # 300 millis
 """300 millis"""
-INTEGRATIONTIME_400MS     = 0x03  # 400 millis
+INTEGRATIONTIME_400MS = 0x03  # 400 millis
 """400 millis"""
-INTEGRATIONTIME_500MS     = 0x04  # 500 millis
+INTEGRATIONTIME_500MS = 0x04  # 500 millis
 """500 millis"""
-INTEGRATIONTIME_600MS     = 0x05  # 600 millis
+INTEGRATIONTIME_600MS = 0x05  # 600 millis
 """600 millis"""
-#pylint: enable=bad-whitespace
+# pylint: enable=bad-whitespace
 
 
 class TSL2591:
@@ -113,7 +113,7 @@ def __init__(self, i2c, address=_TSL2591_ADDR):
         self._device = i2c_device.I2CDevice(i2c, address)
         # Verify the chip ID.
         if self._read_u8(_TSL2591_REGISTER_DEVICE_ID) != 0x50:
-            raise RuntimeError('Failed to find TSL2591, check wiring!')
+            raise RuntimeError("Failed to find TSL2591, check wiring!")
         # Set default gain and integration times.
         self.gain = GAIN_MED
         self.integration_time = INTEGRATIONTIME_100MS
@@ -130,7 +130,7 @@ def _read_u8(self, address):
 
     # Disable invalid name check since pylint isn't smart enough to know LE
     # is an abbreviation for little-endian.
-    #pylint: disable=invalid-name
+    # pylint: disable=invalid-name
     def _read_u16LE(self, address):
         # Read a 16-bit little-endian unsigned value from the specified 8-bit
         # address.
@@ -139,7 +139,8 @@ def _read_u16LE(self, address):
             self._BUFFER[0] = (_TSL2591_COMMAND_BIT | address) & 0xFF
             i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=2)
         return (self._BUFFER[1] << 8) | self._BUFFER[0]
-    #pylint: enable=invalid-name
+
+    # pylint: enable=invalid-name
 
     def _write_u8(self, address, val):
         # Write an 8-bit unsigned value to the specified 8-bit address.
@@ -151,9 +152,13 @@ def _write_u8(self, address, val):
 
     def enable(self):
         """Put the device in a fully powered enabled mode."""
-        self._write_u8(_TSL2591_REGISTER_ENABLE, _TSL2591_ENABLE_POWERON | \
-                       _TSL2591_ENABLE_AEN | _TSL2591_ENABLE_AIEN | \
-                       _TSL2591_ENABLE_NPIEN)
+        self._write_u8(
+            _TSL2591_REGISTER_ENABLE,
+            _TSL2591_ENABLE_POWERON
+            | _TSL2591_ENABLE_AEN
+            | _TSL2591_ENABLE_AIEN
+            | _TSL2591_ENABLE_NPIEN,
+        )
 
     def disable(self):
         """Disable the device and go into low power mode."""
@@ -260,7 +265,7 @@ def lux(self):
 
         # Handle overflow.
         if channel_0 >= max_counts or channel_1 >= max_counts:
-            raise RuntimeError('Overflow reading light channels!')
+            raise RuntimeError("Overflow reading light channels!")
         # Calculate lux using same equation as Arduino library:
         #  https://github.com/adafruit/Adafruit_TSL2591_Library/blob/master/Adafruit_TSL2591.cpp
         again = 1.0
@@ -272,5 +277,7 @@ def lux(self):
             again = 9876.0
         cpl = (atime * again) / _TSL2591_LUX_DF
         lux1 = (channel_0 - (_TSL2591_LUX_COEFB * channel_1)) / cpl
-        lux2 = ((_TSL2591_LUX_COEFC * channel_0) - (_TSL2591_LUX_COEFD * channel_1)) / cpl
+        lux2 = (
+            (_TSL2591_LUX_COEFC * channel_0) - (_TSL2591_LUX_COEFD * channel_1)
+        ) / cpl
         return max(lux1, lux2)
diff --git a/docs/conf.py b/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 = ["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 TSL2591 Library'
-copyright = u'2017 Tony DiCola'
-author = u'Tony DiCola'
+project = u"Adafruit TSL2591 Library"
+copyright = u"2017 Tony DiCola"
+author = u"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 = 'AdafruitTsl2591Librarydoc'
+htmlhelp_basename = "AdafruitTsl2591Librarydoc"
 
 # -- 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, 'AdafruitTSL2591Library.tex', u'AdafruitTSL2591 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitTSL2591Library.tex",
+        u"AdafruitTSL2591 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, 'AdafruitTSL2591library', u'Adafruit TSL2591 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitTSL2591library",
+        u"Adafruit TSL2591 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, 'AdafruitTSL2591Library', u'Adafruit TSL2591 Library Documentation',
-     author, 'AdafruitTSL2591Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitTSL2591Library",
+        u"Adafruit TSL2591 Library Documentation",
+        author,
+        "AdafruitTSL2591Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]