From 5658b92b4c99f57325ba745c0b86e39dc27b6eab Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 14:32:14 -0400 Subject: [PATCH 01/16] Pass None instead of the default value to parameters that accept it when null is given Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 16 ++++- tests/test_none_passed_when_null_received.py | 65 ++++++++++++++++++++ 2 files changed, 79 insertions(+), 2 deletions(-) create mode 100644 tests/test_none_passed_when_null_received.py diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 98ce17b55..8bc0f6016 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -2,6 +2,7 @@ import inspect from contextlib import AsyncExitStack, contextmanager from copy import copy, deepcopy from dataclasses import dataclass +import types from typing import ( Any, Callable, @@ -87,6 +88,8 @@ multipart_incorrect_install_error = ( "pip install python-multipart\n" ) +_unset: Any = object() + def ensure_multipart_is_installed() -> None: try: @@ -668,12 +671,21 @@ async def solve_dependencies( ) +def _accepts_none(field: ModelField) -> bool: + origin = get_origin(field.type_) + return (origin is Union or origin is types.UnionType) and type(None) in get_args( + field.type_ + ) + + def _validate_value_with_model_field( *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...] ) -> Tuple[Any, List[Any]]: - if value is None: + if value is None or value is _unset: if field.required: return None, [get_missing_field_error(loc=loc)] + elif value is None and _accepts_none(field): + return value, [] else: return deepcopy(field.default), [] v_, errors_ = field.validate(value, values, loc=loc) @@ -820,7 +832,7 @@ async def request_body_to_args( return {first_field.name: v_}, errors_ for field in body_fields: loc = ("body", field.alias) - value: Optional[Any] = None + value: Any = _unset if body_to_process is not None: try: value = body_to_process.get(field.alias) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py new file mode 100644 index 000000000..b2c4e8796 --- /dev/null +++ b/tests/test_none_passed_when_null_received.py @@ -0,0 +1,65 @@ +from typing import Optional, Union, Annotated + +from fastapi import FastAPI, Body +from fastapi.testclient import TestClient + +app = FastAPI() +SENTINEL = 1234567890 + + +@app.post("/api1") +def api1(integer_or_null: Annotated[int | None, Body(embed=True)] = SENTINEL) -> dict: + return {"received": integer_or_null} + + +@app.post("/api2") +def api2( + integer_or_null: Annotated[Optional[int], Body(embed=True)] = SENTINEL +) -> dict: + return {"received": integer_or_null} + + +@app.post("/api3") +def api3( + integer_or_null: Annotated[Union[int, None], Body(embed=True)] = SENTINEL +) -> dict: + return {"received": integer_or_null} + + +client = TestClient(app) + + +def test_api1_integer(): + response = client.post("/api1", json={"integer_or_null": 100}) + assert response.status_code == 200, response.text + assert response.json() == {"received": 100} + + +def test_api1_null(): + response = client.post("/api1", json={"integer_or_null": None}) + assert response.status_code == 200, response.text + assert response.json() == {"received": None} + + +def test_api2_integer(): + response = client.post("/api2", json={"integer_or_null": 100}) + assert response.status_code == 200, response.text + assert response.json() == {"received": 100} + + +def test_api2_null(): + response = client.post("/api2", json={"integer_or_null": None}) + assert response.status_code == 200, response.text + assert response.json() == {"received": None} + + +def test_api3_integer(): + response = client.post("/api3", json={"integer_or_null": 100}) + assert response.status_code == 200, response.text + assert response.json() == {"received": 100} + + +def test_api3_null(): + response = client.post("/api3", json={"integer_or_null": None}) + assert response.status_code == 200, response.text + assert response.json() == {"received": None} From ebc60c12a372198d67c7f1b151f01e7ff0c2f7c6 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 18:02:32 -0400 Subject: [PATCH 02/16] Pass None instead of the default value to parameters that accept it when null is given Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 27 ++++++----- fastapi/routing.py | 2 +- tests/test_none_passed_when_null_received.py | 47 ++++++-------------- 3 files changed, 29 insertions(+), 47 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 8bc0f6016..8a7728edd 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -88,8 +88,6 @@ multipart_incorrect_install_error = ( "pip install python-multipart\n" ) -_unset: Any = object() - def ensure_multipart_is_installed() -> None: try: @@ -549,7 +547,7 @@ async def solve_dependencies( *, request: Union[Request, WebSocket], dependant: Dependant, - body: Optional[Union[Dict[str, Any], FormData]] = None, + body: Optional[Union[Dict[str, Any], FormData]] = Undefined, background_tasks: Optional[StarletteBackgroundTasks] = None, response: Optional[Response] = None, dependency_overrides_provider: Optional[Any] = None, @@ -671,7 +669,7 @@ async def solve_dependencies( ) -def _accepts_none(field: ModelField) -> bool: +def _allows_none(field: ModelField) -> bool: origin = get_origin(field.type_) return (origin is Union or origin is types.UnionType) and type(None) in get_args( field.type_ @@ -681,11 +679,16 @@ def _accepts_none(field: ModelField) -> bool: def _validate_value_with_model_field( *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...] ) -> Tuple[Any, List[Any]]: - if value is None or value is _unset: + if value is Undefined: if field.required: return None, [get_missing_field_error(loc=loc)] - elif value is None and _accepts_none(field): + else: + return deepcopy(field.default), [] + if value is None: + if _allows_none(field): return value, [] + if field.required: + return None, [get_missing_field_error(loc=loc)] else: return deepcopy(field.default), [] v_, errors_ = field.validate(value, values, loc=loc) @@ -702,9 +705,9 @@ def _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any: if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)): value = values.getlist(field.alias) else: - value = values.get(field.alias, None) + value = values.get(field.alias, Undefined) if ( - value is None + value is Undefined or ( isinstance(field.field_info, params.Form) and isinstance(value, str) # For type checks @@ -713,7 +716,7 @@ def _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any: or (is_sequence_field(field) and len(value) == 0) ): if field.required: - return + return Undefined else: return deepcopy(field.default) return value @@ -799,7 +802,7 @@ async def _extract_form_body( for sub_value in value: tg.start_soon(process_fn, sub_value.read) value = serialize_sequence_value(field=field, value=results) - if value is not None: + if value is not Undefined and value is not None: values[field.name] = value return values @@ -832,10 +835,10 @@ async def request_body_to_args( return {first_field.name: v_}, errors_ for field in body_fields: loc = ("body", field.alias) - value: Any = _unset + value: Any = Undefined if body_to_process is not None: try: - value = body_to_process.get(field.alias) + value = body_to_process.get(field.alias, Undefined) # If the received body is a list, not a dict except AttributeError: errors.append(get_missing_field_error(loc)) diff --git a/fastapi/routing.py b/fastapi/routing.py index 86e303602..6f3c8fcf3 100644 --- a/fastapi/routing.py +++ b/fastapi/routing.py @@ -241,7 +241,7 @@ def get_request_handler( response: Union[Response, None] = None async with AsyncExitStack() as file_stack: try: - body: Any = None + body: Any = Undefined if body_field: if is_body_form: body = await request.form() diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index b2c4e8796..883ba9518 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -2,64 +2,43 @@ from typing import Optional, Union, Annotated from fastapi import FastAPI, Body from fastapi.testclient import TestClient +import pytest app = FastAPI() -SENTINEL = 1234567890 +DEFAULT = 1234567890 @app.post("/api1") -def api1(integer_or_null: Annotated[int | None, Body(embed=True)] = SENTINEL) -> dict: +def api1(integer_or_null: Annotated[int | None, Body(embed=True)] = DEFAULT) -> dict: return {"received": integer_or_null} @app.post("/api2") -def api2( - integer_or_null: Annotated[Optional[int], Body(embed=True)] = SENTINEL -) -> dict: +def api2(integer_or_null: Annotated[Optional[int], Body(embed=True)] = DEFAULT) -> dict: return {"received": integer_or_null} @app.post("/api3") def api3( - integer_or_null: Annotated[Union[int, None], Body(embed=True)] = SENTINEL + integer_or_null: Annotated[Union[int, None], Body(embed=True)] = DEFAULT ) -> dict: return {"received": integer_or_null} -client = TestClient(app) - - -def test_api1_integer(): - response = client.post("/api1", json={"integer_or_null": 100}) - assert response.status_code == 200, response.text - assert response.json() == {"received": 100} - - -def test_api1_null(): - response = client.post("/api1", json={"integer_or_null": None}) - assert response.status_code == 200, response.text - assert response.json() == {"received": None} - - -def test_api2_integer(): - response = client.post("/api2", json={"integer_or_null": 100}) - assert response.status_code == 200, response.text - assert response.json() == {"received": 100} +@app.post("/api4") +def api4(integer_or_null: Optional[int] = Body(embed=True, default=DEFAULT)) -> dict: + return {"received": integer_or_null} -def test_api2_null(): - response = client.post("/api2", json={"integer_or_null": None}) - assert response.status_code == 200, response.text - assert response.json() == {"received": None} +client = TestClient(app) -def test_api3_integer(): - response = client.post("/api3", json={"integer_or_null": 100}) +@pytest.mark.parametrize("api", ["/api1", "/api2", "/api3", "/api4"]) +def test_api1_integer(api): + response = client.post(api, json={"integer_or_null": 100}) assert response.status_code == 200, response.text assert response.json() == {"received": 100} - -def test_api3_null(): - response = client.post("/api3", json={"integer_or_null": None}) + response = client.post(api, json={"integer_or_null": None}) assert response.status_code == 200, response.text assert response.json() == {"received": None} From e3f6632fa013f8d138085256e853037910babadf Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 5 Sep 2024 22:49:17 +0000 Subject: [PATCH 03/16] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20f?= =?UTF-8?q?ormat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/dependencies/utils.py | 2 +- tests/test_none_passed_when_null_received.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 8a7728edd..b5e132f0e 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -1,8 +1,8 @@ import inspect +import types from contextlib import AsyncExitStack, contextmanager from copy import copy, deepcopy from dataclasses import dataclass -import types from typing import ( Any, Callable, diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 883ba9518..f4e171202 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -1,8 +1,8 @@ -from typing import Optional, Union, Annotated +from typing import Annotated, Optional, Union -from fastapi import FastAPI, Body -from fastapi.testclient import TestClient import pytest +from fastapi import Body, FastAPI +from fastapi.testclient import TestClient app = FastAPI() DEFAULT = 1234567890 @@ -20,7 +20,7 @@ def api2(integer_or_null: Annotated[Optional[int], Body(embed=True)] = DEFAULT) @app.post("/api3") def api3( - integer_or_null: Annotated[Union[int, None], Body(embed=True)] = DEFAULT + integer_or_null: Annotated[Union[int, None], Body(embed=True)] = DEFAULT, ) -> dict: return {"received": integer_or_null} From 63a1ff51c18cbf612ceebcb77c963d3f43a1b28d Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 21:21:48 -0400 Subject: [PATCH 04/16] fix linting errors Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index b5e132f0e..6d4ba84a1 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -27,6 +27,7 @@ from fastapi._compat import ( ModelField, Required, Undefined, + UndefinedType, _regenerate_error_with_loc, copy_field_info, create_body_model, @@ -547,7 +548,7 @@ async def solve_dependencies( *, request: Union[Request, WebSocket], dependant: Dependant, - body: Optional[Union[Dict[str, Any], FormData]] = Undefined, + body: Optional[Union[Dict[str, Any], FormData, UndefinedType]] = Undefined, background_tasks: Optional[StarletteBackgroundTasks] = None, response: Optional[Response] = None, dependency_overrides_provider: Optional[Any] = None, @@ -702,6 +703,7 @@ def _validate_value_with_model_field( def _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any: + value: Any if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)): value = values.getlist(field.alias) else: From 430e7c8efee1b5d5eff2ee399d9deb129496441d Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 21:35:50 -0400 Subject: [PATCH 05/16] fix lint errors Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 6d4ba84a1..a00888751 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -811,7 +811,7 @@ async def _extract_form_body( async def request_body_to_args( body_fields: List[ModelField], - received_body: Optional[Union[Dict[str, Any], FormData]], + received_body: Optional[Union[Dict[str, Any], FormData, UndefinedType]], embed_body_fields: bool, ) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]: values: Dict[str, Any] = {} @@ -838,7 +838,9 @@ async def request_body_to_args( for field in body_fields: loc = ("body", field.alias) value: Any = Undefined - if body_to_process is not None: + if body_to_process is not None and not isinstance( + body_to_process, UndefinedType + ): try: value = body_to_process.get(field.alias, Undefined) # If the received body is a list, not a dict From 41113e1199ad773677cf6aa5212c65b8f00c0aab Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 21:36:10 -0400 Subject: [PATCH 06/16] make tests compatible with Python 3.8 and 3.9 Signed-off-by: merlinz01 --- tests/test_none_passed_when_null_received.py | 46 ++++++++++++++------ 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index f4e171202..4d1b3b0a8 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -1,4 +1,5 @@ -from typing import Annotated, Optional, Union +import sys +from typing import Optional, Union import pytest from fastapi import Body, FastAPI @@ -7,22 +8,38 @@ from fastapi.testclient import TestClient app = FastAPI() DEFAULT = 1234567890 +endpoints = [] -@app.post("/api1") -def api1(integer_or_null: Annotated[int | None, Body(embed=True)] = DEFAULT) -> dict: - return {"received": integer_or_null} +if sys.hexversion >= 0x31000000: + from typing import Annotated + @app.post("/api1") + def api1( + integer_or_null: Annotated[int | None, Body(embed=True)] = DEFAULT, + ) -> dict: + return {"received": integer_or_null} -@app.post("/api2") -def api2(integer_or_null: Annotated[Optional[int], Body(embed=True)] = DEFAULT) -> dict: - return {"received": integer_or_null} + endpoints.append("/api1") -@app.post("/api3") -def api3( - integer_or_null: Annotated[Union[int, None], Body(embed=True)] = DEFAULT, -) -> dict: - return {"received": integer_or_null} +if sys.hexversion >= 0x30900000: + from typing import Annotated + + @app.post("/api2") + def api2( + integer_or_null: Annotated[Optional[int], Body(embed=True)] = DEFAULT, + ) -> dict: + return {"received": integer_or_null} + + endpoints.append("/api2") + + @app.post("/api3") + def api3( + integer_or_null: Annotated[Union[int, None], Body(embed=True)] = DEFAULT, + ) -> dict: + return {"received": integer_or_null} + + endpoints.append("/api3") @app.post("/api4") @@ -30,10 +47,13 @@ def api4(integer_or_null: Optional[int] = Body(embed=True, default=DEFAULT)) -> return {"received": integer_or_null} +endpoints.append("/api4") + + client = TestClient(app) -@pytest.mark.parametrize("api", ["/api1", "/api2", "/api3", "/api4"]) +@pytest.mark.parametrize("api", endpoints) def test_api1_integer(api): response = client.post(api, json={"integer_or_null": 100}) assert response.status_code == 200, response.text From d57cd4f379006db9d52ff2c523f6f4b933768999 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 21:58:36 -0400 Subject: [PATCH 07/16] make compatible with Python <3.10 and Pydantic v1 Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 21 ++++++++++++++------ tests/test_none_passed_when_null_received.py | 4 ++-- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index a00888751..531e708e8 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -1,4 +1,5 @@ import inspect +import sys import types from contextlib import AsyncExitStack, contextmanager from copy import copy, deepcopy @@ -669,12 +670,20 @@ async def solve_dependencies( dependency_cache=dependency_cache, ) - -def _allows_none(field: ModelField) -> bool: - origin = get_origin(field.type_) - return (origin is Union or origin is types.UnionType) and type(None) in get_args( - field.type_ - ) +if PYDANTIC_V2: + if sys.hexversion >= 0x30a00000: + def _allows_none(field: ModelField) -> bool: + origin = get_origin(field.type_) + return (origin is Union or origin is types.UnionType) and type(None) in get_args( + field.type_ + ) + else: + def _allows_none(field: ModelField) -> bool: + origin = get_origin(field.type_) + return origin is Union and type(None) in get_args(field.type_) +else: + def _allows_none(field: ModelField) -> bool: + return field.allow_none def _validate_value_with_model_field( diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 4d1b3b0a8..c4ce6f8b7 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -10,7 +10,7 @@ DEFAULT = 1234567890 endpoints = [] -if sys.hexversion >= 0x31000000: +if sys.hexversion >= 0x30a0000: from typing import Annotated @app.post("/api1") @@ -22,7 +22,7 @@ if sys.hexversion >= 0x31000000: endpoints.append("/api1") -if sys.hexversion >= 0x30900000: +if sys.hexversion >= 0x3090000: from typing import Annotated @app.post("/api2") From 69d3529a4a9a1721d0fa813941511b81720ee127 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:59:47 +0000 Subject: [PATCH 08/16] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20f?= =?UTF-8?q?ormat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/dependencies/utils.py | 16 ++++++++++------ tests/test_none_passed_when_null_received.py | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 531e708e8..4d78174fa 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -670,20 +670,24 @@ async def solve_dependencies( dependency_cache=dependency_cache, ) + if PYDANTIC_V2: - if sys.hexversion >= 0x30a00000: + if sys.hexversion >= 0x30A00000: + def _allows_none(field: ModelField) -> bool: origin = get_origin(field.type_) - return (origin is Union or origin is types.UnionType) and type(None) in get_args( - field.type_ - ) + return (origin is Union or origin is types.UnionType) and type( + None + ) in get_args(field.type_) else: + def _allows_none(field: ModelField) -> bool: origin = get_origin(field.type_) return origin is Union and type(None) in get_args(field.type_) else: - def _allows_none(field: ModelField) -> bool: - return field.allow_none + + def _allows_none(field: ModelField) -> bool: + return field.allow_none def _validate_value_with_model_field( diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index c4ce6f8b7..51d3991f0 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -10,7 +10,7 @@ DEFAULT = 1234567890 endpoints = [] -if sys.hexversion >= 0x30a0000: +if sys.hexversion >= 0x30A0000: from typing import Annotated @app.post("/api1") From 155905194b91814e3a259d95abaf40bc7d8e9822 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 22:10:42 -0400 Subject: [PATCH 09/16] fix Python version check Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 4d78174fa..21e35bc1a 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -672,7 +672,7 @@ async def solve_dependencies( if PYDANTIC_V2: - if sys.hexversion >= 0x30A00000: + if sys.hexversion >= 0x30A0000: def _allows_none(field: ModelField) -> bool: origin = get_origin(field.type_) From 84b6d8ed25149f673b71ef4f6ca4eaf0ef23666f Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 22:11:05 -0400 Subject: [PATCH 10/16] fix lint error Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 21e35bc1a..77dabe003 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -687,7 +687,7 @@ if PYDANTIC_V2: else: def _allows_none(field: ModelField) -> bool: - return field.allow_none + return field.allow_none # type: ignore def _validate_value_with_model_field( From 807e2716691f591b252b7c40c8cf44a9b5f003c5 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 22:37:03 -0400 Subject: [PATCH 11/16] reformat utils.py Signed-off-by: merlinz01 --- fastapi/dependencies/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 77dabe003..7d6cf10a4 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -687,7 +687,7 @@ if PYDANTIC_V2: else: def _allows_none(field: ModelField) -> bool: - return field.allow_none # type: ignore + return field.allow_none # type: ignore def _validate_value_with_model_field( From 48aca35d666319d0cfe6be311979dee63a00bfb3 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Thu, 5 Sep 2024 23:04:10 -0400 Subject: [PATCH 12/16] add test for required field and passing null Signed-off-by: merlinz01 --- tests/test_none_passed_when_null_received.py | 21 +++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 51d3991f0..796e92010 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -50,11 +50,15 @@ def api4(integer_or_null: Optional[int] = Body(embed=True, default=DEFAULT)) -> endpoints.append("/api4") +@app.post("/api5") +def api5(integer: int = Body(embed=True)) -> dict: + return {"received": integer} + client = TestClient(app) @pytest.mark.parametrize("api", endpoints) -def test_api1_integer(api): +def test_apis(api): response = client.post(api, json={"integer_or_null": 100}) assert response.status_code == 200, response.text assert response.json() == {"received": 100} @@ -62,3 +66,18 @@ def test_api1_integer(api): response = client.post(api, json={"integer_or_null": None}) assert response.status_code == 200, response.text assert response.json() == {"received": None} + + +def test_required_field(): + response = client.post("/api5", json={"integer": None}) + assert response.status_code == 422, response.text + assert response.json() == { + "detail": [ + { + "loc": ["body", "integer"], + "msg": "Field required", + "type": "missing", + "input": None, + } + ] + } From 32b8bd98ee48cb69930ad39b963095ceff9aba72 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 6 Sep 2024 03:04:48 +0000 Subject: [PATCH 13/16] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20f?= =?UTF-8?q?ormat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/test_none_passed_when_null_received.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 796e92010..1a0be42fd 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -54,6 +54,7 @@ endpoints.append("/api4") def api5(integer: int = Body(embed=True)) -> dict: return {"received": integer} + client = TestClient(app) From 85fc35cd5a0b18ef78543687ed9701d27930f330 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Fri, 6 Sep 2024 06:57:14 -0400 Subject: [PATCH 14/16] update required field test for Pydantic v1 Signed-off-by: merlinz01 --- tests/test_none_passed_when_null_received.py | 33 ++++++++++++++------ 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 1a0be42fd..868dd3350 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -2,6 +2,7 @@ import sys from typing import Optional, Union import pytest +from dirty_equals import IsDict from fastapi import Body, FastAPI from fastapi.testclient import TestClient @@ -72,13 +73,25 @@ def test_apis(api): def test_required_field(): response = client.post("/api5", json={"integer": None}) assert response.status_code == 422, response.text - assert response.json() == { - "detail": [ - { - "loc": ["body", "integer"], - "msg": "Field required", - "type": "missing", - "input": None, - } - ] - } + assert response.json() == IsDict( + { + "detail": [ + { + "loc": ["body", "integer"], + "msg": "Field required", + "type": "missing", + "input": None, + } + ] + } + ) | IsDict( + { + "detail": [ + { + "loc": ["body", "integer"], + "msg": "field required", + "type": "value_error.missing", + } + ] + } + ) From 304438a86609a804dbb410129d7ab2c0dd0a9290 Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Fri, 6 Sep 2024 07:04:14 -0400 Subject: [PATCH 15/16] add test for full coverage Signed-off-by: merlinz01 --- tests/test_none_passed_when_null_received.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/test_none_passed_when_null_received.py b/tests/test_none_passed_when_null_received.py index 868dd3350..3da094c6a 100644 --- a/tests/test_none_passed_when_null_received.py +++ b/tests/test_none_passed_when_null_received.py @@ -71,6 +71,10 @@ def test_apis(api): def test_required_field(): + response = client.post("/api5", json={"integer": 100}) + assert response.status_code == 200, response.text + assert response.json() == {"received": 100} + response = client.post("/api5", json={"integer": None}) assert response.status_code == 422, response.text assert response.json() == IsDict( From 4deab872f61353439c534c64383cf38cf2044a9a Mon Sep 17 00:00:00 2001 From: merlinz01 Date: Sat, 12 Oct 2024 21:59:00 -0400 Subject: [PATCH 16/16] update to make work with latest master changes --- fastapi/dependencies/utils.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py index 29810ecf1..5c62ac7dd 100644 --- a/fastapi/dependencies/utils.py +++ b/fastapi/dependencies/utils.py @@ -742,7 +742,7 @@ def _get_multidict_value( if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)): value = values.getlist(alias) else: - value = values.get(field.alias, Undefined) + value = values.get(alias, Undefined) if ( value is Undefined or ( @@ -793,7 +793,7 @@ def request_params_to_args( else field.name.replace("_", "-") ) value = _get_multidict_value(field, received_params, alias=alias) - if value is not None: + if value is not Undefined and value is not None: params_to_process[field.name] = value processed_keys.add(alias or field.alias) processed_keys.add(field.name)