linting

Author: alexcjohnson

dash_enterprise_auth/__init__.py

@@ -1,22 +1,22 @@
 """
-dash-enterprise auth
+dash-enterprise-auth
 
-Methods to integrate dash apps with the authentication from the
-dash-deployment-server.
+Methods to integrate dash apps with the authentication from Dash Enterprise.
 """
-from .version import __version__
 import datetime as _dt
 import os as _os
 import platform as _platform
 import base64 as _b64
 import functools as _ft
 import json as _json
-import jwt as _jwt
 import urllib as _urllib
 from typing import Any
 
+import flask as _flask
+import jwt as _jwt
 import requests as _requests
 
+
 import dash as _dash
 if hasattr(_dash, "dcc"):
     _dcc = _dash.dcc
@@ -27,31 +27,37 @@
 else:
     import dash_html_components as _html
 
-import flask as _flask
+from .version import __version__
 
-ua_string = 'Plotly/%s (Language=Python/%s; Platform=%s/%s)' % (__version__, _platform.python_version(), _platform.system(), _platform.release())
+ua_string = (
+    f"Plotly/{__version__} (Language=Python/{_platform.python_version()};"
+    f" Platform={_platform.system()}/{_platform.release()})"
+)
 
 
 class UaPyJWKClient(_jwt.PyJWKClient):
     def fetch_data(self) -> Any:
-        with _urllib.request.urlopen(_urllib.request.Request(self.uri, headers={'User-Agent': ua_string})) as response:
+        with _urllib.request.urlopen(
+            _urllib.request.Request(self.uri, headers={"User-Agent": ua_string})
+        ) as response:
             return _json.load(response)
 
 
 def _need_request_context(func):
     @_ft.wraps(func)
     def _wrap(*args, **kwargs):
         if not _flask.has_request_context():
-            raise RuntimeError('`{0}` method needs a flask/dash request'
-                               ' context to run. Make sure to run '
-                               '`{0}` from a callback.'.format(func.__name__))
+            raise RuntimeError(
+                f"`{func.__name__}` method needs a flask/dash request"
+                f" context to run. Make sure to run `{func.__name__}` from a callback."
+            )
         return func(*args, **kwargs)
     return _wrap
 
 
-def create_logout_button(label='Logout', style=None):
+def create_logout_button(label="Logout", style=None):
     """
-    Create a dcc.LogoutButton with the dash-deployment-server logout url set
+    Create a dcc.LogoutButton with the Dash Enterprise logout url set
     in the environment.
 
     :param label: Text of the logout button.
@@ -60,31 +66,31 @@ def create_logout_button(label='Logout', style=None):
     :type style: dict
     :return:
     """
-    logout_url = _os.getenv('DASH_LOGOUT_URL')
+    logout_url = _os.getenv("DASH_LOGOUT_URL")
     if not logout_url:
-        raise Exception(
-            'DASH_LOGOUT_URL was not set in the environment.'
+        raise RuntimeError(
+            "DASH_LOGOUT_URL was not set in the environment."
         )
 
-    if not _os.getenv('DASH_JWKS_URL'):
+    if not _os.getenv("DASH_JWKS_URL"):
         return _dcc.LogoutButton(
             logout_url=logout_url,
             label=label,
             style=style,
         )
 
-    btn_style = {'display': 'inline-block'}
+    btn_style = {"display": "inline-block"}
     if style:
         btn_style.update(style)
 
     return _html.Div(
         _html.A(
             label,
             href=logout_url,
-            className='dash-logout-btn',
-            style={'textDecoration': 'none'}
+            className="dash-logout-btn",
+            style={"textDecoration": "none"}
         ),
-        className='dash-logout-frame',
+        className="dash-logout-frame",
         style=btn_style
     )
 
@@ -96,40 +102,41 @@ def _get_decoded_token(name):
 
 @_need_request_context
 def get_user_data():
-    jwks_url = _os.getenv('DASH_JWKS_URL')
-    info_url = _os.getenv('DASH_USER_INFO_URL')
+    jwks_url = _os.getenv("DASH_JWKS_URL")
+    info_url = _os.getenv("DASH_USER_INFO_URL")
     if not jwks_url:
-        return _json.loads(_flask.request.headers.get('Plotly-User-Data', "{}"))
+        return _json.loads(_flask.request.headers.get("Plotly-User-Data", "{}"))
     try:
         jwks_client = UaPyJWKClient(jwks_url)
 
-        token = _get_decoded_token('kcIdToken')
+        token = _get_decoded_token("kcIdToken")
         signing_key = jwks_client.get_signing_key_from_jwt(token)
 
         info = _jwt.decode(
             token,
             signing_key.key,
-            algorithms=[signing_key._jwk_data.get('alg', 'RSA256')],
-            audience=_os.getenv('DASH_AUD', "dash"),
-            options={'verify_exp': True},
+            algorithms=[signing_key._jwk_data.get("alg", "RSA256")],
+            audience=_os.getenv("DASH_AUD", "dash"),
+            options={"verify_exp": True},
         )
         if info_url:
-            tok = _get_decoded_token('kcToken')
-            authorization = f'Bearer {tok.decode()}'
+            tok = _get_decoded_token("kcToken")
+            authorization = f"Bearer {tok.decode()}"
             response = _requests.get(
                 info_url,
                 headers={
-                    'User-Agent': ua_string,
-                    'Authorization': authorization,
-                }
+                    "User-Agent": ua_string,
+                    "Authorization": authorization,
+                },
+                timeout=10,
             )
             response.raise_for_status()
             data = response.json()
             info.update(data)
 
         return info
     except Exception as e:
-        print('JWT decode error: ' + repr(e))
+        print("JWT decode error: " + repr(e))
     return {}
 
 
@@ -142,9 +149,9 @@ def get_username():
     :rtype: str
     """
     data = get_user_data()
-    if not _os.getenv('DASH_JWKS_URL'):
-        return data.get('username')
-    return data.get('preferred_username')
+    if not _os.getenv("DASH_JWKS_URL"):
+        return data.get("username")
+    return data.get("preferred_username")
 
 
 @_need_request_context
@@ -156,9 +163,9 @@ def get_kerberos_ticket_cache():
     """
     data = get_user_data()
 
-    expiry_str = data['kerberos_ticket_expiry']
-    expiry = _dt.datetime.strptime(expiry_str, '%Y-%m-%dT%H:%M:%SZ')
+    expiry_str = data["kerberos_ticket_expiry"]
+    expiry = _dt.datetime.strptime(expiry_str, "%Y-%m-%dT%H:%M:%SZ")
     if expiry < _dt.datetime.utcnow():
-        raise Exception('Kerberos ticket has expired.')
+        raise Exception("Kerberos ticket has expired.")
 
-    return _b64.b64decode(data['kerberos_ticket_cache'])
+    return _b64.b64decode(data["kerberos_ticket_cache"])

setup.py

@@ -1,14 +1,17 @@
-import io
 from setuptools import setup
 
 main_ns = {}
-exec(open("dash_enterprise_auth/version.py").read(), main_ns)  # pylint: disable=exec-used
+with open("dash_enterprise_auth/version.py", encoding="utf-8") as f:
+    exec(f.read(), main_ns)  # pylint: disable=exec-used
+
+with open("README.md", encoding="utf-8") as f:
+    long_description = f.read()
 
 setup(
     name="dash_enterprise_auth",
     version=main_ns["__version__"],
     description="Authentication integrations for apps using Dash Enterprise",
-    long_description=io.open("README.md", encoding="utf-8").read(),
+    long_description=long_description,
     long_description_content_type="text/markdown",
     keywords="dash dash-enterprise dash-auth plotly",
     author="Antoine Roy-Gobeil",
@@ -28,6 +31,7 @@
     url="https://plotly.com/dash",
     classifiers=[
         "License :: OSI Approved :: MIT License",
+        "Framework :: Dash",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",

tests/test_dash_enterprise_auth.py

@@ -1,10 +1,9 @@
 import base64
+import time
 
 import pytest
 import flask
 import jwt
-import time
-from jwt import PyJWK
 
 from dash import html, dcc
 
@@ -19,6 +18,7 @@
 AUD = "dash-aud"
 LOGOUT_URL = 'https://logout.e.com'
 
+
 def create_mock_getter(env):
     def get(key, default=None):
         return env.get(key, default)
@@ -41,7 +41,7 @@ def test_get_username(mocker, environ, headers, cookies):
     mocker.patch("os.getenv", create_mock_getter(environ))
     mocker.patch(
         "dash_enterprise_auth.UaPyJWKClient.get_signing_key_from_jwt",
-        return_value=PyJWK(key_data)
+        return_value=jwt.PyJWK(key_data)
     )
     with flask.Flask(__name__).test_request_context():
         mocker.patch("flask.has_request_context", return_value=True)