Black

mongkok · mongkok · commit 60bcbabbd688 · 2021-08-11T04:56:20.000+07:00
diff --git a/docs/authentication.rst b/docs/authentication.rst
@@ -12,7 +12,7 @@ Authentication
         def resolve_viewer(self, info, **kwargs):
             user = info.context.user
             if not user.is_authenticated:
-                raise Exception('Authentication credentials were not provided')
+                raise Exception("Authentication credentials were not provided")
             return user
 
 
@@ -43,11 +43,11 @@ When a token is requested and ``jwt_cookie`` decorator is set, the response will
     from graphql_jwt.decorators import jwt_cookie
 
     urlpatterns = [
-        path('graphql/', jwt_cookie(GraphQLView.as_view())),
+        path("graphql/", jwt_cookie(GraphQLView.as_view())),
     ]
 
 
-If the ``jwt_cookie`` decorator is set, consider adding `CSRF middleware <https://docs.djangoproject.com/es/2.1/ref/csrf/>`_ ``'django.middleware.csrf.CsrfViewMiddleware'`` to provide protection against `Cross Site Request Forgeries <https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)>`_.
+If the ``jwt_cookie`` decorator is set, consider adding `CSRF middleware <https://docs.djangoproject.com/es/2.1/ref/csrf/>`_ ``"django.middleware.csrf.CsrfViewMiddleware"`` to provide protection against `Cross Site Request Forgeries <https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)>`_.
 
 A cookie-based authentication does not require sending the tokens as a mutation input argument.
 
@@ -107,7 +107,7 @@ Enable the argument authentication in your settings:
 ::
 
     GRAPHQL_JWT = {
-        'JWT_ALLOW_ARGUMENT': True,
+        "JWT_ALLOW_ARGUMENT": True,
     }
 
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,19 +24,19 @@
 sys.path.insert(0, str(ROOT_DIR))
 sys.path.insert(0, str(ROOT_DIR.parent))
 
-os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
+os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings"
 django.setup()
 
 import graphql_jwt  # NOQA E402
 
 # -- Project information -----------------------------------------------------
 
-project = 'Django GraphQL JWT'
-author = 'mongkok'
+project = "Django GraphQL JWT"
+author = "mongkok"
 
-copyright = '{year}, {author}'.format(
-    year=datetime.datetime.today().year,
-    author=author)
+copyright = "{year}, {author}".format(
+    year=datetime.datetime.today().year, author=author
+)
 
 # The short X.Y version
 version = graphql_jwt.__version__
@@ -54,24 +54,24 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
 ]
 
 # 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 master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -83,42 +83,42 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', '.DS_Store']
+exclude_patterns = ["_build", ".DS_Store"]
 
 # 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 = True
 
 
 # Sphinx setup
 def setup(app):
-    app.add_stylesheet('style.css')
+    app.add_stylesheet("style.css")
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # 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
 # documentation.
 #
 html_theme_options = {
-    'logo': 'logo.png',
-    'show_powered_by': False,
-    'fixed_sidebar': True,
-    'github_user': 'flavors',
-    'github_repo': 'django-graphql-jwt',
-    'github_banner': True,
-    'github_button': True,
-    'github_type': 'star',
-    'sidebar_list': '#e535ab',
-    'description': 'JSON Web Token (JWT) authentication for Graphene Django',
+    "logo": "logo.png",
+    "show_powered_by": False,
+    "fixed_sidebar": True,
+    "github_user": "flavors",
+    "github_repo": "django-graphql-jwt",
+    "github_banner": True,
+    "github_button": True,
+    "github_type": "star",
+    "sidebar_list": "#e535ab",
+    "description": "JSON Web Token (JWT) authentication for Graphene Django",
 }
 
 
@@ -130,13 +130,13 @@ def setup(app):
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = 'favicon.ico'
+html_favicon = "favicon.ico"
 
 
 # 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"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -147,11 +147,11 @@ def setup(app):
 # 'searchbox.html']``.
 #
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',
-        'searchbox.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",
+        "searchbox.html",
     ],
 }
 
@@ -168,7 +168,7 @@ def setup(app):
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'DjangoGraphQLJWTdoc'
+htmlhelp_basename = "DjangoGraphQLJWTdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -177,15 +177,12 @@ def setup(app):
     # 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',
@@ -195,8 +192,13 @@ def setup(app):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'DjangoGraphQLJWT.tex', 'Django GraphQL JWT Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "DjangoGraphQLJWT.tex",
+        "Django GraphQL JWT Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 
@@ -205,8 +207,7 @@ def setup(app):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'django-graphql-jwt', 'Django GraphQL JWT Documentation',
-     [author], 1),
+    (master_doc, "django-graphql-jwt", "Django GraphQL JWT Documentation", [author], 1),
 ]
 
 
@@ -216,9 +217,15 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Django-GraphQLJWT', 'Django GraphQL JWT Documentation',
-     author, 'DjangoGraphQLJWT', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "Django-GraphQLJWT",
+        "Django GraphQL JWT Documentation",
+        author,
+        "DjangoGraphQLJWT",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -237,4 +244,4 @@ def setup(app):
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
diff --git a/docs/decorators.rst b/docs/decorators.rst
@@ -39,7 +39,7 @@ As a shortcut, you can use the convenient ``user_passes_test()`` decorator which
     class Query(graphene.ObjectType):
         users = graphene.List(UserType)
 
-        @user_passes_test(lambda user: user.email.contains('@staff'))
+        @user_passes_test(lambda user: user.email.contains("@staff"))
         def resolve_users(self, info, **kwargs):
             return get_user_model().objects.all()
 
@@ -68,7 +68,7 @@ The decorator may also take an iterable of permissions, in which case the user m
             user_id = graphene.Int()
 
         @classmethod
-        @permission_required('auth.change_user')
+        @permission_required("auth.change_user")
         def mutate(cls, root, info, user_id):
             ...
 
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -21,24 +21,24 @@ Add ``AuthenticationMiddleware`` middleware to your *MIDDLEWARE* settings:
 
     MIDDLEWARE = [
         ...
-        'django.contrib.auth.middleware.AuthenticationMiddleware',
+        "django.contrib.auth.middleware.AuthenticationMiddleware",
         ...
     ]
 
 Add ``JSONWebTokenMiddleware`` middleware to your *GRAPHENE* settings::
 
     GRAPHENE = {
-        'SCHEMA': 'mysite.myschema.schema',
-        'MIDDLEWARE': [
-            'graphql_jwt.middleware.JSONWebTokenMiddleware',
+        "SCHEMA": "mysite.myschema.schema",
+        "MIDDLEWARE": [
+            "graphql_jwt.middleware.JSONWebTokenMiddleware",
         ],
     }
 
 Add ``JSONWebTokenBackend`` backend to your *AUTHENTICATION_BACKENDS*::
 
     AUTHENTICATION_BACKENDS = [
-        'graphql_jwt.backends.JSONWebTokenBackend',
-        'django.contrib.auth.backends.ModelBackend',
+        "graphql_jwt.backends.JSONWebTokenBackend",
+        "django.contrib.auth.backends.ModelBackend",
     ]
 
 
diff --git a/docs/refresh_token.rst b/docs/refresh_token.rst
@@ -15,9 +15,9 @@ Settings
 ::
 
     GRAPHQL_JWT = {
-        'JWT_VERIFY_EXPIRATION': True,
-        'JWT_EXPIRATION_DELTA': timedelta(minutes=5),
-        'JWT_REFRESH_EXPIRATION_DELTA': timedelta(days=7),
+        "JWT_VERIFY_EXPIRATION": True,
+        "JWT_EXPIRATION_DELTA": timedelta(minutes=5),
+        "JWT_REFRESH_EXPIRATION_DELTA": timedelta(days=7),
     }
 
 It means that you need to refresh every 5 mins (``payload.exp``) and even you keep on refreshing token every 5 mins, you will still be logout in 7 days after the first token has been issued (``refreshExpiresIn``).
@@ -78,7 +78,7 @@ Add ``graphql_jwt.refresh_token`` to your *INSTALLED\_APPS*::
 
     INSTALLED_APPS = [
         ...
-        'graphql_jwt.refresh_token.apps.RefreshTokenConfig',
+        "graphql_jwt.refresh_token.apps.RefreshTokenConfig",
         ...
     ]
 
@@ -88,10 +88,10 @@ Settings
 ::
 
     GRAPHQL_JWT = {
-        'JWT_VERIFY_EXPIRATION': True,
-        'JWT_LONG_RUNNING_REFRESH_TOKEN': True,
-        'JWT_EXPIRATION_DELTA': timedelta(minutes=5),
-        'JWT_REFRESH_EXPIRATION_DELTA': timedelta(days=7),
+        "JWT_VERIFY_EXPIRATION": True,
+        "JWT_LONG_RUNNING_REFRESH_TOKEN": True,
+        "JWT_EXPIRATION_DELTA": timedelta(minutes=5),
+        "JWT_REFRESH_EXPIRATION_DELTA": timedelta(days=7),
     }
 
 It means that you need to refresh every 5 mins (``payload.exp``) and you need to replace your refresh token in 7 days after it has been issued (``refreshExpiresIn``).
@@ -166,9 +166,9 @@ Unlimited refresh
 Configure the ``JWT_REFRESH_EXPIRED_HANDLER`` setting that checks if the refresh token is expired::
 
     GRAPHQL_JWT = {
-        'JWT_VERIFY_EXPIRATION': True,
-        'JWT_LONG_RUNNING_REFRESH_TOKEN': True,
-        'JWT_REFRESH_EXPIRED_HANDLER': lambda orig_iat, context: False,
+        "JWT_VERIFY_EXPIRATION": True,
+        "JWT_LONG_RUNNING_REFRESH_TOKEN": True,
+        "JWT_REFRESH_EXPIRED_HANDLER": lambda orig_iat, context: False,
     }
 
 One time only use refresh token
diff --git a/docs/settings.rst b/docs/settings.rst
diff --git a/docs/tests.rst b/docs/tests.rst
