Merge pull request #54 from team23/dev/fix-current-bugs

fix: Fix outstanding bugs, see #49 and #52

Author: ddanier

pydantic_partial/partial.py

@@ -37,8 +37,6 @@ class Something(PartialModelMixin, pydantic.BaseModel):
 
 import pydantic
 
-NULLABLE_KWARGS = {"json_schema_extra": {"nullable": True, "required": False}}
-
 SelfT = TypeVar("SelfT", bound=pydantic.BaseModel)
 ModelSelfT = TypeVar("ModelSelfT", bound="PartialModelMixin")
 
@@ -97,6 +95,8 @@ def _partial_annotation_arg(field_name_: str, field_annotation: type) -> type:
         if recursive or sub_fields_requested:
             field_annotation_origin = get_origin(field_annotation)
             if field_annotation_origin in (Union, UnionType, tuple, list, set, dict):
+                if field_annotation_origin is UnionType:
+                    field_annotation_origin = Union
                 field_annotation = field_annotation_origin[  # type: ignore
                     tuple(  # type: ignore
                         _partial_annotation_arg(field_name, field_annotation_arg)
@@ -123,7 +123,6 @@ def _partial_annotation_arg(field_name_: str, field_annotation: type) -> type:
                         field_info,
                         default=None,  # Set default to None
                         default_factory=None,  # Remove default_factory if set
-                        **NULLABLE_KWARGS,  # For API usage: set field as nullable and not required
                     ),
                 )
         elif recursive or sub_fields_requested:

pyproject.toml

@@ -17,6 +17,10 @@ pytest-cov = ">=3,<7"
 tox = ">=3.26,<5.0"
 ruff = ">=0.5.0,<0.13.0"
 pyright = ">=1.1.350,<1.2"
+fastapi = ">=0.116.0,<1"  # just for testing the compatibilty
+anyio = ">=4.9.0,<5.0.0"
+httpx = ">=0.28.1,<0.29.0"
+trio = ">=0.30.0,<0.31.0"
 
 [tool.ruff]
 line-length = 115

tests/test_fastapi_compatibility.py

@@ -0,0 +1,63 @@
+from typing import Annotated
+
+import fastapi
+import pydantic
+import pytest
+from httpx import ASGITransport, AsyncClient
+
+from pydantic_partial import PartialModelMixin
+
+
+class Something(PartialModelMixin, pydantic.BaseModel):
+    name: str
+
+
+class SomethingPartial(Something.model_as_partial()):
+    pass
+
+
+@pytest.fixture
+def app():
+    app = fastapi.FastAPI()
+
+    @app.post("/something")
+    async def something(data: Annotated[SomethingPartial, fastapi.Body()]) -> Something:
+        return Something(name=data.name if data.name else "Undefined")
+
+    return app
+
+
+@pytest.fixture
+async def client(app):
+    async with AsyncClient(
+        transport=ASGITransport(app=app),
+        base_url="http://test",
+    ) as client:
+        yield client
+
+
+def test_openapi_spec_can_be_generated(app):
+    assert app.openapi()
+
+
+@pytest.mark.anyio
+async def test_endpoint_accepts_partial_data(client):
+    response = await client.post(
+        "/something",
+        json={},
+    )
+
+    assert response.status_code == 200
+    assert response.json()["name"] == "Undefined"
+
+
+
+@pytest.mark.anyio
+async def test_endpoint_still_accepts_data(client):
+    response = await client.post(
+        "/something",
+        json={"name": "Some name"},
+    )
+
+    assert response.status_code == 200
+    assert response.json()["name"] == "Some name"

tests/test_partial_without_mixin.py

@@ -1,4 +1,4 @@
-import json
+import sys
 from typing import Union
 
 import pydantic
@@ -9,24 +9,28 @@
 
 def _field_is_required(model: Union[type[pydantic.BaseModel], pydantic.BaseModel], field_name: str) -> bool:
     """Check if a field is required on a pydantic V2 model."""
-    json_required = (
-        model.model_fields[field_name].json_schema_extra is not None
-        and model.model_fields[field_name].json_schema_extra.get("required", False)
-    )
-    return model.model_fields[field_name].is_required() or json_required
+
+    return model.model_fields[field_name].is_required()
 
 
 class Something(pydantic.BaseModel):
     name: str
     age: int
     already_optional: None = None
-    already_required: int = pydantic.Field(default=1, json_schema_extra={"required": True})
+    already_required: int = pydantic.Field(default=1)
 
 
 class SomethingWithMixin(PartialModelMixin, pydantic.BaseModel):
     name: str
 
 
+class SomethingWithUnionTypes(PartialModelMixin, pydantic.BaseModel):
+    name_as_union: Union[str, int]
+
+    if sys.version_info >= (3, 10):
+        name_as_uniontype: str | int
+
+
 def test_setup_is_sane():
     assert _field_is_required(Something, "name") is True
     assert _field_is_required(Something, "age") is True
@@ -62,12 +66,6 @@ def test_partial_model_will_be_the_same_on_mixin():
 
     assert SomethingWithMixinPartial1 is SomethingWithMixinPartial2
 
-def test_pydantic_v2_partial_model_will_override_json_required():
-    SomethingPartial = create_partial_model(Something)
-    assert _field_is_required(SomethingPartial, "already_required") is False
-    schema = SomethingPartial.model_json_schema()
-    assert schema["properties"]["already_required"]["nullable"] is True
-    assert schema["properties"]["already_required"]["required"] is False
 
 def test_partial_class_name_can_be_overridden():
     SomethingPartial = create_partial_model(Something, "name")
@@ -76,3 +74,7 @@ def test_partial_class_name_can_be_overridden():
     partial_cls_name = "SomethingWithOptionalName"
     SomethingWithOptionalName = create_partial_model(Something, "name", partial_cls_name=partial_cls_name)
     assert SomethingWithOptionalName.__name__ == partial_cls_name
+
+
+def test_recursive_on_unions_work():  # see https://github.com/team23/pydantic-partial/issues/52
+    create_partial_model(SomethingWithUnionTypes, recursive=True)

tox.ini

@@ -10,4 +10,8 @@ envlist =
 [testenv]
 deps =
     pytest
+    fastapi
+    anyio
+    httpx
+    trio
 commands = pytest