cadwyn 3.15.5__py3-none-any.whl → 3.15.6__py3-none-any.whl

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/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/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.5.dist-info → cadwyn-3.15.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 3.15.5
+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.5.dist-info → cadwyn-3.15.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-cadwyn/__init__.py,sha256=WcpJrRFaKcO28m0HeU8CpGcIVeApna2KjwlMtnEDhhg,549
+cadwyn/__init__.py,sha256=Wh_CtNgodacy8plxyDXCDb52CDftbql4jGXQ2pldX4s,605
 cadwyn/__main__.py,sha256=cc-5iYItjxRnB09uxuxlEbjrLm1AEhXI2KrI5iakEOw,4376
 cadwyn/_asts.py,sha256=OF1qQKPqTbgYhH1tYF-MB8CCU0r6YITZpMFegzmk0Ic,10118
 cadwyn/_compat.py,sha256=yAPmfGl2vVEYXlNHHPMoa2JkEJCVPjbP_Uz0WOIVOp4,5494
@@ -19,7 +19,7 @@ cadwyn/exceptions.py,sha256=aJKx1qgzZqShL4MX3COjS780qzNJcdZFeGzYYa5gbzw,1726
 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=nn_PWDa2WQOF-z3IOYBfG9K8po0tHm2C_Q0sRJRr5Ck,39843
+cadwyn/route_generation.py,sha256=mMfAy-5bz6JmW3JlzM1elG4CFrQgMWoUKLlnqXB5S00,39827
 cadwyn/routing.py,sha256=o6IMjxTxARPa5BxFfsXqOP3bVw9Ya6OBAEbUwH9lMVM,7445
 cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cadwyn/static/docs.html,sha256=WNm5ANJVy51TcIUFOaqKf1Z8eF86CC85TTHPxACtkzw,3455
@@ -30,9 +30,9 @@ cadwyn/structure/endpoints.py,sha256=JhTgVrqLjm5LkE9thjvU1UuWcSCmDgW2bMdqznsZb2Y
 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=PuXYze89tWvLsOOiuAQtYRi-p1ue2FPfBWWR2bl8hLg,37236
-cadwyn-3.15.5.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
-cadwyn-3.15.5.dist-info/METADATA,sha256=tMGbnU7byw_9yGiPDo-rM0V5gHCKVcVcSRiccCnwJsA,4397
-cadwyn-3.15.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-cadwyn-3.15.5.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
-cadwyn-3.15.5.dist-info/RECORD,,
+cadwyn/structure/versions.py,sha256=_NthvvuN7l01J-E2zCZmYtpJZjiVO-wqSDvMSFXhzno,37400
+cadwyn-3.15.6.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
+cadwyn-3.15.6.dist-info/METADATA,sha256=lZHxh7mAPk71OebTBR9qv-k6OU5oUnARbzFYbVWqV_k,4397
+cadwyn-3.15.6.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+cadwyn-3.15.6.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
+cadwyn-3.15.6.dist-info/RECORD,,