cadwyn 3.10.0__tar.gz → 3.11.0__tar.gz

{cadwyn-3.10.0 → cadwyn-3.11.0}/PKG-INFO

@@ -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 → cadwyn-3.11.0}/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-3.10.0 → cadwyn-3.11.0}/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-3.10.0 → cadwyn-3.11.0}/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-3.10.0 → cadwyn-3.11.0}/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 → cadwyn-3.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "3.10.0"
+version = "3.11.0"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"