Merge pull request #5 from adafruit/pylint-update

Pylint update

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 pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

adafruit_jwt.py

@@ -62,6 +62,7 @@ class JWT:
     :param str algo: Encryption algorithm used for claims. Can be None.
 
     """
+
     @staticmethod
     def validate(jwt):
         """Validates a provided JWT. Does not support validating
@@ -117,13 +118,16 @@ def generate(claims, private_key_data=None, algo=None):
             return jwt
         if algo == "RS256":
             signature = STRING_TOOLS.urlsafe_b64encode(
-                sign(payload, priv_key, "SHA-256"))
+                sign(payload, priv_key, "SHA-256")
+            )
         elif algo == "RS384":
             signature = STRING_TOOLS.urlsafe_b64encode(
-                sign(payload, priv_key, "SHA-384"))
+                sign(payload, priv_key, "SHA-384")
+            )
         elif algo == "RS512":
             signature = STRING_TOOLS.urlsafe_b64encode(
-                sign(payload, priv_key, "SHA-512"))
+                sign(payload, priv_key, "SHA-512")
+            )
         else:
             raise TypeError(
                 "Adafruit_JWT is currently only compatible with algorithms within"
@@ -137,6 +141,7 @@ def generate(claims, private_key_data=None, algo=None):
 class STRING_TOOLS:
     """Tools and helpers for URL-safe string encoding.
     """
+
     # Some strings for ctype-style character classification
     whitespace = " \t\n\r\v\f"
     ascii_lowercase = "abcdefghijklmnopqrstuvwxyz"
@@ -156,8 +161,7 @@ def urlsafe_b64encode(payload):
         :param bytes payload: bytes-like object.
         """
         return STRING_TOOLS.translate(
-            b2a_base64(payload)[
-                :-1].decode("utf-8"), {ord("+"): "-", ord("/"): "_"}
+            b2a_base64(payload)[:-1].decode("utf-8"), {ord("+"): "-", ord("/"): "_"}
         )
 
     @staticmethod
@@ -176,8 +180,7 @@ def _bytes_from_decode_data(str_data):
             try:
                 return str_data.encode("ascii")
             except:
-                raise ValueError(
-                    "string argument should contain only ASCII characters")
+                raise ValueError("string argument should contain only ASCII characters")
         elif isinstance(str_data, bit_types):
             return str_data
         else:

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,32 @@
 autodoc_mock_imports = ["adafruit_rsa", "adafruit_binascii"]
 
 
-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 JWT Library'
-copyright = u'2019 Brent Rubell'
-author = u'Brent Rubell'
+project = "Adafruit JWT Library"
+copyright = "2019 Brent Rubell"
+author = "Brent Rubell"
 
 # 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 = 'AdafruitJwtLibrarydoc'
+htmlhelp_basename = "AdafruitJwtLibrarydoc"
 
 # -- 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, 'AdafruitJWTLibrary.tex', u'AdafruitJWT Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitJWTLibrary.tex",
+        "AdafruitJWT 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, 'AdafruitJWTlibrary', u'Adafruit JWT Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitJWTlibrary",
+        "Adafruit JWT 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, 'AdafruitJWTLibrary', u'Adafruit JWT Library Documentation',
-     author, 'AdafruitJWTLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitJWTLibrary",
+        "Adafruit JWT Library Documentation",
+        author,
+        "AdafruitJWTLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/jwt_simpletest.py

@@ -8,18 +8,14 @@
     raise
 
 # Sample JWT Claims
-claims = {"iss": "joe",
-          "exp": 1300819380,
-          "name": "John Doe",
-          "admin": True}
+claims = {"iss": "joe", "exp": 1300819380, "name": "John Doe", "admin": True}
 
 # Generate a JWT
 print("Generating JWT...")
-encoded_jwt = adafruit_jwt.JWT.generate(
-    claims, secrets["private_key"], algo="RS256")
+encoded_jwt = adafruit_jwt.JWT.generate(claims, secrets["private_key"], algo="RS256")
 print("Encoded JWT: ", encoded_jwt)
 
 # Validate a provided JWT
 print("Decoding JWT...")
 decoded_jwt = adafruit_jwt.JWT.validate(encoded_jwt)
-print('JOSE Header: {}\nJWT Claims: {}'.format(decoded_jwt[0], decoded_jwt[1]))
+print("JOSE Header: {}\nJWT Claims: {}".format(decoded_jwt[0], decoded_jwt[1]))

setup.py

@@ -6,58 +6,48 @@
 """
 
 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-jwt',
-
+    name="adafruit-circuitpython-jwt",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='JSON Web Token Authentication ',
+    setup_requires=["setuptools_scm"],
+    description="JSON Web Token Authentication ",
     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_JWT',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_JWT",
     # Author details
-    author='Adafruit Industries',
-    author_email='[email protected]',
-
-    install_requires=[
-        'Adafruit-Blinka'
-    ],
-
+    author="Adafruit Industries",
+    author_email="[email protected]",
+    install_requires=["Adafruit-Blinka"],
     # 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 blinka circuitpython micropython jwt jwt, json, token, authentication',
-
+    keywords="adafruit blinka circuitpython micropython jwt jwt, json, token, authentication",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
     #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=['adafruit_jwt'],
+    py_modules=["adafruit_jwt"],
 )