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

adafruit_logging.py

@@ -40,25 +40,28 @@
   https://github.com/adafruit/circuitpython/releases
 
 """
-#pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use
-#pylint:disable=invalid-name
+# pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use
+# pylint:disable=invalid-name
 
 import time
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git"
 
 
-LEVELS = [(00, 'NOTSET'),
-          (10, 'DEBUG'),
-          (20, 'INFO'),
-          (30, 'WARNING'),
-          (40, 'ERROR'),
-          (50, 'CRITICAL')]
+LEVELS = [
+    (00, "NOTSET"),
+    (10, "DEBUG"),
+    (20, "INFO"),
+    (30, "WARNING"),
+    (40, "ERROR"),
+    (50, "CRITICAL"),
+]
 
 for value, name in LEVELS:
     globals()[name] = value
 
+
 def level_for(value):
     """Convert a numberic level to the most appropriate name.
 
@@ -68,11 +71,12 @@ def level_for(value):
     for i in range(len(LEVELS)):
         if value == LEVELS[i][0]:
             return LEVELS[i][1]
-        elif value < LEVELS[i][0]:
-            return LEVELS[i-1][1]
+        if value < LEVELS[i][0]:
+            return LEVELS[i - 1][1]
     return LEVELS[0][1]
 
-class LoggingHandler(object):
+
+class LoggingHandler():
     """Abstract logging message handler."""
 
     def format(self, level, msg):
@@ -82,7 +86,7 @@ def format(self, level, msg):
         :param msg: the message to log
 
         """
-        return '{0}: {1} - {2}'.format(time.monotonic(), level_for(level), msg)
+        return "{0}: {1} - {2}".format(time.monotonic(), level_for(level), msg)
 
     def emit(self, level, msg):
         """Send a message where it should go.
@@ -105,10 +109,11 @@ def emit(self, level, msg):
 
 
 # The level module-global variables get created when loaded
-#pylint:disable=undefined-variable
+# pylint:disable=undefined-variable
 
 logger_cache = dict()
 
+
 def getLogger(name):
     """Create or retrieve a logger by name.
 
@@ -119,7 +124,8 @@ def getLogger(name):
         logger_cache[name] = Logger()
     return logger_cache[name]
 
-class Logger(object):
+
+class Logger():
     """Provide a logging api."""
 
     def __init__(self):

docs/conf.py

@@ -2,50 +2,54 @@
 
 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!
 # 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 = ["digitalio", "busio"]
+# autodoc_mock_imports = ["digitalio", "busio"]
 
 
-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 Logger Library'
-copyright = u'2019 Dave Astels'
-author = u'Dave Astels'
+project = "Adafruit Logger Library"
+copyright = "2019 Dave Astels"
+author = "Dave Astels"
 
 # 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 = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = "1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -57,7 +61,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 +73,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 +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 = 'AdafruitLoggerLibrarydoc'
+htmlhelp_basename = "AdafruitLoggerLibrarydoc"
 
 # -- 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, 'AdafruitLoggerLibrary.tex', u'AdafruitLogger Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitLoggerLibrary.tex",
+        "AdafruitLogger 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, 'AdafruitLoggerlibrary', u'Adafruit Logger Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitLoggerlibrary",
+        "Adafruit Logger Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +166,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitLoggerLibrary', u'Adafruit Logger Library Documentation',
-     author, 'AdafruitLoggerLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitLoggerLibrary",
+        "Adafruit Logger Library Documentation",
+        author,
+        "AdafruitLoggerLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/logging_simpletest.py

@@ -1,10 +1,10 @@
-#pylint:disable=undefined-variable,wildcard-import,no-name-in-module
-#pylint:disable=no-member
+# pylint:disable=undefined-variable,wildcard-import,no-name-in-module
+# pylint:disable=no-member
 
 import adafruit_logging as logging
 
-logger = logging.getLogger('test')
+logger = logging.getLogger("test")
 
 logger.setLevel(logging.ERROR)
-logger.info('Info message')
-logger.error('Error message')
+logger.info("Info message")
+logger.error("Error message")