Merge pull request #25 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_amg88xx.py

@@ -54,48 +54,51 @@
 # Operating Modes
 # pylint: disable=bad-whitespace
 _NORMAL_MODE = const(0x00)
-_SLEEP_MODE  = const(0x10)
+_SLEEP_MODE = const(0x10)
 _STAND_BY_60 = const(0x20)
 _STAND_BY_10 = const(0x21)
 
 # sw resets
-_FLAG_RESET    = const(0x30)
+_FLAG_RESET = const(0x30)
 _INITIAL_RESET = const(0x3F)
 
 # frame rates
 _FPS_10 = const(0x00)
-_FPS_1  = const(0x01)
+_FPS_1 = const(0x01)
 
 # int enables
 _INT_DISABLED = const(0x00)
-_INT_ENABLED  = const(0x01)
+_INT_ENABLED = const(0x01)
 
 # int modes
-_DIFFERENCE     = const(0x00)
+_DIFFERENCE = const(0x00)
 _ABSOLUTE_VALUE = const(0x01)
 
-_INT_OFFSET   = const(0x010)
+_INT_OFFSET = const(0x010)
 _PIXEL_OFFSET = const(0x80)
 
 _PIXEL_ARRAY_WIDTH = const(8)
 _PIXEL_ARRAY_HEIGHT = const(8)
-_PIXEL_TEMP_CONVERSION = .25
-_THERMISTOR_CONVERSION = .0625
+_PIXEL_TEMP_CONVERSION = 0.25
+_THERMISTOR_CONVERSION = 0.0625
 # pylint: enable=bad-whitespace
 
+
 def _signed_12bit_to_float(val):
-    #take first 11 bits as absolute val
-    abs_val = (val & 0x7FF)
+    # take first 11 bits as absolute val
+    abs_val = val & 0x7FF
     if val & 0x800:
         return 0 - float(abs_val)
     return float(abs_val)
 
+
 def _twos_comp_to_float(val):
-    val &= 0xfff
+    val &= 0xFFF
     if val & 0x800:
         val -= 0x1000
     return float(val)
 
+
 class AMG88XX:
     """Driver for the AMG88xx GRID-Eye IR 8x8 thermal camera."""
 
@@ -130,16 +133,16 @@ class AMG88XX:
     def __init__(self, i2c, addr=0x69):
         self.i2c_device = I2CDevice(i2c, addr)
 
-        #enter normal mode
+        # enter normal mode
         self._pctl = _NORMAL_MODE
 
-        #software reset
+        # software reset
         self._rst = _INITIAL_RESET
 
-        #disable interrupts by default
+        # disable interrupts by default
         self._inten = False
 
-        #set to 10 FPS
+        # set to 10 FPS
         self._fps = _FPS_10
 
     @property
@@ -155,7 +158,7 @@ def pixels(self):
            Temperatures are stored in a two dimensional list where the first index is the row and
            the second is the column. The first row is on the side closest to the writing on the
            sensor."""
-        retbuf = [[0]*_PIXEL_ARRAY_WIDTH for _ in range(_PIXEL_ARRAY_HEIGHT)]
+        retbuf = [[0] * _PIXEL_ARRAY_WIDTH for _ in range(_PIXEL_ARRAY_HEIGHT)]
         buf = bytearray(3)
 
         with self.i2c_device as i2c:

docs/conf.py

@@ -18,7 +18,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,9 +31,9 @@
 # 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
@@ -41,34 +42,34 @@
 # autodoc_mock_imports = ["adafruit_bus_device", "micropython", "adafruit_register"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit AMG88xx Library'
-copyright = u'2017, Dean Miller for Adafruit Industries'
-author = u'Dean Miller'
+project = u"Adafruit AMG88xx Library"
+copyright = u"2017, Dean Miller for Adafruit Industries"
+author = u"Dean Miller"
 
 # 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.
@@ -89,7 +90,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.
@@ -111,7 +112,7 @@
 # show_authors = False
 
 # 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
@@ -134,18 +135,19 @@
 # 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 = ["."]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -179,7 +181,7 @@
 # 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"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -259,34 +261,36 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitAMG88xxLibrarydoc'
+htmlhelp_basename = "AdafruitAMG88xxLibrarydoc"
 
 # -- 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, 'AdafruitAMG88xxLibrary.tex', u'Adafruit AMG88xx Library Documentation',
-     u'Dean Miller', 'manual'),
+    (
+        master_doc,
+        "AdafruitAMG88xxLibrary.tex",
+        u"Adafruit AMG88xx Library Documentation",
+        u"Dean Miller",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -327,8 +331,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'adafruitAMG88xxLibrary', u'Adafruit AMG88xx Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "adafruitAMG88xxLibrary",
+        u"Adafruit AMG88xx Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
@@ -342,9 +351,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitAMG88xxLibrary', u'Adafruit AMG88xx Library Documentation',
-     author, 'AdafruitAMG88xxLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitAMG88xxLibrary",
+        u"Adafruit AMG88xx Library Documentation",
+        author,
+        "AdafruitAMG88xxLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -363,5 +378,7 @@
 #
 # texinfo_no_detailmenu = False
 
-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),
+}