cadwyn 4.3.1__py3-none-any.whl → 4.4.0__py3-none-any.whl

cadwyn/applications.py

@@ -25,6 +25,7 @@ from starlette.routing import BaseRoute, Route
 from starlette.types import Lifespan
 from typing_extensions import Self
 
+from cadwyn._utils import same_definition_as_in
 from cadwyn.changelogs import CadwynChangelogResource, _generate_changelog
 from cadwyn.middleware import HeaderVersioningMiddleware, _get_api_version_dependency
 from cadwyn.route_generation import generate_versioned_routers
@@ -96,8 +97,8 @@ class Cadwyn(FastAPI):
         **extra: Any,
     ) -> None:
         self.versions = versions
-        # TODO: Remove argument entirely in any major version.
         self._dependency_overrides_provider = FakeDependencyOverridesProvider({})
+        self._cadwyn_initialized = False
 
         super().__init__(
             debug=debug,
@@ -156,6 +157,8 @@ class Cadwyn(FastAPI):
             api_version_header_name=api_version_header_name,
             api_version_var=self.versions.api_version_var,
         )
+        self._versioned_webhook_routers: dict[date, APIRouter] = {}
+        self._latest_version_router = APIRouter(dependency_overrides_provider=self._dependency_overrides_provider)
 
         self.changelog_url = changelog_url
         self.include_changelog_url_in_schema = include_changelog_url_in_schema
@@ -176,6 +179,26 @@ class Cadwyn(FastAPI):
             default_response_class=default_response_class,
         )
 
+    @same_definition_as_in(FastAPI.__call__)
+    async def __call__(self, scope: Any, receive: Any, send: Any) -> None:
+        if not self._cadwyn_initialized:
+            self._cadwyn_initialize()
+        self.__call__ = super().__call__
+        await self.__call__(scope, receive, send)
+
+    def _cadwyn_initialize(self) -> None:
+        generated_routers = generate_versioned_routers(
+            self._latest_version_router,
+            webhooks=self.webhooks,
+            versions=self.versions,
+        )
+        for version, router in generated_routers.endpoints.items():
+            self.add_header_versioned_routers(router, header_value=version.isoformat())
+
+        for version, router in generated_routers.webhooks.items():
+            self._versioned_webhook_routers[version] = router
+        self._cadwyn_initialized = True
+
     def _add_default_versioned_routers(self) -> None:
         for version in self.versions:
             self.router.versioned_routers[version.value] = APIRouter(**self._kwargs_to_router)
@@ -240,12 +263,8 @@ class Cadwyn(FastAPI):
                 )
 
     def generate_and_include_versioned_routers(self, *routers: APIRouter) -> None:
-        root_router = APIRouter(dependency_overrides_provider=self._dependency_overrides_provider)
         for router in routers:
-            root_router.include_router(router)
-        router_versions = generate_versioned_routers(root_router, versions=self.versions)
-        for version, router in router_versions.items():
-            self.add_header_versioned_routers(router, header_value=version.isoformat())
+            self._latest_version_router.include_router(router)
 
     async def openapi_jsons(self, req: Request) -> JSONResponse:
         raw_version = req.query_params.get("version") or req.headers.get(self.router.api_version_header_name)
@@ -276,6 +295,10 @@ class Cadwyn(FastAPI):
         if root_path and root_path not in server_urls and self.root_path_in_servers:
             self.servers.insert(0, {"url": root_path})
 
+        webhook_routes = None
+        if version in self._versioned_webhook_routers:
+            webhook_routes = self._versioned_webhook_routers[version].routes
+
         return JSONResponse(
             get_openapi(
                 title=self.title,
@@ -287,6 +310,7 @@ class Cadwyn(FastAPI):
                 contact=self.contact,
                 license_info=self.license_info,
                 routes=routes,
+                webhooks=webhook_routes,
                 tags=self.openapi_tags,
                 servers=self.servers,
             )

cadwyn/route_generation.py

@@ -7,7 +7,6 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Generic,
-    TypeVar,
     cast,
 )
 
@@ -20,7 +19,7 @@ from fastapi.routing import APIRoute
 from issubclass import issubclass as lenient_issubclass
 from pydantic import BaseModel
 from starlette.routing import BaseRoute
-from typing_extensions import assert_never
+from typing_extensions import TypeVar, assert_never
 
 from cadwyn._utils import Sentinel
 from cadwyn.exceptions import (
@@ -48,7 +47,8 @@ if TYPE_CHECKING:
     from fastapi.dependencies.models import Dependant
 
 _Call = TypeVar("_Call", bound=Callable[..., Any])
-_R = TypeVar("_R", bound=fastapi.routing.APIRouter)
+_R = TypeVar("_R", bound=APIRouter)
+_WR = TypeVar("_WR", bound=APIRouter, default=APIRouter)
 # This is a hack we do because we can't guarantee how the user will use the router.
 _DELETED_ROUTE_TAG = "_CADWYN_DELETED_ROUTE"
 
@@ -59,8 +59,21 @@ class _EndpointInfo:
     endpoint_methods: frozenset[str]
 
 
-def generate_versioned_routers(router: _R, versions: VersionBundle) -> dict[VersionDate, _R]:
-    return _EndpointTransformer(router, versions).transform()
+@dataclass(slots=True, frozen=True)
+class GeneratedRouters(Generic[_R, _WR]):
+    endpoints: dict[VersionDate, _R]
+    webhooks: dict[VersionDate, _WR]
+
+
+def generate_versioned_routers(
+    router: _R,
+    versions: VersionBundle,
+    *,
+    webhooks: _WR | None = None,
+) -> GeneratedRouters[_R, _WR]:
+    if webhooks is None:
+        webhooks = cast(_WR, APIRouter())
+    return _EndpointTransformer(router, versions, webhooks).transform()
 
 
 class VersionedAPIRouter(fastapi.routing.APIRouter):
@@ -77,30 +90,36 @@ class VersionedAPIRouter(fastapi.routing.APIRouter):
         return endpoint
 
 
-class _EndpointTransformer(Generic[_R]):
-    def __init__(self, parent_router: _R, versions: VersionBundle) -> None:
+class _EndpointTransformer(Generic[_R, _WR]):
+    def __init__(self, parent_router: _R, versions: VersionBundle, webhooks: _WR) -> None:
         super().__init__()
         self.parent_router = parent_router
         self.versions = versions
+        self.parent_webhooks_router = webhooks
         self.schema_generators = generate_versioned_models(versions)
 
         self.routes_that_never_existed = [
             route for route in parent_router.routes if isinstance(route, APIRoute) and _DELETED_ROUTE_TAG in route.tags
         ]
 
-    def transform(self) -> dict[VersionDate, _R]:
+    def transform(self) -> GeneratedRouters[_R, _WR]:
         router = deepcopy(self.parent_router)
+        webhook_router = deepcopy(self.parent_webhooks_router)
         routers: dict[VersionDate, _R] = {}
+        webhook_routers: dict[VersionDate, _WR] = {}
 
         for version in self.versions:
             self.schema_generators[str(version.value)].annotation_transformer.migrate_router_to_version(router)
+            self.schema_generators[str(version.value)].annotation_transformer.migrate_router_to_version(webhook_router)
 
             self._validate_all_data_converters_are_applied(router, version)
 
             routers[version.value] = router
+            webhook_routers[version.value] = webhook_router
             # Applying changes for the next version
             router = deepcopy(router)
-            self._apply_endpoint_changes_to_router(router, version)
+            webhook_router = deepcopy(webhook_router)
+            self._apply_endpoint_changes_to_router(router.routes + webhook_router.routes, version)
 
         if self.routes_that_never_existed:
             raise RouterGenerationError(
@@ -146,7 +165,13 @@ class _EndpointTransformer(Generic[_R]):
                 for route in router.routes
                 if not (isinstance(route, fastapi.routing.APIRoute) and _DELETED_ROUTE_TAG in route.tags)
             ]
-        return routers
+        for _, webhook_router in webhook_routers.items():
+            webhook_router.routes = [
+                route
+                for route in webhook_router.routes
+                if not (isinstance(route, fastapi.routing.APIRoute) and _DELETED_ROUTE_TAG in route.tags)
+            ]
+        return GeneratedRouters(routers, webhook_routers)
 
     def _validate_all_data_converters_are_applied(self, router: APIRouter, version: Version):
         path_to_route_methods_mapping, head_response_models, head_request_bodies = self._extract_all_routes_identifiers(
@@ -223,10 +248,9 @@ class _EndpointTransformer(Generic[_R]):
     # TODO (https://github.com/zmievsa/cadwyn/issues/28): Simplify
     def _apply_endpoint_changes_to_router(  # noqa: C901
         self,
-        router: fastapi.routing.APIRouter,
+        routes: list[BaseRoute] | list[APIRoute],
         version: Version,
     ):
-        routes = router.routes
         for version_change in version.changes:
             for instruction in version_change.alter_endpoint_instructions:
                 original_routes = _get_routes(

{cadwyn-4.3.1.dist-info → cadwyn-4.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cadwyn
-Version: 4.3.1
+Version: 4.4.0
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Project-URL: Source code, https://github.com/zmievsa/cadwyn
 Project-URL: Documentation, https://docs.cadwyn.dev

{cadwyn-4.3.1.dist-info → cadwyn-4.4.0.dist-info}/RECORD

@@ -4,12 +4,12 @@ cadwyn/_asts.py,sha256=OVOPjjZNrPHpbicf4Gg5HmWToPOdMo8S56pKDDJATRY,5139
 cadwyn/_importer.py,sha256=2mZrDHlfY2heZsMBW-9RBpvKsCk9I-Wa8pxZ6f2f8gY,1074
 cadwyn/_render.py,sha256=LJ-R1TrBgMJpTkJb6pQdRWaMjKyw3R6eTlXXEieqUw0,5466
 cadwyn/_utils.py,sha256=GK9w_qzyOI_o6UaGVfwLLYhnJFMzXistoYI9fq2E9dE,1159
-cadwyn/applications.py,sha256=9gObB244eDTMi9-Nah3F5ErB2bSABkeGHWO7lfBcivM,16013
+cadwyn/applications.py,sha256=worXUWoexSev0cGJYzXMFBxUgibC1AsM35SYtcV996k,16948
 cadwyn/changelogs.py,sha256=SdrdAKQ01mpzs-EN_zg-D0TY7wxsibjRjLMhGcI4q80,20066
 cadwyn/exceptions.py,sha256=VlJKRmEGfFTDtHbOWc8kXK4yMi2N172K684Y2UIV8rI,1832
 cadwyn/middleware.py,sha256=kUZK2dmoricMbv6knPCIHpXEInX2670XIwAj0v_XQxk,3408
 cadwyn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cadwyn/route_generation.py,sha256=npAWxhr38_NNZOvXriPt_StdzR4WeL5Xwv505e9Gn9s,22953
+cadwyn/route_generation.py,sha256=870pZK-Gs_pUuRRj9jcJm3AOc-Ua2jtNRoJcwUutLA4,24028
 cadwyn/routing.py,sha256=9AHSojmuLgUAQlLMIqXz-ViZ9n-fljgOsn7oxha7PjM,7341
 cadwyn/schema_generation.py,sha256=1eJ--nyG8onUROWegCmQQWJ4iJEu1MrTt-8bnLIQyeQ,39992
 cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,8 +21,8 @@ cadwyn/structure/endpoints.py,sha256=9FFnbqPM9v0CP6J6tGhMNKVvWqA9u3ZjI2Fannr2Rl0
 cadwyn/structure/enums.py,sha256=bZL-iUOUFi9ZYlMZJw-tAix2yrgCp3gH3N2gwO44LUU,1043
 cadwyn/structure/schemas.py,sha256=D0BD1D3v9MRdVWchU9JM2zHd0dvB0UgXHDGFCe5aQZc,8209
 cadwyn/structure/versions.py,sha256=2qe7xFYNdzdWmCZhkf4_zJ7lF0XdtyM1wq6xQ9omb_c,33655
-cadwyn-4.3.1.dist-info/METADATA,sha256=tk0i6Jo1xgKsT-E4MatBe-L1hbAV5CN-sYzRLQUosSE,4443
-cadwyn-4.3.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-cadwyn-4.3.1.dist-info/entry_points.txt,sha256=mGX8wl-Xfhpr5M93SUmkykaqinUaYAvW9rtDSX54gx0,47
-cadwyn-4.3.1.dist-info/licenses/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
-cadwyn-4.3.1.dist-info/RECORD,,
+cadwyn-4.4.0.dist-info/METADATA,sha256=YcNWXemwnjoR8H2ODF7yFTWRBOjbPaxar1vKXe9UmOs,4443
+cadwyn-4.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+cadwyn-4.4.0.dist-info/entry_points.txt,sha256=mGX8wl-Xfhpr5M93SUmkykaqinUaYAvW9rtDSX54gx0,47
+cadwyn-4.4.0.dist-info/licenses/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
+cadwyn-4.4.0.dist-info/RECORD,,