cadwyn 5.1.0__tar.gz → 5.1.1__tar.gz

{cadwyn-5.1.0 → cadwyn-5.1.1}/CHANGELOG.md

@@ -5,6 +5,12 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [5.1.1]
+
+### Fixed
+
+* Support for `WithJsonSchema` in schema generation
+
 ## [5.1.0]
 
 ### Added

{cadwyn-5.1.0 → cadwyn-5.1.1}/PKG-INFO

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

@@ -264,10 +264,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()
     }
 

{cadwyn-5.1.0 → cadwyn-5.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cadwyn"
-version = "5.1.0"
+version = "5.1.1"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = [{ name = "Stanislav Zmiev", email = "zmievsa@gmail.com" }]
 license = "MIT"

{cadwyn-5.1.0 → cadwyn-5.1.1}/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.1/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.0 → cadwyn-5.1.1}/uv.lock

@@ -94,7 +94,7 @@ wheels = [
 
 [[package]]
 name = "cadwyn"
-version = "5.1.0"
+version = "5.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },