fastapi 0.161.1__tar.gz → 0.162.0__tar.gz

{fastapi-0.161.1 → fastapi-0.162.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi
-Version: 0.161.1
+Version: 0.162.0
 Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
 Author-Email: Sebastián Ramírez <tiangolo@gmail.com>
 License-Expression: MIT

fastapi-0.162.0/docs_src/request_forms/tutorial002_an_py310.py

@@ -0,0 +1,10 @@
+from typing import Annotated
+
+from fastapi import FastAPI, Form
+
+app = FastAPI()
+
+
+@app.post("/preferences/")
+async def update_preferences(subscribe: Annotated[bool, Form()] = False):
+    return {"subscribe": subscribe}

fastapi-0.162.0/docs_src/request_forms/tutorial002_py310.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI, Form
+
+app = FastAPI()
+
+
+@app.post("/preferences/")
+async def update_preferences(subscribe: bool = Form(default=False)):
+    return {"subscribe": subscribe}

{fastapi-0.161.1 → fastapi-0.162.0}/fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.161.1"
+__version__ = "0.162.0"
 
 from starlette import status as status
 

{fastapi-0.161.1 → fastapi-0.162.0}/fastapi/dependencies/utils.py

@@ -1071,26 +1071,9 @@ def _extract_form_items(
     field_aliases: set[str] = set()
 
     for field in body_fields:
-        validation_alias = field.field_info.validation_alias
-        has_alias_path = isinstance(validation_alias, AliasPath) or (
-            isinstance(validation_alias, AliasChoices)
-            and any(
-                isinstance(choice, AliasPath) for choice in validation_alias.choices
-            )
-        )
-        aliases = [alias for alias, _ in _get_param_aliases(field)]
-        # Interpret missing boolean form fields as unchecked HTML checkboxes.
-        infer_false_if_missing = (
-            not has_alias_path
-            and field.field_info.annotation in (bool, bool | None)
-            and not any(alias in received_body for alias in aliases)
-        )
-        for alias in aliases:
+        for alias, _ in _get_param_aliases(field):
             field_aliases.add(alias)
-            if infer_false_if_missing:
-                value: Any = False
-            else:
-                value = _get_multidict_value(field, received_body, alias=alias)
+            value = _get_multidict_value(field, received_body, alias=alias)
             if value is not Undefined:
                 yield alias, value, field
                 # Leave later aliases unchanged for other fields or extra validation.
@@ -1141,7 +1124,7 @@ def _is_form_model_supplied(
     model: type[BaseModel],
     received_body: FormData,
 ) -> bool:
-    # Check raw keys before empty fields are removed or checkboxes inferred.
+    # Check raw keys before empty fields are removed.
     own_names = {
         alias
         for item in get_cached_model_fields(model)

{fastapi-0.161.1 → fastapi-0.162.0}/pyproject.toml

@@ -53,7 +53,7 @@ dependencies = [
     "annotated-doc>=0.0.2",
     "opentelemetry-api>=1.44.0",
 ]
-version = "0.161.1"
+version = "0.162.0"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/fastapi"

{fastapi-0.161.1 → fastapi-0.162.0}/tests/test_forms_multiple_models.py

@@ -232,7 +232,7 @@ def test_composed_form_models_forbid_extras(multipart, path):
     assert models["Preferences"]["additionalProperties"] is False
 
 
-def test_model_defaults_checkboxes_and_validators_are_independent():
+def test_model_defaults_and_validators_are_independent():
     app = FastAPI()
     inputs = []
 
@@ -274,9 +274,9 @@ def test_model_defaults_checkboxes_and_validators_are_independent():
     response = client.post("/")
     assert response.status_code == 200, response.text
     assert response.json() == {
-        "settings": {"label": "default", "enabled": False, "tags": []},
+        "settings": {"label": "default", "enabled": True, "tags": []},
         "other": {"label": "other", "enabled": "other"},
-        "fields_set": ["enabled"],
+        "fields_set": [],
         "other_fields_set": [],
     }
     response = client.post(

{fastapi-0.161.1 → fastapi-0.162.0}/tests/test_forms_multiple_unions.py

@@ -18,7 +18,7 @@ class Person(BaseModel):
     kind: Literal["person"] = Field(alias="contact_type")
     name: str
     tags: list[str] = Field(default_factory=list)
-    enabled: bool = True
+    enabled: bool = False
 
 
 class Company(BaseModel):
@@ -704,7 +704,7 @@ def test_json_and_original_model_schemas_are_unchanged():
         json={"contact": {"contact_type": "person", "name": "Rick"}, "token": "secret"},
     )
     assert response.status_code == 200, response.text
-    assert response.json()["enabled"] is True
+    assert response.json()["enabled"] is False
     schemas = app.openapi()["components"]["schemas"]
     assert set(schemas["Person"]["properties"]) == {
         "contact_type",

{fastapi-0.161.1 → fastapi-0.162.0}/tests/test_forms_optional_models.py

@@ -22,7 +22,7 @@ def test_optional_form_model():
         name: str
         age: int
         tags: list[str] = Field(default_factory=list)
-        enabled: bool = True
+        enabled: bool = False
 
     @app.post("/")
     def submit(profile: Annotated[Profile | None, Form()] = None):
@@ -114,7 +114,7 @@ def test_optional_form_model_multipart():
         name: str
         age: int
         tags: list[str] = Field(default_factory=list)
-        enabled: bool = True
+        enabled: bool = False
 
     @app.post("/")
     def submit(
@@ -176,7 +176,7 @@ def test_optional_form_model_schema(extra):
         name: str
         age: int
         tags: list[str] = Field(default_factory=list)
-        enabled: bool = True
+        enabled: bool = False
 
     @app.post("/")
     def submit(profile: Annotated[Profile | None, Form()] = None):
@@ -224,7 +224,7 @@ def test_optional_form_model_with_other_form_field_schema(extra):
         name: str
         age: int
         tags: list[str] = Field(default_factory=list)
-        enabled: bool = True
+        enabled: bool = False
 
     @app.post("/")
     def submit(
@@ -276,7 +276,7 @@ def test_unknown_fields_and_sibling_models(extra, required_name):
     class Profile(BaseModel):
         model_config = ConfigDict(extra=extra)
         name: str = Field() if required_name else Field("default")
-        enabled: bool = True
+        enabled: bool = False
 
     class Credentials(BaseModel):
         token: str
@@ -458,7 +458,7 @@ def test_defaults_factories_and_validators():
     calls.clear()
     response = client.post("/factory", data={"name": "submitted"})
     assert response.status_code == 200, response.text
-    assert response.json()["enabled"] is False
+    assert response.json()["enabled"] is True
     assert calls == ["submitted"]
     calls.clear()
     response = client.post("/validated-default")

{fastapi-0.161.1 → fastapi-0.162.0}/tests/test_forms_optional_unions.py

@@ -19,7 +19,7 @@ app = FastAPI()
 class TextForm(BaseModel):
     kind: Literal["text"]
     value: str
-    enabled: bool = True
+    enabled: bool = False
 
 
 class ListForm(BaseModel):
@@ -372,7 +372,7 @@ def test_defaults_factories_and_validators():
     calls.clear()
     response = client.post("/factory", data={"kind": "defaults"})
     assert response.status_code == 200, response.text
-    assert response.json() == {"kind": "defaults", "tags": [], "enabled": False}
+    assert response.json() == {"kind": "defaults", "tags": [], "enabled": True}
     assert calls == ["validated"]
     calls.clear()
     response = client.post("/validated-default")

{fastapi-0.161.1 → fastapi-0.162.0}/tests/test_request_params/test_form/test_nullable_and_defaults.py

@@ -721,39 +721,20 @@ def test_checked_checkbox_is_true(path):
     assert response.json() == {"value": True}
 
 
-@pytest.mark.parametrize(
-    "path",
-    [
-        "/parameter",
-        "/model",
-        "/parameter-default",
-        "/model-default",
-    ],
-)
+@pytest.mark.parametrize("path", ["/parameter", "/model"])
 def test_unchecked_checkbox_is_false(path):
     app = FastAPI()
 
     class Model(BaseModel):
-        value: bool
+        value: bool = False
 
     @app.post("/parameter")
-    def read_parameter(value: Annotated[bool, Form()]):
+    def read_parameter(value: Annotated[bool, Form()] = False):
         return {"value": value}
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
-
-    class ModelWithDefault(BaseModel):
-        value: bool = False
-
-    @app.post("/parameter-default")
-    def read_parameter_default(value: Annotated[bool, Form()] = False):
-        return {"value": value}
-
-    @app.post("/model-default")
-    def read_model_default(params: Annotated[ModelWithDefault, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     checked = client.post(path, data={"value": "on"})
@@ -769,7 +750,7 @@ def test_unchecked_checkbox_is_false(path):
     "data,expected",
     [
         pytest.param({"value": "on"}, True, id="checked"),
-        pytest.param({}, False, id="unchecked"),
+        pytest.param({}, True, id="omitted"),
     ],
 )
 def test_checkbox_with_true_default(path, data, expected):
@@ -784,7 +765,7 @@ def test_checkbox_with_true_default(path, data, expected):
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     response = client.post(path, data=data)
@@ -793,21 +774,15 @@ def test_checkbox_with_true_default(path, data, expected):
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
-@pytest.mark.parametrize(
-    "data,expected",
-    [
-        pytest.param({"value": "on"}, True, id="checked"),
-        pytest.param({}, False, id="unchecked"),
-    ],
-)
-def test_required_nullable_checkbox(path, data, expected):
+@pytest.mark.parametrize("annotation", [bool, bool | None])
+def test_omitted_required_boolean_is_missing(path, annotation):
     app = FastAPI()
 
     class Model(BaseModel):
-        value: bool | None
+        value: annotation
 
     @app.post("/parameter")
-    def read_parameter(value: Annotated[bool | None, Form()]):
+    def read_parameter(value: Annotated[annotation, Form()]):
         return {"value": value}
 
     @app.post("/model")
@@ -815,9 +790,14 @@ def test_required_nullable_checkbox(path, data, expected):
         return params.model_dump(exclude_unset=True)
 
     client = TestClient(app)
-    response = client.post(path, data=data)
+    response = client.post(path, data={"value": "on"})
     assert response.status_code == 200
-    assert response.json() == {"value": expected}
+    assert response.json() == {"value": True}
+    response = client.post(path)
+    assert response.status_code == 422
+    assert [(error["type"], error["loc"]) for error in response.json()["detail"]] == [
+        ("missing", ["body", "value"]),
+    ]
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
@@ -825,7 +805,7 @@ def test_required_nullable_checkbox(path, data, expected):
     "data,expected",
     [
         pytest.param({"value": "on"}, True, id="checked"),
-        pytest.param({}, False, id="unchecked"),
+        pytest.param({}, None, id="omitted"),
     ],
 )
 def test_nullable_checkbox_with_none_default(path, data, expected):
@@ -840,7 +820,7 @@ def test_nullable_checkbox_with_none_default(path, data, expected):
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     response = client.post(path, data=data)
@@ -852,10 +832,11 @@ def test_nullable_checkbox_with_none_default(path, data, expected):
     "data,expected",
     [
         pytest.param({"value": "on"}, True, id="checked"),
+        pytest.param({"value": "false"}, False, id="explicit-false"),
         pytest.param({}, False, id="unchecked"),
     ],
 )
-def test_checkbox_with_false_default_is_explicitly_set(data, expected):
+def test_checkbox_default_is_not_explicitly_set(data, expected):
     app = FastAPI()
 
     class Model(BaseModel):
@@ -864,6 +845,7 @@ def test_checkbox_with_false_default_is_explicitly_set(data, expected):
     @app.post("/")
     def read_model(params: Annotated[Model, Form()]):
         return {
+            "value": params.value,
             "fields_set": sorted(params.model_fields_set),
             "values": params.model_dump(exclude_unset=True),
         }
@@ -871,7 +853,11 @@ def test_checkbox_with_false_default_is_explicitly_set(data, expected):
     client = TestClient(app)
     response = client.post("/", data=data)
     assert response.status_code == 200
-    assert response.json() == {"fields_set": ["value"], "values": {"value": expected}}
+    assert response.json() == {
+        "value": expected,
+        "fields_set": ["value"] if data else [],
+        "values": {"value": expected} if data else {},
+    }
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
@@ -885,19 +871,19 @@ def test_checkbox_uses_alias(path, alias, validation_alias, data, expected):
     class Model(BaseModel):
         value: Annotated[
             bool, Field(alias=alias, validation_alias=validation_alias)
-        ] = True
+        ] = False
 
     @app.post("/parameter")
     def read_parameter(
         value: Annotated[
             bool, Form(alias=alias, validation_alias=validation_alias)
-        ] = True,
+        ] = False,
     ):
         return {"value": value}
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     response = client.post(path, data=data)
@@ -929,11 +915,11 @@ def test_checkbox_model_accepts_field_name(config, data, expected, validation_al
         model_config = config
         value: Annotated[
             bool, Field(alias="enabled", validation_alias=validation_alias)
-        ]
+        ] = False
 
     @app.post("/")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     response = client.post("/", data=data)
@@ -960,20 +946,20 @@ def test_checkbox_with_alias_choices(path, data, expected):
         value: Annotated[
             bool,
             Field(alias="legacy", validation_alias=AliasChoices("enabled", "checkbox")),
-        ]
+        ] = False
 
     @app.post("/parameter")
     def read_parameter(
         value: Annotated[
             bool,
             Form(alias="legacy", validation_alias=AliasChoices("enabled", "checkbox")),
-        ],
+        ] = False,
     ):
         return {"value": value}
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     response = client.post(path, data=data)
@@ -994,7 +980,7 @@ def test_checkbox_with_alias_choices(path, data, expected):
         ),
     ],
 )
-def test_unchecked_checkbox_with_alias_choices_overrides_defaults(config):
+def test_omitted_booleans_with_alias_choices_use_defaults(config):
     app = FastAPI()
 
     class Model(BaseModel):
@@ -1008,12 +994,18 @@ def test_unchecked_checkbox_with_alias_choices_overrides_defaults(config):
 
     @app.post("/")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return {
+            "values": params.model_dump(),
+            "fields_set": sorted(params.model_fields_set),
+        }
 
     client = TestClient(app)
     response = client.post("/")
     assert response.status_code == 200
-    assert response.json() == {"value": False, "nullable": False}
+    assert response.json() == {
+        "values": {"value": True, "nullable": None},
+        "fields_set": [],
+    }
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
@@ -1070,7 +1062,7 @@ def test_checkbox_alias_choices_preserve_validation_precedence(path):
         (AliasChoices("checkbox", AliasPath("enabled")), "checkbox"),
     ],
 )
-def test_checkbox_alias_path_is_unchanged(validation_alias, missing_name):
+def test_required_boolean_with_alias_path(validation_alias, missing_name):
     app = FastAPI()
 
     class Model(BaseModel):
@@ -1107,17 +1099,17 @@ def test_checkbox_in_multipart_form(path, checked):
 
     class Model(BaseModel):
         name: str
-        value: bool = True
+        value: bool = False
 
     @app.post("/parameter")
     def read_parameter(
-        name: Annotated[str, Form()], value: Annotated[bool, Form()] = True
+        name: Annotated[str, Form()], value: Annotated[bool, Form()] = False
     ):
         return {"name": name, "value": value}
 
     @app.post("/model")
     def read_model(params: Annotated[Model, Form()]):
-        return params.model_dump(exclude_unset=True)
+        return params.model_dump()
 
     client = TestClient(app)
     if checked:
@@ -1131,9 +1123,10 @@ def test_checkbox_in_multipart_form(path, checked):
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
-def test_unchecked_checkbox_is_validated_without_calling_default_factory(path):
+@pytest.mark.parametrize("validate_default", [False, True])
+def test_omitted_boolean_uses_default_factory(path, validate_default):
     app = FastAPI()
-    default_factory = Mock(return_value=True)
+    default_factory = Mock(return_value=False)
 
     def require_checked(value: bool) -> bool:
         if not value:
@@ -1144,13 +1137,15 @@ def test_unchecked_checkbox_is_validated_without_calling_default_factory(path):
         value: Annotated[
             bool,
             AfterValidator(require_checked),
-            Field(default_factory=default_factory),
+            Field(default_factory=default_factory, validate_default=validate_default),
         ]
 
     @app.post("/parameter")
     def read_parameter(
         value: Annotated[
-            bool, AfterValidator(require_checked), Form(default_factory=default_factory)
+            bool,
+            AfterValidator(require_checked),
+            Form(default_factory=default_factory, validate_default=validate_default),
         ],
     ):
         return value
@@ -1163,13 +1158,18 @@ def test_unchecked_checkbox_is_validated_without_calling_default_factory(path):
     checked = client.post(path, data={"value": "on"})
     assert checked.status_code == 200
     assert checked.json() is True
-    response = client.post(path)
-    assert response.status_code == 422
-    assert [
-        (error["type"], error["loc"], error["input"])
-        for error in response.json()["detail"]
-    ] == [("value_error", ["body", "value"], False)]
     default_factory.assert_not_called()
+    response = client.post(path)
+    if validate_default:
+        assert response.status_code == 422
+        assert [
+            (error["type"], error["loc"], error["input"])
+            for error in response.json()["detail"]
+        ] == [("value_error", ["body", "value"], False)]
+    else:
+        assert response.status_code == 200
+        assert response.json() is False
+    default_factory.assert_called_once_with()
 
 
 @pytest.mark.parametrize("path", ["/parameter", "/model"])
@@ -1214,8 +1214,10 @@ def test_form_does_not_change_required_model_fields():
     assert response.json() == {"value": True}
 
     response = client.post("/form")
-    assert response.status_code == 200
-    assert response.json() == {"value": False}
+    assert response.status_code == 422
+    assert [(error["type"], error["loc"]) for error in response.json()["detail"]] == [
+        ("missing", ["body", "value"]),
+    ]
 
     assert Model.model_fields["value"].is_required()
     with pytest.raises(ValidationError) as exc_info:

fastapi-0.162.0/tests/test_tutorial/test_request_forms/test_tutorial002.py

@@ -0,0 +1,22 @@
+import importlib
+
+import pytest
+from fastapi.testclient import TestClient
+
+
+@pytest.fixture(name="client", params=["tutorial002_py310", "tutorial002_an_py310"])
+def get_client(request: pytest.FixtureRequest):
+    mod = importlib.import_module(f"docs_src.request_forms.{request.param}")
+    return TestClient(mod.app)
+
+
+def test_unchecked_checkbox(client: TestClient):
+    response = client.post("/preferences/")
+    assert response.status_code == 200
+    assert response.json() == {"subscribe": False}
+
+
+def test_checked_checkbox(client: TestClient):
+    response = client.post("/preferences/", data={"subscribe": "on"})
+    assert response.status_code == 200
+    assert response.json() == {"subscribe": True}