From 905dfe90e44ac689527629e3d138615870935e86 Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:31:13 +0200 Subject: [PATCH 1/7] fix: Propagate Pydantic's model config --- fastapi/_compat.py | 8 ++++++-- tests/test_compat.py | 28 ++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/fastapi/_compat.py b/fastapi/_compat.py index 56c5d744e..9934288be 100644 --- a/fastapi/_compat.py +++ b/fastapi/_compat.py @@ -87,6 +87,7 @@ if PYDANTIC_V2: class ModelField: field_info: FieldInfo name: str + model_config: BaseConfig | None = None mode: Literal["validation", "serialization"] = "validation" @property @@ -108,7 +109,8 @@ if PYDANTIC_V2: def __post_init__(self) -> None: self._type_adapter: TypeAdapter[Any] = TypeAdapter( - Annotated[self.field_info.annotation, self.field_info] + Annotated[self.field_info.annotation, self.field_info], + config=self.model_config, ) def get_default(self) -> Any: @@ -282,7 +284,9 @@ if PYDANTIC_V2: def get_model_fields(model: Type[BaseModel]) -> List[ModelField]: return [ - ModelField(field_info=field_info, name=name) + ModelField( + field_info=field_info, name=name, model_config=model.model_config + ) for name, field_info in model.model_fields.items() ] diff --git a/tests/test_compat.py b/tests/test_compat.py index f4a3093c5..bca1598a4 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -80,6 +80,34 @@ def test_complex(): assert response2.json() == [1, 2] +def test_propagates_pydantic_model_config(): + app = FastAPI() + + class Missing: + def __bool__(self): + return False + + class Model(BaseModel): + model_config = ConfigDict( + arbitrary_types_allowed=True, + ) + value: str | Missing = Missing() + + @app.post("/") + def foo(req: Model) -> str | None: + return req.value or None + + client = TestClient(app) + + response = client.post("/", json={}) + assert response.status_code == 200, response.text + assert response.json() is None + + response2 = client.post("/", json={"value": "foo"}) + assert response2.status_code == 200, response2.text + assert response2.json() == "foo" + + def test_is_bytes_sequence_annotation_union(): # For coverage # TODO: in theory this would allow declaring types that could be lists of bytes From 357e008534da89056bf9f8b104029594ee1e6990 Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:34:02 +0200 Subject: [PATCH 2/7] fix: python3.8 compatibility --- tests/test_compat.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_compat.py b/tests/test_compat.py index bca1598a4..b50ac250a 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -91,7 +91,7 @@ def test_propagates_pydantic_model_config(): model_config = ConfigDict( arbitrary_types_allowed=True, ) - value: str | Missing = Missing() + value: Union[str, Missing] = Missing() @app.post("/") def foo(req: Model) -> str | None: From ff0b30f5b6be833d3082180cce3936037f60110c Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:36:45 +0200 Subject: [PATCH 3/7] fix: run test only for pydantic v2 --- tests/test_compat.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/test_compat.py b/tests/test_compat.py index b50ac250a..470a7050d 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -80,7 +80,8 @@ def test_complex(): assert response2.json() == [1, 2] -def test_propagates_pydantic_model_config(): +@needs_pydanticv2 +def test_propagates_pydantic2_model_config(): app = FastAPI() class Missing: From 6e4cce342184ba0c0838e89c66a48ce87b800da8 Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:40:16 +0200 Subject: [PATCH 4/7] fix: lint --- fastapi/_compat.py | 6 ++++-- fastapi/utils.py | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/fastapi/_compat.py b/fastapi/_compat.py index 9934288be..f7d91c06a 100644 --- a/fastapi/_compat.py +++ b/fastapi/_compat.py @@ -110,7 +110,7 @@ if PYDANTIC_V2: def __post_init__(self) -> None: self._type_adapter: TypeAdapter[Any] = TypeAdapter( Annotated[self.field_info.annotation, self.field_info], - config=self.model_config, + config=self.model_config, # type: ignore[arg-type] ) def get_default(self) -> Any: @@ -285,7 +285,9 @@ if PYDANTIC_V2: def get_model_fields(model: Type[BaseModel]) -> List[ModelField]: return [ ModelField( - field_info=field_info, name=name, model_config=model.model_config + field_info=field_info, + name=name, + model_config=model.model_config, # type: ignore[arg-type] ) for name, field_info in model.model_fields.items() ] diff --git a/fastapi/utils.py b/fastapi/utils.py index 4c7350fea..ef818782b 100644 --- a/fastapi/utils.py +++ b/fastapi/utils.py @@ -138,7 +138,7 @@ def create_cloned_field( new_field.class_validators = field.class_validators # type: ignore[attr-defined] new_field.default = field.default # type: ignore[misc] new_field.required = field.required # type: ignore[misc] - new_field.model_config = field.model_config # type: ignore[attr-defined] + new_field.model_config = field.model_config new_field.field_info = field.field_info new_field.allow_none = field.allow_none # type: ignore[attr-defined] new_field.validate_always = field.validate_always # type: ignore[attr-defined] From aae58b3b0bebfbbc728186760ef28cc08c72bddb Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:44:28 +0200 Subject: [PATCH 5/7] fix: python3.8 combatibility --- fastapi/_compat.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/_compat.py b/fastapi/_compat.py index f7d91c06a..93813c02e 100644 --- a/fastapi/_compat.py +++ b/fastapi/_compat.py @@ -87,7 +87,7 @@ if PYDANTIC_V2: class ModelField: field_info: FieldInfo name: str - model_config: BaseConfig | None = None + model_config: Union[BaseConfig, None] = None mode: Literal["validation", "serialization"] = "validation" @property From 1b933742256eac077f423c97d39c9825eafa3905 Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Mon, 21 Oct 2024 18:47:45 +0200 Subject: [PATCH 6/7] fix: python3.8 combatibility --- tests/test_compat.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_compat.py b/tests/test_compat.py index 470a7050d..0eccabd7f 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -95,7 +95,7 @@ def test_propagates_pydantic2_model_config(): value: Union[str, Missing] = Missing() @app.post("/") - def foo(req: Model) -> str | None: + def foo(req: Model) -> Union[str, None]: return req.value or None client = TestClient(app) From c7282a7eefc2e16134ed2a903ec1d4289876dd67 Mon Sep 17 00:00:00 2001 From: Nikita Zavadin Date: Wed, 23 Oct 2024 14:48:27 +0200 Subject: [PATCH 7/7] fix: better test case --- tests/test_compat.py | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/tests/test_compat.py b/tests/test_compat.py index 0eccabd7f..43c686489 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -88,25 +88,41 @@ def test_propagates_pydantic2_model_config(): def __bool__(self): return False + class EmbeddedModel(BaseModel): + model_config = ConfigDict(arbitrary_types_allowed=True) + value: Union[str, Missing] = Missing() + class Model(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, ) value: Union[str, Missing] = Missing() + embedded_model: EmbeddedModel = EmbeddedModel() @app.post("/") - def foo(req: Model) -> Union[str, None]: - return req.value or None + def foo(req: Model) -> Dict[str, Union[str, None]]: + return { + "value": req.value or None, + "embedded_value": req.embedded_model.value or None, + } client = TestClient(app) response = client.post("/", json={}) assert response.status_code == 200, response.text - assert response.json() is None + assert response.json() == { + "value": None, + "embedded_value": None, + } - response2 = client.post("/", json={"value": "foo"}) + response2 = client.post( + "/", json={"value": "foo", "embedded_model": {"value": "bar"}} + ) assert response2.status_code == 200, response2.text - assert response2.json() == "foo" + assert response2.json() == { + "value": "foo", + "embedded_value": "bar", + } def test_is_bytes_sequence_annotation_union():