cadwyn 3.14.0__tar.gz → 3.15.1__tar.gz

{cadwyn-3.14.0 → cadwyn-3.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 3.14.0
+Version: 3.15.1
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
@@ -54,8 +54,8 @@ Production-ready community-driven modern [Stripe-like](https://stripe.com/blog/a
 <a href="https://github.com/zmievsa/cadwyn/actions/workflows/ci.yaml?branch=main&event=push" target="_blank">
     <img src="https://github.com/zmievsa/cadwyn/actions/workflows/ci.yaml/badge.svg?branch=main&event=push" alt="Test">
 </a>
-<a href="https://codecov.io/gh/ovsyanka83/cadwyn" target="_blank">
-    <img src="https://img.shields.io/codecov/c/github/ovsyanka83/cadwyn?color=%2334D058&logo=codecov" alt="Coverage">
+<a href="https://codecov.io/gh/zmievsa/cadwyn" target="_blank">
+    <img src="https://img.shields.io/codecov/c/github/zmievsa/cadwyn?color=%2334D058&logo=codecov" alt="Coverage">
 </a>
 <a href="https://pypi.org/project/cadwyn/" target="_blank">
     <img alt="PyPI" src="https://img.shields.io/pypi/v/cadwyn?color=%2334D058&logo=pypi&label=PyPI package" alt="Package version">

{cadwyn-3.14.0 → cadwyn-3.15.1}/README.md

@@ -8,8 +8,8 @@ Production-ready community-driven modern [Stripe-like](https://stripe.com/blog/a
 <a href="https://github.com/zmievsa/cadwyn/actions/workflows/ci.yaml?branch=main&event=push" target="_blank">
     <img src="https://github.com/zmievsa/cadwyn/actions/workflows/ci.yaml/badge.svg?branch=main&event=push" alt="Test">
 </a>
-<a href="https://codecov.io/gh/ovsyanka83/cadwyn" target="_blank">
-    <img src="https://img.shields.io/codecov/c/github/ovsyanka83/cadwyn?color=%2334D058&logo=codecov" alt="Coverage">
+<a href="https://codecov.io/gh/zmievsa/cadwyn" target="_blank">
+    <img src="https://img.shields.io/codecov/c/github/zmievsa/cadwyn?color=%2334D058&logo=codecov" alt="Coverage">
 </a>
 <a href="https://pypi.org/project/cadwyn/" target="_blank">
     <img alt="PyPI" src="https://img.shields.io/pypi/v/cadwyn?color=%2334D058&logo=pypi&label=PyPI package" alt="Package version">

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/__init__.py

@@ -2,7 +2,11 @@ import importlib.metadata
 
 from .applications import Cadwyn
 from .codegen import generate_code_for_versioned_packages
-from .route_generation import InternalRepresentationOf, VersionedAPIRouter, generate_versioned_routers
+from .route_generation import (
+    InternalRepresentationOf,  # pyright: ignore[reportDeprecated]
+    VersionedAPIRouter,
+    generate_versioned_routers,
+)
 from .structure import VersionBundle
 
 __version__ = importlib.metadata.version("cadwyn")

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/__main__.py

@@ -60,7 +60,7 @@ def deprecated_generate_versioned_packages(
     possibly_version_bundle = getattr(version_bundle_module, version_bundle_variable_name)
     version_bundle = _get_version_bundle(possibly_version_bundle)
 
-    return generate_code_for_versioned_packages(
+    return generate_code_for_versioned_packages(  # pyright: ignore[reportDeprecated]
         template_package,
         version_bundle,
         ignore_coverage_for_latest_aliases=ignore_coverage_for_latest_aliases,

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/applications.py

@@ -7,9 +7,14 @@ from typing import Any, cast
 
 from fastapi import APIRouter, FastAPI, HTTPException, routing
 from fastapi.datastructures import Default
-from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
+from fastapi.openapi.docs import (
+    get_redoc_html,
+    get_swagger_ui_html,
+    get_swagger_ui_oauth2_redirect_html,
+)
 from fastapi.openapi.utils import get_openapi
 from fastapi.params import Depends
+from fastapi.responses import HTMLResponse
 from fastapi.templating import Jinja2Templates
 from fastapi.utils import generate_unique_id
 from starlette.middleware import Middleware
@@ -19,7 +24,6 @@ from starlette.routing import BaseRoute, Route
 from starlette.types import Lifespan
 from typing_extensions import Self, deprecated
 
-from cadwyn._utils import same_definition_as_in
 from cadwyn.middleware import HeaderVersioningMiddleware, _get_api_version_dependency
 from cadwyn.route_generation import generate_versioned_routers
 from cadwyn.routing import _RootHeaderAPIRouter
@@ -139,6 +143,8 @@ class Cadwyn(FastAPI):
             api_version_var=self.versions.api_version_var,
         )
 
+        self.add_event_handler("startup", self.enrich_swagger)
+
         self.docs_url = docs_url
         self.redoc_url = redoc_url
         self.openapi_url = openapi_url
@@ -178,6 +184,18 @@ class Cadwyn(FastAPI):
                     endpoint=self.swagger_dashboard,
                     include_in_schema=False,
                 )
+                if self.swagger_ui_oauth2_redirect_url:
+
+                    async def swagger_ui_redirect(req: Request) -> HTMLResponse:
+                        return (
+                            get_swagger_ui_oauth2_redirect_html()  # pragma: no cover # unimportant right now but # TODO
+                        )
+
+                    self.add_route(
+                        self.swagger_ui_oauth2_redirect_url,
+                        swagger_ui_redirect,
+                        include_in_schema=False,
+                    )
             if self.redoc_url is not None:
                 unversioned_router.add_route(
                     path=self.redoc_url,
@@ -247,20 +265,38 @@ class Cadwyn(FastAPI):
         return JSONResponse(openapi_of_a_version)
 
     async def swagger_dashboard(self, req: Request) -> Response:
-        return self._render_docs_dashboard_or_concrete_verssion(get_swagger_ui_html, req, cast(str, self.docs_url))
+        version = req.query_params.get("version")
 
-    async def redoc_dashboard(self, req: Request) -> Response:
-        return self._render_docs_dashboard_or_concrete_verssion(get_redoc_html, req, cast(str, self.redoc_url))
+        if version:
+            root_path = self._extract_root_path(req)
+            openapi_url = root_path + f"{self.openapi_url}?version={version}"
+            oauth2_redirect_url = self.swagger_ui_oauth2_redirect_url
+            if oauth2_redirect_url:
+                oauth2_redirect_url = root_path + oauth2_redirect_url
+            return get_swagger_ui_html(
+                openapi_url=openapi_url,
+                title=f"{self.title} - Swagger UI",
+                oauth2_redirect_url=oauth2_redirect_url,
+                init_oauth=self.swagger_ui_init_oauth,
+                swagger_ui_parameters=self.swagger_ui_parameters,
+            )
+        return self._render_docs_dashboard(req, cast(str, self.docs_url))
 
-    def _render_docs_dashboard_or_concrete_verssion(self, render_docs: Callable[..., Any], req: Request, docs_url: str):
-        base_url = str(req.base_url).rstrip("/")
+    async def redoc_dashboard(self, req: Request) -> Response:
         version = req.query_params.get("version")
 
         if version:
-            return render_docs(
-                openapi_url=f"{self.openapi_url}?version={version}",
-                title="Swagger UI",
-            )
+            root_path = self._extract_root_path(req)
+            openapi_url = root_path + f"{self.openapi_url}?version={version}"
+            return get_redoc_html(openapi_url=openapi_url, title=f"{self.title} - ReDoc")
+
+        return self._render_docs_dashboard(req, docs_url=cast(str, self.redoc_url))
+
+    def _extract_root_path(self, req: Request):
+        return req.scope.get("root_path", "").rstrip("/")
+
+    def _render_docs_dashboard(self, req: Request, docs_url: str):
+        base_url = str(req.base_url).rstrip("/")
         return self._templates.TemplateResponse(
             "docs.html",
             {
@@ -297,91 +333,11 @@ class Cadwyn(FastAPI):
                 dependencies=[Depends(_get_api_version_dependency(self.router.api_version_header_name, header_value))],
             )
 
-        self.enrich_swagger()
         return added_routes
 
-    @same_definition_as_in(FastAPI.include_router)
-    def include_router(self, *args: Any, **kwargs: Any):
-        route = super().include_router(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.post)
-    def post(self, *args: Any, **kwargs: Any):
-        route = super().post(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.get)
-    def get(self, *args: Any, **kwargs: Any):
-        route = super().get(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.patch)
-    def patch(self, *args: Any, **kwargs: Any):
-        route = super().patch(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.delete)
-    def delete(self, *args: Any, **kwargs: Any):
-        route = super().delete(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.put)
-    def put(self, *args: Any, **kwargs: Any):
-        route = super().put(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.trace)
-    def trace(self, *args: Any, **kwargs: Any):  # pragma: no cover
-        route = super().trace(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.options)
-    def options(self, *args: Any, **kwargs: Any):
-        route = super().options(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.head)
-    def head(self, *args: Any, **kwargs: Any):
-        route = super().head(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.add_api_route)
-    def add_api_route(self, *args: Any, **kwargs: Any):
-        route = super().add_api_route(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.api_route)
-    def api_route(self, *args: Any, **kwargs: Any):
-        route = super().api_route(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.add_api_websocket_route)
-    def add_api_websocket_route(self, *args: Any, **kwargs: Any):  # pragma: no cover
-        route = super().add_api_websocket_route(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
-    @same_definition_as_in(FastAPI.websocket)
-    def websocket(self, *args: Any, **kwargs: Any):  # pragma: no cover
-        route = super().websocket(*args, **kwargs)
-        self.enrich_swagger()
-        return route
-
     def add_unversioned_routers(self, *routers: APIRouter):
         for router in routers:
             self.router.include_router(router)
-        self.enrich_swagger()
 
     @deprecated("Use add add_unversioned_routers instead")
     def add_unversioned_routes(self, *routes: Route):

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/route_generation.py

@@ -452,7 +452,10 @@ def _extract_internal_request_schemas_from_router(
         for key, annotation in annotations.items():
             if isinstance(annotation, type(Annotated[int, int])):
                 args = get_args(annotation)
-                if isinstance(args[1], type) and issubclass(args[1], InternalRepresentationOf):  # pragma: no branch
+                if isinstance(args[1], type) and issubclass(  # pragma: no branch
+                    args[1],
+                    InternalRepresentationOf,  # pyright: ignore[reportDeprecated]
+                ):
                     internal_schema = args[0]
                     original_schema = args[1].mro()[2]
                     schema_to_internal_request_body_representation[original_schema] = internal_schema

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/routing.py

@@ -12,7 +12,7 @@ from starlette.responses import RedirectResponse
 from starlette.routing import BaseRoute, Match
 from starlette.types import Receive, Scope, Send
 
-from .route_generation import InternalRepresentationOf, generate_versioned_routers
+from .route_generation import InternalRepresentationOf, generate_versioned_routers  # pyright: ignore[reportDeprecated]
 
 # TODO: Remove this in a major version. This is only here for backwards compatibility
 __all__ = ["InternalRepresentationOf", "generate_versioned_routers"]

{cadwyn-3.14.0 → cadwyn-3.15.1}/cadwyn/structure/versions.py

@@ -420,7 +420,7 @@ class VersionBundle:
         versioned_response_model: type[BaseModel] = get_another_version_of_cls(
             latest_response_model, version_dir, self.versioned_directories_with_head
         )
-        return versioned_response_model.parse_obj(migrated_response.body)
+        return versioned_response_model.parse_obj(migrated_response.body)  # pyright: ignore[reportDeprecated]
 
     def _get_closest_lesser_version(self, version: VersionDate):
         for defined_version in self.version_dates:

{cadwyn-3.14.0 → cadwyn-3.15.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "3.14.0"
+version = "3.15.1"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
@@ -55,7 +55,7 @@ typing-extensions = "*"
 fastapi = ">=0.110.0"
 starlette = ">=0.36.3"
 pydantic = ">=1.0.0"
-typer = {version = ">=0.7.0", optional = true}
+typer = { version = ">=0.7.0", optional = true }
 better-ast-comments = "~1.2.1"
 jinja2 = ">=3.1.2"
 issubclass = "^0.1.2"
@@ -104,7 +104,13 @@ exclude_lines = [
     "__rich_repr__",
     "__repr__",
 ]
-omit = ["./docs/plugin.py", "./site/plugin.py", "./tests/_data/_temp/**/*", "tests/tutorial/data/**/*", "scripts/*.py"]
+omit = [
+    "./docs/plugin.py",
+    "./site/plugin.py",
+    "./tests/_data/_temp/**/*",
+    "tests/tutorial/data/**/*",
+    "scripts/*.py",
+]
 
 [tool.pyright]
 reportMissingImports = true