cadwyn 5.1.0a1__tar.gz → 5.1.2__tar.gz

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/CHANGELOG.md

@@ -5,6 +5,22 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [5.1.2]
+
+### Fixed
+
+* Generators not being called when fastapi validates the initial request
+
+### Added
+
+* `cadwyn.current_dependency_solver` function to check whether cadwyn or fastapi is currently solving dependencies. It can be used as a dependency for versioned endpoints like so: `current_dependency_solver: Annotated[Literal["fastapi", "cadwyn"], Depends(current_dependency_solver)]`. If your dependency has side effects, you would likely want to only run it once per request. If you want to run it once we migrated the request to the latest version, you should only run it when `current_dependency_solver` is `"cadwyn"`. If you want your dependency to run at the very beginning of handling the request, you should only run it when `current_dependency_solver` is `"fastapi"`.
+
+## [5.1.1]
+
+### Fixed
+
+* Support for `WithJsonSchema` in schema generation
+
 ## [5.1.0]
 
 ### Added

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cadwyn
-Version: 5.1.0a1
+Version: 5.1.2
 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-5.1.0a1 → cadwyn-5.1.2}/cadwyn/__init__.py

@@ -2,6 +2,7 @@ import importlib.metadata
 
 from .applications import Cadwyn
 from .changelogs import hidden
+from .dependencies import current_dependency_solver
 from .route_generation import VersionedAPIRouter, generate_versioned_routers
 from .schema_generation import generate_versioned_models, migrate_response_body
 from .structure import (
@@ -32,6 +33,7 @@ __all__ = [
     "VersionedAPIRouter",
     "convert_request_to_next_version_for",
     "convert_response_to_previous_version_for",
+    "current_dependency_solver",
     "endpoint",
     "enum",
     "generate_versioned_models",

cadwyn-5.1.2/cadwyn/dependencies.py

@@ -0,0 +1,5 @@
+from cadwyn.structure.versions import _CURRENT_DEPENDENCY_SOLVER_OPTIONS, _CURRENT_DEPENDENCY_SOLVER_VAR
+
+
+async def current_dependency_solver() -> _CURRENT_DEPENDENCY_SOLVER_OPTIONS:
+    return _CURRENT_DEPENDENCY_SOLVER_VAR.get("fastapi")

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/cadwyn/schema_generation.py

@@ -20,6 +20,7 @@ import pydantic
 import pydantic._internal._decorators
 import typing_extensions
 from fastapi import Response
+from fastapi.dependencies.utils import is_async_gen_callable, is_coroutine_callable, is_gen_callable
 from fastapi.routing import APIRoute
 from pydantic import BaseModel, Field, RootModel
 from pydantic._internal import _decorators
@@ -77,6 +78,7 @@ from cadwyn.structure.versions import _CADWYN_REQUEST_PARAM_NAME, _CADWYN_RESPON
 if TYPE_CHECKING:
     from cadwyn.structure.versions import HeadVersion, Version, VersionBundle
 
+
 if sys.version_info >= (3, 10):
     from typing import _BaseGenericAlias  # pyright: ignore[reportAttributeAccessIssue]
 else:
@@ -264,10 +266,20 @@ def _wrap_pydantic_model(model: type[_T_PYDANTIC_MODEL]) -> "_PydanticModelWrapp
 
         wrapped_validator = _wrap_validator(decorator_wrapper.func, decorator_wrapper.shim, decorator_wrapper.info)
         validators[decorator_wrapper.cls_var_name] = wrapped_validator
+
+    def _rebuild_annotated(name: str):
+        if field_info := model.model_fields.get(name):
+            if not field_info.metadata:
+                return field_info.annotation
+
+            if sys.version_info >= (3, 13):
+                return Annotated.__getitem__((field_info.annotation, *field_info.metadata))  # pyright: ignore[reportAttributeAccessIssue]
+            else:
+                return Annotated.__class_getitem__((field_info.annotation, *field_info.metadata))  # pyright: ignore[reportAttributeAccessIssue]
+        return model.__annotations__[name]  # pragma: no cover
+
     annotations = {
-        name: value
-        if not isinstance(value, str)
-        else model.model_fields[name].annotation or model.__annotations__[name]
+        name: value if not isinstance(value, str) else _rebuild_annotated(name)
         for name, value in model.__annotations__.items()
     }
 
@@ -476,6 +488,7 @@ class _CallableWrapper:
         self._original_callable = original_callable
         if not is_regular_function(original_callable):
             original_callable = original_callable.__call__
+
         functools.update_wrapper(self, original_callable)
 
     @property
@@ -500,6 +513,17 @@ class _AsyncCallableWrapper(_CallableWrapper):
         return await self._original_callable(*args, **kwargs)
 
 
+class _GeneratorCallableWrapper(_CallableWrapper):
+    def __call__(self, *args: Any, **kwargs: Any):
+        yield from self._original_callable(*args, **kwargs)
+
+
+class _AsyncGeneratorCallableWrapper(_CallableWrapper):
+    async def __call__(self, *args: Any, **kwargs: Any):
+        async for value in self._original_callable(*args, **kwargs):
+            yield value
+
+
 @final
 class _AnnotationTransformer:
     def __init__(self, generator: "SchemaGenerator") -> None:
@@ -680,8 +704,12 @@ class _AnnotationTransformer:
             actual_call = call.__call__
         else:
             actual_call = call
-        if inspect.iscoroutinefunction(actual_call):
+        if is_async_gen_callable(actual_call):
+            return _AsyncGeneratorCallableWrapper(call)
+        elif is_coroutine_callable(actual_call):
             return _AsyncCallableWrapper(call)
+        elif is_gen_callable(actual_call):
+            return _GeneratorCallableWrapper(call)
         else:
             return _CallableWrapper(call)
 

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/cadwyn/structure/versions.py

@@ -23,7 +23,7 @@ from fastapi.routing import APIRoute, _prepare_response_content
 from pydantic import BaseModel
 from pydantic_core import PydanticUndefined
 from starlette._utils import is_async_callable
-from typing_extensions import Any, ParamSpec, TypeAlias, TypeVar, assert_never, deprecated, get_args
+from typing_extensions import Any, Literal, ParamSpec, TypeAlias, TypeVar, assert_never, deprecated, get_args
 
 from cadwyn._utils import classproperty
 from cadwyn.exceptions import (
@@ -51,6 +51,11 @@ _CADWYN_REQUEST_PARAM_NAME = "cadwyn_request_param"
 _CADWYN_RESPONSE_PARAM_NAME = "cadwyn_response_param"
 _P = ParamSpec("_P")
 _R = TypeVar("_R")
+_CURRENT_DEPENDENCY_SOLVER_OPTIONS = Literal["cadwyn", "fastapi"]
+_CURRENT_DEPENDENCY_SOLVER_VAR: ContextVar[_CURRENT_DEPENDENCY_SOLVER_OPTIONS] = ContextVar(
+    "cadwyn_dependencies_dry_run"
+)
+
 PossibleInstructions: TypeAlias = Union[
     AlterSchemaSubInstruction, AlterEndpointSubInstruction, AlterEnumSubInstruction, SchemaHadInstruction, staticmethod
 ]
@@ -276,6 +281,7 @@ class VersionBundle:
 
         if api_version_var is None:
             api_version_var = ContextVar("cadwyn_api_version")
+
         self.version_values = tuple(version.value for version in self.versions)
         self.reversed_version_values = tuple(reversed(self.version_values))
         self.api_version_var = api_version_var
@@ -379,6 +385,8 @@ class VersionBundle:
                             instruction(request_info)
         request.scope["headers"] = tuple((key.encode(), value.encode()) for key, value in request_info.headers.items())
         del request._headers
+        # This gives us the ability to tell the user whether cadwyn is running its dependencies or FastAPI
+        _CURRENT_DEPENDENCY_SOLVER_VAR.set("cadwyn")
         # Remember this: if len(body_params) == 1, then route.body_schema == route.dependant.body_params[0]
         result = await solve_dependencies(
             request=request,

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cadwyn"
-version = "5.1.0a1"
+version = "5.1.2"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = [{ name = "Stanislav Zmiev", email = "zmievsa@gmail.com" }]
 license = "MIT"
@@ -87,6 +87,7 @@ dev-dependencies = [
     "mike >=2.1.2, <3",
     "pdbpp>=0.10.3",
     "markdown-include-variants>=0.0.4",
+    "inline-snapshot>=0.20.7",
 ]
 
 [project.urls]
@@ -97,6 +98,8 @@ Documentation = "https://docs.cadwyn.dev"
 [project.scripts]
 cadwyn = "cadwyn.__main__:app"
 
+[tool.inline-snapshot]
+format-command = "ruff format --stdin-filename {filename}"
 
 [tool.coverage.run]
 parallel = true

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/tests/test_router_generation.py

@@ -13,12 +13,14 @@ from fastapi.routing import APIRoute
 from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
 from fastapi.security.http import HTTPBasic
 from fastapi.testclient import TestClient
+from inline_snapshot import snapshot
 from pydantic import BaseModel
 from pytest_fixture_classes import fixture_class
 from starlette.responses import FileResponse
 from typing_extensions import Any, NewType, TypeAlias, get_args
 
 from cadwyn import VersionBundle, VersionedAPIRouter
+from cadwyn.dependencies import current_dependency_solver
 from cadwyn.exceptions import CadwynError, RouterGenerationError, RouterPathParamsModifiedError
 from cadwyn.route_generation import generate_versioned_routers
 from cadwyn.schema_generation import generate_versioned_models
@@ -1205,6 +1207,60 @@ def test__basic_router_generation__subclass_of_security_class_based_dependency_w
     ]
 
 
+def test__router_generation__with_generator_dependencies(
+    router: VersionedAPIRouter,
+    create_versioned_app: CreateVersionedApp,
+):
+    dependency_cache = []
+
+    async def my_async_dependency(current_dependency_runner: Annotated[str, Depends(current_dependency_solver)]):
+        dependency_cache.append(f"{current_dependency_runner} async dependency start")
+        yield "async dependency"
+        dependency_cache.append(f"{current_dependency_runner} async dependency end")
+
+    def my_sync_dependency(current_dependency_runner: Annotated[str, Depends(current_dependency_solver)]):
+        dependency_cache.append(f"{current_dependency_runner} sync dependency start")
+        yield "sync dependency"
+        dependency_cache.append(f"{current_dependency_runner} sync dependency end")
+
+    @router.get("/test")
+    async def test(
+        my_async_dep: Annotated[str, Depends(my_async_dependency)],
+        my_sync_dep: Annotated[str, Depends(my_sync_dependency)],
+    ):
+        assert my_async_dep == "async dependency"
+        assert my_sync_dep == "sync dependency"
+
+    client = TestClient(create_versioned_app(version_change()))
+    assert client.get("/test", headers={"x-api-version": "2000-01-01"}).status_code == 200
+    assert dependency_cache == snapshot(
+        [
+            "fastapi async dependency start",
+            "fastapi sync dependency start",
+            "cadwyn async dependency start",
+            "cadwyn sync dependency start",
+            "cadwyn sync dependency end",
+            "cadwyn async dependency end",
+            "fastapi sync dependency end",
+            "fastapi async dependency end",
+        ]
+    )
+    dependency_cache.clear()
+    assert client.get("/test", headers={"x-api-version": "2001-01-01"}).status_code == 200
+    assert dependency_cache == snapshot(
+        [
+            "fastapi async dependency start",
+            "fastapi sync dependency start",
+            "cadwyn async dependency start",
+            "cadwyn sync dependency start",
+            "cadwyn sync dependency end",
+            "cadwyn async dependency end",
+            "fastapi sync dependency end",
+            "fastapi async dependency end",
+        ]
+    )
+
+
 ######################
 # External lib testing
 ######################

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/tests/test_router_generation_with_from_future_annotations.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
+from typing import Annotated
+
 from fastapi.testclient import TestClient
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, WithJsonSchema
 
 from cadwyn.applications import Cadwyn
 from cadwyn.route_generation import VersionedAPIRouter
@@ -12,6 +14,8 @@ from cadwyn.structure.versions import Version, VersionBundle, VersionChange
 class OuterSchema(BaseModel):
     bar: MySchema
 
+    extra_annotated: Annotated[str, WithJsonSchema({"type": "string", "description": "Hello"})] = ""
+
 
 class MySchema(BaseModel):
     foo: str = Field(coerce_numbers_to_str=True)
@@ -56,7 +60,7 @@ def test__router_generation__using_forwardref_outer_global_schema_in_body():
     unversioned_client = TestClient(app)
     client_2000 = TestClient(app, headers={app.router.api_version_parameter_name: "2000-01-01"})
     client_2001 = TestClient(app, headers={app.router.api_version_parameter_name: "2001-01-01"})
-    assert client_2000.post("/test2", json={"bar": {"foo": 1}}).json() == {"bar": {"foo": 1}}
-    assert client_2001.post("/test2", json={"bar": {"foo": 1}}).json() == {"bar": {"foo": "1"}}
+    assert client_2000.post("/test2", json={"bar": {"foo": 1}}).json() == {"bar": {"foo": 1}, "extra_annotated": ""}
+    assert client_2001.post("/test2", json={"bar": {"foo": 1}}).json() == {"bar": {"foo": "1"}, "extra_annotated": ""}
     assert unversioned_client.get("/openapi.json?version=2000-01-01").status_code == 200
     assert unversioned_client.get("/openapi.json?version=2001-01-01").status_code == 200

cadwyn-5.1.2/tests/test_schema_generation/test_schema_with_future_annotations.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import re
+from typing import Annotated
+
+import pytest
+from pydantic import BaseModel, WithJsonSchema
+from typing_extensions import TypeAlias
+
+from cadwyn.exceptions import InvalidGenerationInstructionError
+from cadwyn.structure.schemas import schema
+from tests.conftest import CreateRuntimeSchemas, assert_models_are_equal, version_change
+
+Foo: TypeAlias = int
+
+
+class MySchema(BaseModel):
+    foo: Foo
+    bar: Annotated[str, WithJsonSchema({"type": "string", "description": "Hi"})]
+
+
+def test__schema_had_name(create_runtime_schemas: CreateRuntimeSchemas):
+    schemas = create_runtime_schemas(version_change(schema(MySchema).had(name="Aww")))
+
+    assert_models_are_equal(schemas["2000-01-01"][MySchema], MySchema)
+    assert schemas["2000-01-01"][MySchema].__name__ == "Aww"
+    assert schemas["2000-01-01"][MySchema].__qualname__ == "Aww"
+
+
+def test__schema_had_name__with_the_same_name__should_raise_error(create_runtime_schemas: CreateRuntimeSchemas):
+    with pytest.raises(
+        InvalidGenerationInstructionError,
+        match=re.escape(
+            'You tried to change the name of "MySchema" in "MyVersionChange" '
+            "but it already has the name you tried to assign."
+        ),
+    ):
+        create_runtime_schemas(version_change(schema(MySchema).had(name="MySchema")))

{cadwyn-5.1.0a1 → cadwyn-5.1.2}/uv.lock

@@ -94,7 +94,7 @@ wheels = [
 
 [[package]]
 name = "cadwyn"
-version = "5.1.0a1"
+version = "5.1.2"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },
@@ -117,6 +117,7 @@ dev = [
     { name = "better-devtools" },
     { name = "dirty-equals" },
     { name = "httpx" },
+    { name = "inline-snapshot" },
     { name = "markdown-include-variants" },
     { name = "mdx-include" },
     { name = "mike" },
@@ -153,6 +154,7 @@ dev = [
     { name = "better-devtools", specifier = "~=0.13.3" },
     { name = "dirty-equals", specifier = ">=0.6.0" },
     { name = "httpx", specifier = ">=0.26.0" },
+    { name = "inline-snapshot", specifier = ">=0.20.7" },
     { name = "markdown-include-variants", specifier = ">=0.0.4" },
     { name = "mdx-include", specifier = "~=1.4.2" },
     { name = "mike", specifier = ">=2.1.2,<3" },
@@ -597,6 +599,21 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/ef/a6/62565a6e1cf69e10f5727360368e451d4b7f58beeac6173dc9db836a5b46/iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374", size = 5892 },
 ]
 
+[[package]]
+name = "inline-snapshot"
+version = "0.20.7"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "asttokens" },
+    { name = "executing" },
+    { name = "rich" },
+    { name = "tomli", marker = "python_full_version < '3.11'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/b0/41/9bd2ecd10ef789e8aff6fb68dcc7677dc31b33b2d27c306c0d40fc982fbc/inline_snapshot-0.20.7.tar.gz", hash = "sha256:d55bbb6254d0727dc304729ca7998cde1c1e984c4bf50281514aa9d727a56cf2", size = 92643 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/01/8f/1bf23da63ad1a0b14ca2d9114700123ef76732e375548f4f9ca94052817e/inline_snapshot-0.20.7-py3-none-any.whl", hash = "sha256:2df6dd8710d1f0def2c1f9d6c25fd03d7beba01f3addf52fc370343d9ee9959f", size = 48108 },
+]
+
 [[package]]
 name = "issubclass"
 version = "0.1.2"