cadwyn 3.15.4__tar.gz → 3.15.6__tar.gz

{cadwyn-3.15.4 → cadwyn-3.15.6}/PKG-INFO

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

{cadwyn-3.15.4 → cadwyn-3.15.6}/cadwyn/__init__.py

@@ -7,7 +7,7 @@ from .route_generation import (
     VersionedAPIRouter,
     generate_versioned_routers,
 )
-from .structure import VersionBundle
+from .structure import HeadVersion, Version, VersionBundle
 
 __version__ = importlib.metadata.version("cadwyn")
 __all__ = [
@@ -15,6 +15,8 @@ __all__ = [
     "VersionedAPIRouter",
     "generate_code_for_versioned_packages",
     "VersionBundle",
+    "HeadVersion",
+    "Version",
     "generate_versioned_routers",
     "InternalRepresentationOf",
 ]

{cadwyn-3.15.4 → cadwyn-3.15.6}/cadwyn/applications.py

@@ -1,3 +1,4 @@
+import dataclasses
 import datetime
 from collections.abc import Callable, Coroutine, Sequence
 from datetime import date
@@ -34,6 +35,11 @@ CURR_DIR = Path(__file__).resolve()
 logger = getLogger(__name__)
 
 
+@dataclasses.dataclass(slots=True)
+class FakeDependencyOverridesProvider:
+    dependency_overrides: dict[Callable[..., Any], Callable[..., Any]]
+
+
 class Cadwyn(FastAPI):
     _templates = Jinja2Templates(directory=CURR_DIR.parent / "static")
 
@@ -92,6 +98,7 @@ class Cadwyn(FastAPI):
         latest_schemas_package = extra.pop("latest_schemas_package", None) or self.versions.head_schemas_package
         self.versions.head_schemas_package = latest_schemas_package
         self._latest_schemas_package = cast(ModuleType, latest_schemas_package)
+        self._dependency_overrides_provider = FakeDependencyOverridesProvider({})
 
         super().__init__(
             debug=debug,
@@ -166,6 +173,20 @@ class Cadwyn(FastAPI):
             default_response_class=default_response_class,
         )
 
+    @property
+    def dependency_overrides(self) -> dict[Callable[..., Any], Callable[..., Any]]:
+        # This is only necessary because we cannot send self to versioned router generator
+        # because it takes a deepcopy of the router and self.versions.head_schemas_package is a module
+        # which cannot be copied.
+        return self._dependency_overrides_provider.dependency_overrides
+
+    @dependency_overrides.setter
+    def dependency_overrides(  # pyright: ignore[reportIncompatibleVariableOverride]
+        self,
+        value: dict[Callable[..., Any], Callable[..., Any]],
+    ) -> None:
+        self._dependency_overrides_provider.dependency_overrides = value
+
     @property  # pragma: no cover
     @deprecated("It is going to be deleted in the future. Use VersionBundle.head_schemas_package instead")
     def latest_schemas_package(self):
@@ -209,7 +230,7 @@ class Cadwyn(FastAPI):
                 )
 
     def generate_and_include_versioned_routers(self, *routers: APIRouter) -> None:
-        root_router = APIRouter()
+        root_router = APIRouter(dependency_overrides_provider=self._dependency_overrides_provider)
         for router in routers:
             root_router.include_router(router)
         router_versions = generate_versioned_routers(

{cadwyn-3.15.4 → cadwyn-3.15.6}/cadwyn/route_generation.py

@@ -12,6 +12,7 @@ from enum import Enum
 from pathlib import Path
 from types import GenericAlias, MappingProxyType, ModuleType
 from typing import (
+    TYPE_CHECKING,
     Annotated,
     Any,
     Generic,
@@ -28,23 +29,18 @@ import fastapi.params
 import fastapi.routing
 import fastapi.security.base
 import fastapi.utils
-from fastapi import APIRouter
+from fastapi import (
+    APIRouter,
+    Request,  # noqa: F401 # We import Request for libraries like svcs that expect it to be in globals
+    Response,  # noqa: F401 # We import Request for libraries like svcs that expect it to be in globals
+)
 from fastapi._compat import ModelField as FastAPIModelField
 from fastapi._compat import create_body_model
-from fastapi.dependencies.models import Dependant
-from fastapi.dependencies.utils import (
-    get_body_field,
-    get_dependant,
-    get_parameterless_sub_dependant,
-)
 from fastapi.params import Depends
 from fastapi.routing import APIRoute
 from issubclass import issubclass as lenient_issubclass
 from pydantic import BaseModel
-from starlette.routing import (
-    BaseRoute,
-    request_response,
-)
+from starlette.routing import BaseRoute
 from typing_extensions import Self, assert_never, deprecated
 
 from cadwyn._compat import get_annotation_from_model_field, model_fields, rebuild_fastapi_body_param
@@ -68,6 +64,9 @@ from cadwyn.structure.endpoints import (
 )
 from cadwyn.structure.versions import _CADWYN_REQUEST_PARAM_NAME, _CADWYN_RESPONSE_PARAM_NAME, VersionChange
 
+if TYPE_CHECKING:
+    from fastapi.dependencies.models import Dependant
+
 _T = TypeVar("_T", bound=Callable[..., Any])
 _R = TypeVar("_R", bound=fastapi.routing.APIRouter)
 # This is a hack we do because we can't guarantee how the user will use the router.
@@ -308,7 +307,7 @@ class _EndpointTransformer(Generic[_R]):
 
     def _replace_internal_representation_with_the_versioned_schema(
         self,
-        copy_of_dependant: Dependant,
+        copy_of_dependant: "Dependant",
         schema_to_internal_request_body_representation: dict[type[BaseModel], type[BaseModel]],
     ):
         body_param: FastAPIModelField = copy_of_dependant.body_params[0]
@@ -658,15 +657,12 @@ def _modify_callable(
 
 
 def _remake_endpoint_dependencies(route: fastapi.routing.APIRoute):
-    route.dependant = get_dependant(path=route.path_format, call=route.endpoint)
+    # Unlike get_dependant, APIRoute is the public API of FastAPI and it's (almost) guaranteed to be stable.
+
+    route_copy = fastapi.routing.APIRoute(route.path, route.endpoint, dependencies=route.dependencies)
+    route.dependant = route_copy.dependant
+    route.body_field = route_copy.body_field
     _add_request_and_response_params(route)
-    route.body_field = get_body_field(dependant=route.dependant, name=route.unique_id)
-    for depends in route.dependencies[::-1]:
-        route.dependant.dependencies.insert(
-            0,
-            get_parameterless_sub_dependant(depends=depends, path=route.path_format),
-        )
-    route.app = request_response(route.get_route_handler())
 
 
 def _add_request_and_response_params(route: APIRoute):
@@ -681,7 +677,7 @@ def _add_data_migrations_to_route(
     head_route: Any,
     template_body_field: type[BaseModel] | None,
     template_body_field_name: str | None,
-    dependant_for_request_migrations: Dependant,
+    dependant_for_request_migrations: "Dependant",
     versions: VersionBundle,
 ):
     if not (route.dependant.request_param_name and route.dependant.response_param_name):  # pragma: no cover

{cadwyn-3.15.4 → cadwyn-3.15.6}/cadwyn/structure/versions.py

@@ -285,6 +285,8 @@ class VersionBundle:
             raise CadwynStructureError(
                 "Versions are not sorted correctly. Please sort them in descending order.",
             )
+        if not self.versions:
+            raise CadwynStructureError("You must define at least one non-head version in a VersionBundle.")
         if self.versions[-1].version_changes:
             raise CadwynStructureError(
                 f'The first version "{self.versions[-1].value}" cannot have any version changes. '
@@ -325,7 +327,7 @@ class VersionBundle:
             raise CadwynStructureError(
                 f'The head schemas package must be a package. "{head_schemas_package.__name__}" is not a package.',
             )
-        elif head_schemas_package.__name__.endswith(".head"):
+        elif head_schemas_package.__name__.endswith(".head") or head_schemas_package.__name__ == "head":
             return "head"
         elif head_schemas_package.__name__.endswith(".latest"):
             warnings.warn(
@@ -463,7 +465,6 @@ class VersionBundle:
         request.scope["headers"] = tuple((key.encode(), value.encode()) for key, value in request_info.headers.items())
         del request._headers
         # Remember this: if len(body_params) == 1, then route.body_schema == route.dependant.body_params[0]
-
         dependencies, errors, _, _, _ = await solve_dependencies(
             request=request,
             response=response,
@@ -803,7 +804,7 @@ async def _get_body(
         ) from e
     except HTTPException:
         raise
-    except Exception as e:  # noqa: BLE001
+    except Exception as e:
         raise HTTPException(status_code=400, detail="There was an error parsing the body") from e
     return body
 

{cadwyn-3.15.4 → cadwyn-3.15.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "3.15.4"
+version = "3.15.6"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
@@ -68,7 +68,6 @@ cli = ["typer"]
 pytest = ">=7.2.1"
 pytest-cov = ">=4.0.0"
 uvicorn = "*"
-devtools = "*"
 pdbpp = "^0.10.3"
 httpx = "*"
 pytest-fixture-classes = ">=1.0.3"
@@ -78,6 +77,8 @@ mkdocs-material = ">=9.3.1"
 python-multipart = ">=0.0.6"
 mkdocs-simple-hooks = ">=0.1.5"
 pytest-sugar = "^1.0.0"
+better-devtools = "^0.13.3"
+svcs = "^24.1.0"
 
 [tool.poetry.scripts]
 cadwyn = "cadwyn.__main__:app"