cadwyn 3.10.0__py3-none-any.whl → 3.11.0__py3-none-any.whl

cadwyn/applications.py

@@ -127,6 +127,7 @@ class Cadwyn(FastAPI):
             deprecated=deprecated,
             responses=responses,
             api_version_header_name=api_version_header_name,
+            api_version_var=self.versions.api_version_var,
             lifespan=lifespan,
         )
         self.docs_url = docs_url
@@ -182,7 +183,6 @@ class Cadwyn(FastAPI):
         router_versions = generate_versioned_routers(
             root_router,
             versions=self.versions,
-            head_schemas_package=self.versions.head_schemas_package,  # pyright: ignore[reportArgumentType],
         )
         for version, router in router_versions.items():
             self.add_header_versioned_routers(router, header_value=version.isoformat())

cadwyn/route_generation.py

@@ -22,6 +22,7 @@ from typing import (
     final,
     get_args,
     get_origin,
+    overload,
 )
 
 import fastapi.params
@@ -90,11 +91,38 @@ class InternalRepresentationOf:
         return cast(Any, type("InternalRepresentationOf", (cls, original_schema), {}))
 
 
+@overload
 def generate_versioned_routers(
     router: _R,
     versions: VersionBundle,
-    head_schemas_package: ModuleType,
 ) -> dict[VersionDate, _R]:
+    ...
+
+
+@overload
+@deprecated("Do not use the latest_schemas_package argument. Put head_schemas_package into your VersionBundle instead")
+def generate_versioned_routers(
+    router: _R,
+    versions: VersionBundle,
+    latest_schemas_package: ModuleType | None,
+) -> dict[VersionDate, _R]:
+    ...
+
+
+def generate_versioned_routers(
+    router: _R,
+    versions: VersionBundle,
+    latest_schemas_package: ModuleType | None = None,
+) -> dict[VersionDate, _R]:
+    if versions.head_schemas_package is not None:
+        head_schemas_package = versions.head_schemas_package
+    elif latest_schemas_package is not None:  # pragma: no cover
+        head_schemas_package = latest_schemas_package
+    else:  # pragma: no cover
+        raise TypeError(
+            "TypeError: generate_versioned_routers() must be called with a VersionBundle "
+            "that contains a non-null head_schemas_package."
+        )
     versions.head_schemas_package = head_schemas_package
     versions._validate_head_schemas_package_structure()
     return _EndpointTransformer(router, versions, head_schemas_package).transform()

cadwyn/routing.py

@@ -1,6 +1,7 @@
 import bisect
 from collections import OrderedDict
 from collections.abc import Sequence
+from contextvars import ContextVar
 from datetime import date
 from functools import cached_property
 from logging import getLogger
@@ -35,11 +36,18 @@ class _RootHeaderAPIRouter(APIRouter):
     matched to the higher versioned route
     """
 
-    def __init__(self, *args: Any, api_version_header_name: str, **kwargs: Any):
+    def __init__(
+        self,
+        *args: Any,
+        api_version_header_name: str,
+        api_version_var: ContextVar[date] | ContextVar[date | None],
+        **kwargs: Any,
+    ):
         super().__init__(*args, **kwargs)
         self.versioned_routes: dict[date, list[BaseRoute]] = {}
         self.unversioned_routes: list[BaseRoute] = []
         self.api_version_header_name = api_version_header_name.lower()
+        self.api_version_var = api_version_var
 
     @cached_property
     def sorted_versioned_routes(self):
@@ -90,10 +98,7 @@ class _RootHeaderAPIRouter(APIRouter):
             await self.lifespan(scope, receive, send)
             return
 
-        request_headers = dict(scope["headers"])
-        header_value = request_headers.get(self.api_version_header_name.encode(), b"").decode()
-        if header_value:
-            header_value = date.fromisoformat(header_value)
+        header_value = self.api_version_var.get(None)
 
         # if header_value is None, then it's an unversioned request and we need to use the unversioned routes
         # if there will be a value, we search for the most suitable version

cadwyn/structure/versions.py

@@ -323,10 +323,9 @@ class VersionBundle:
         # upon receiving `latest`.
 
         head_schemas_package = cast(ModuleType, self.head_schemas_package)
-
         if not hasattr(head_schemas_package, "__path__"):
             raise CadwynStructureError(
-                f'The head schemas module must be a package. "{head_schemas_package.__name__}" is not a package.',
+                f'The head schemas package must be a package. "{head_schemas_package.__name__}" is not a package.',
             )
         elif head_schemas_package.__name__.endswith(".head"):
             return "head"

{cadwyn-3.10.0.dist-info → cadwyn-3.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 3.10.0
+Version: 3.11.0
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT

{cadwyn-3.10.0.dist-info → cadwyn-3.11.0.dist-info}/RECORD

@@ -4,7 +4,7 @@ cadwyn/_asts.py,sha256=S-x9fVKTENZZxwWfabm0PbztcHyX2MJkI6Cwv5XgVrI,10138
 cadwyn/_compat.py,sha256=6QwtzbXn53mIhEFfEizmFjd-f894oLsM6ITxqq2rCpc,5408
 cadwyn/_package_utils.py,sha256=trxTYLmppv-10SKhScfyDQJh21rsQGFoLaOtHycKKR0,1443
 cadwyn/_utils.py,sha256=BFsfZBpdoL5RMAaT1V1cXJVpTZCmwksQ-Le2MTHivGI,4841
-cadwyn/applications.py,sha256=Hy9CyQH0TspktcI4oSRcbAcMSmM2K3Ua3hrMvC1of7E,12876
+cadwyn/applications.py,sha256=sz4x_GoD3s1snm3M1Wgx22mdAICQXciVd9rhGWZk0II,12826
 cadwyn/codegen/README.md,sha256=hc7AE87LsEsvbh-wX1H10JEWh-8bLHoe-1CkY3h00FI,879
 cadwyn/codegen/__init__.py,sha256=JgddDjxMTjSfVrMXHwNu1ODgdn2QfPWpccrRKquBV6k,355
 cadwyn/codegen/_common.py,sha256=FTI4fqpUFGBMACVlPiDMHTWhqwW_-zQNa_4Qh7m-hCA,5877
@@ -19,8 +19,8 @@ cadwyn/exceptions.py,sha256=gsb1vszQ2VsnfTBM5B8AYmXwCW0yvA8pJ1GhNkGzgyE,1440
 cadwyn/main.py,sha256=kt2Vn7TIA4ZnD_xrgz57TOjUk-4zVP8SV8nuTZBEaaU,218
 cadwyn/middleware.py,sha256=8cuBri_yRkl0goe6G0MLwtL04WGbW9Infah3wy9hUVM,3372
 cadwyn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cadwyn/route_generation.py,sha256=DiCeJdM5p36ZBixzxyi3DSxZQhpDbfetXQMhtNwzDfM,34810
-cadwyn/routing.py,sha256=S7KQzCuGCiriGwxigw1ZloHLA7OmS7VO54YWtjsryHs,6378
+cadwyn/route_generation.py,sha256=7nHe_IP7Uz1rXmnItJsQ2yIuqe3lRgtOr8_MP_6Vg8c,35704
+cadwyn/routing.py,sha256=nswSMfpGMYk-TSbNY6NmH7NuWM0GoWwK_McTzPiKluk,6392
 cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cadwyn/static/docs.html,sha256=WNm5ANJVy51TcIUFOaqKf1Z8eF86CC85TTHPxACtkzw,3455
 cadwyn/structure/__init__.py,sha256=HjaNd6H4m4Cia42-dCO7A7sLWuVII7oldjaCabhbs_o,697
@@ -30,9 +30,9 @@ cadwyn/structure/endpoints.py,sha256=VngfAydGBwekhV2tBOtNDPVgl3X1IgYxUCw--VZ5cQY
 cadwyn/structure/enums.py,sha256=iMokxA2QYJ61SzyB-Pmuq3y7KL7-e6TsnjLVUaVZQnw,954
 cadwyn/structure/modules.py,sha256=1FK-lLm-zOTXEvn-QtyBH38aDRht5PDQiZrOPCsBlM4,1268
 cadwyn/structure/schemas.py,sha256=0ylArAkUw626VkUOJSulOwJs7CS6lrGBRECEG5HFD4Q,8897
-cadwyn/structure/versions.py,sha256=elWGyibosoxFemC19WDAX3APZtI1f4gEh402njZmY4U,36078
-cadwyn-3.10.0.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
-cadwyn-3.10.0.dist-info/METADATA,sha256=Xaxi6Z533Cs80dutkvWbYJxU4XHKhFaoImC9IEhS2ZI,4360
-cadwyn-3.10.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-cadwyn-3.10.0.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
-cadwyn-3.10.0.dist-info/RECORD,,
+cadwyn/structure/versions.py,sha256=aVmI71vBtMpyu9dT5m732feTJWdKOXNpPZQb80G8y9c,36078
+cadwyn-3.11.0.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
+cadwyn-3.11.0.dist-info/METADATA,sha256=6bHtgZeWr378YbnPVUELXHlcyga0DH0UFJbsmK-Nsb8,4360
+cadwyn-3.11.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+cadwyn-3.11.0.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
+cadwyn-3.11.0.dist-info/RECORD,,