flask-openapi-swagger 5.31.0__tar.gz

flask_openapi_swagger-5.31.0/.gitignore

@@ -0,0 +1,141 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.idea

flask_openapi_swagger-5.31.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: flask-openapi-swagger
+Version: 5.31.0
+Summary: Provide Swagger UI for flask-openapi.
+Project-URL: Homepage, https://github.com/luolingchun/flask-openapi-plugins/tree/master/flask-openapi-swagger
+Project-URL: Documentation, https://luolingchun.github.io/flask-openapi/latest/Usage/UI_Templates/
+Maintainer-email: llc <luolingchun@outlook.com>
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Requires-Dist: flask-openapi
+Description-Content-Type: text/markdown
+
+Provide Swagger UI for [flask-openapi](https://github.com/luolingchun/flask-openapi).

flask_openapi_swagger-5.31.0/flask_openapi_swagger/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/22 16:07

flask_openapi_swagger-5.31.0/flask_openapi_swagger/__version__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+__version__ = "5.31.0"

flask_openapi_swagger-5.31.0/flask_openapi_swagger/plugins.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/22 16:13
+import os
+
+from flask import Blueprint, render_template_string, current_app
+from flask_openapi.plugins import BasePlugin
+
+from .templates import swagger_html_string, swagger_oauth2_redirect_html_string
+
+
+class RegisterPlugin(BasePlugin):
+    name = "swagger"
+    display_name = "Swagger"
+
+    @classmethod
+    def register(cls, doc_url: str) -> Blueprint:
+        _here = os.path.dirname(__file__)
+        template_folder = os.path.join(_here, "templates")
+        static_folder = os.path.join(template_folder, cls.name)
+        blueprint = Blueprint(
+            cls.name,
+            __name__,
+            template_folder=template_folder,
+            static_folder=static_folder
+        )
+
+        blueprint.add_url_rule(
+            rule=f"/{cls.name}",
+            endpoint=cls.name,
+            view_func=lambda: render_template_string(
+                current_app.config.get("SWAGGER_HTML_STRING") or swagger_html_string,
+                doc_url=doc_url,
+                swagger_config=current_app.config.get("SWAGGER_CONFIG"),
+                oauth_config=current_app.config.get("OAUTH_CONFIG")
+            )
+        )
+        blueprint.add_url_rule(
+            rule=f"/oauth2-redirect.html",
+            endpoint="oauth2-redirect",
+            view_func=lambda: render_template_string(
+                swagger_oauth2_redirect_html_string
+            )
+        )
+        return blueprint

flask_openapi_swagger-5.31.0/flask_openapi_swagger/templates/__init__.py

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/23 14:46
+swagger_html_string = """
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="shortcut icon" href="swagger/images/swagger.svg">
+    <link rel="stylesheet" type="text/css" href="swagger/css/swagger-ui.css">
+    <style>
+        html {
+            box-sizing: border-box;
+            overflow: -moz-scrollbars-vertical;
+            overflow-y: scroll;
+        }
+
+        *, *:before, *:after {
+            box-sizing: inherit;
+        }
+
+        body {
+            margin: 0;
+            background: #fafafa;
+        }
+    </style>
+</head>
+<body>
+<div id="swagger-ui"></div>
+<script src="swagger/js/swagger-ui-bundle.js"></script>
+<script src="swagger/js/swagger-ui-standalone-preset.js"></script>
+<script>
+    const swagger_config = JSON.parse(`{{ swagger_config|default('{}')|tojson }}`);
+    url = new URL("{{doc_url}}", window.location.href).href;
+    window.onload = function () {
+        // Begin Swagger UI call region
+        window.ui = SwaggerUIBundle({
+        ...{
+            url: url,
+            dom_id: "#swagger-ui",
+            deepLinking: true,
+            presets: [
+                SwaggerUIBundle.presets.apis,
+                SwaggerUIStandalonePreset
+            ],
+            plugins: [
+                SwaggerUIBundle.plugins.DownloadUrl
+            ],
+            layout: "StandaloneLayout",
+            showExtensions: true,
+            showCommonExtensions: true
+        },
+        ...swagger_config
+        })
+        // End Swagger UI call region
+        const oauthConfig = {{ oauth_config|tojson }};
+        if (oauthConfig != null) {
+            window.ui.initOAuth({
+                clientId: oauthConfig.clientId,
+                clientSecret: oauthConfig.clientSecret,
+                realm: oauthConfig.realm,
+                appName: oauthConfig.appName,
+                scopeSeparator: oauthConfig.scopeSeparator,
+                scopes: oauthConfig.scopes,
+                additionalQueryStringParams: oauthConfig.additionalQueryStringParams,
+                usePkceWithAuthorizationCodeGrant: oauthConfig.usePkceWithAuthorizationCodeGrant
+            })
+        }
+    }
+</script>
+</body>
+</html>
+"""
+swagger_oauth2_redirect_html_string = """
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>
+"""