mirror of https://github.com/tiangolo/fastapi.git
Fix: Make fields_set tests compatible with Pydantic v1 and v2
Rewrote test_forms_fields_set.py to work on both Pydantic versions: - Use PYDANTIC_V2 flag from fastapi._compat - Use model_fields_set (v2) or __fields_set__ (v1) appropriately - Removed field_validator which is v2-only - All tests now run on both versions for full coverage
This commit is contained in:
Adarsh Bennur
parent
5565461bbb
commit
40c75c51b1
|
|
@ -1,179 +1,139 @@
|
|||
"""
|
||||
Tests for Form fields preserving model_fields_set metadata.
|
||||
Related to issue #13399: https://github.com/fastapi/fastapi/issues/13399
|
||||
|
||||
This test validates that Form models correctly track which fields were
|
||||
explicitly provided vs. which fields use defaults.
|
||||
"""
|
||||
|
||||
from typing import Annotated
|
||||
|
||||
import pytest
|
||||
|
||||
# Skip this entire module if Pydantic v1 is installed
|
||||
# field_validator is a Pydantic v2-only API
|
||||
try:
|
||||
from pydantic import __version__ as pydantic_version
|
||||
|
||||
pydantic_major = int(pydantic_version.split(".")[0])
|
||||
if pydantic_major < 2:
|
||||
pytest.skip(
|
||||
"This test module requires Pydantic v2 (uses field_validator)",
|
||||
allow_module_level=True,
|
||||
)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
from fastapi import FastAPI, Form
|
||||
from fastapi._compat import PYDANTIC_V2
|
||||
from fastapi.testclient import TestClient
|
||||
from pydantic import BaseModel, field_validator
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
class ExampleModel(BaseModel):
|
||||
class FormModelFieldsSet(BaseModel):
|
||||
"""Model for testing fields_set metadata preservation."""
|
||||
|
||||
field_1: bool = True
|
||||
field_2: str = "default"
|
||||
field_3: int = 42
|
||||
|
||||
|
||||
class ExampleModelWithValidator(BaseModel):
|
||||
field_1: bool = True
|
||||
field_2: str = 0 # Intentionally wrong type to test validation
|
||||
|
||||
@field_validator("field_2")
|
||||
@classmethod
|
||||
def validate_field_2(cls, v):
|
||||
# This validator should only run if field_2 is explicitly provided
|
||||
if isinstance(v, int):
|
||||
raise ValueError("field_2 must be a string")
|
||||
return v
|
||||
|
||||
|
||||
app = FastAPI()
|
||||
|
||||
|
||||
@app.post("/body")
|
||||
async def body_endpoint(model: ExampleModel):
|
||||
return {"fields_set": list(model.model_fields_set)}
|
||||
@app.post("/form-fields-set")
|
||||
async def form_fields_set_endpoint(model: Annotated[FormModelFieldsSet, Form()]):
|
||||
# Use correct attribute name for each Pydantic version
|
||||
if PYDANTIC_V2:
|
||||
fields_set = list(model.model_fields_set)
|
||||
else:
|
||||
fields_set = list(model.__fields_set__)
|
||||
return {
|
||||
"fields_set": fields_set,
|
||||
"data": model.dict() if not PYDANTIC_V2 else model.model_dump(),
|
||||
}
|
||||
|
||||
|
||||
@app.post("/form")
|
||||
async def form_endpoint(model: Annotated[ExampleModel, Form()]):
|
||||
return {"fields_set": list(model.model_fields_set)}
|
||||
|
||||
|
||||
@app.post("/form-validator")
|
||||
async def form_validator_endpoint(model: Annotated[ExampleModelWithValidator, Form()]):
|
||||
return {"fields_set": list(model.model_fields_set)}
|
||||
@app.post("/body-fields-set")
|
||||
async def body_fields_set_endpoint(model: FormModelFieldsSet):
|
||||
# Use correct attribute name for each Pydantic version
|
||||
if PYDANTIC_V2:
|
||||
fields_set = list(model.model_fields_set)
|
||||
else:
|
||||
fields_set = list(model.__fields_set__)
|
||||
return {"fields_set": fields_set}
|
||||
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
def test_body_empty_fields_set():
|
||||
"""JSON body with no data should have empty fields_set."""
|
||||
resp = client.post("/body", json={})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == []
|
||||
class TestFormFieldsSetMetadata:
|
||||
"""Test that Form models correctly preserve fields_set metadata."""
|
||||
|
||||
def test_form_empty_data_has_empty_fields_set(self):
|
||||
"""Form with no data should have empty fields_set (matching JSON behavior)."""
|
||||
resp = client.post("/form-fields-set", data={})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == []
|
||||
|
||||
def test_form_empty_fields_set():
|
||||
"""Form with no data should have empty fields_set (matching JSON behavior)."""
|
||||
resp = client.post("/form", data={})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == []
|
||||
def test_body_empty_data_has_empty_fields_set(self):
|
||||
"""JSON body with no data should have empty fields_set."""
|
||||
resp = client.post("/body-fields-set", json={})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == []
|
||||
|
||||
def test_form_partial_data_tracks_provided_fields(self):
|
||||
"""Form with partial data should only show provided fields in fields_set."""
|
||||
resp = client.post("/form-fields-set", data={"field_1": "False"})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
def test_body_partial_fields_set():
|
||||
"""JSON body with partial data should only show provided fields in fields_set."""
|
||||
resp = client.post("/body", json={"field_1": False})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
def test_body_partial_data_tracks_provided_fields(self):
|
||||
"""JSON body with partial data should only show provided fields."""
|
||||
resp = client.post("/body-fields-set", json={"field_1": False})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
def test_form_all_fields_provided(self):
|
||||
"""Form with all fields should show all fields in fields_set."""
|
||||
resp = client.post(
|
||||
"/form-fields-set",
|
||||
data={"field_1": "False", "field_2": "test", "field_3": "100"},
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert set(fields_set) == {"field_1", "field_2", "field_3"}
|
||||
|
||||
def test_form_partial_fields_set():
|
||||
"""Form with partial data should only show provided fields in fields_set."""
|
||||
resp = client.post("/form", data={"field_1": "False"})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
def test_body_all_fields_provided(self):
|
||||
"""JSON body with all fields should show all fields in fields_set."""
|
||||
resp = client.post(
|
||||
"/body-fields-set",
|
||||
json={"field_1": False, "field_2": "test", "field_3": 100},
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert set(fields_set) == {"field_1", "field_2", "field_3"}
|
||||
|
||||
def test_form_field_set_to_default_value_is_tracked(self):
|
||||
"""Form field explicitly set to default value should appear in fields_set."""
|
||||
# Same as default=True, but explicitly provided
|
||||
resp = client.post("/form-fields-set", data={"field_1": "True"})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
def test_body_all_fields_set():
|
||||
"""JSON body with all fields should show all fields in fields_set."""
|
||||
resp = client.post(
|
||||
"/body", json={"field_1": False, "field_2": "test", "field_3": 100}
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert set(fields_set) == {"field_1", "field_2", "field_3"}
|
||||
def test_body_field_set_to_default_value_is_tracked(self):
|
||||
"""JSON body field explicitly set to default value should appear in fields_set."""
|
||||
resp = client.post("/body-fields-set", json={"field_1": True})
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
def test_form_body_consistency(self):
|
||||
"""
|
||||
Verify that body and form behave consistently.
|
||||
Form fields_set should match JSON body fields_set for equivalent data.
|
||||
"""
|
||||
# Empty data - both should have empty fields_set
|
||||
body_resp = client.post("/body-fields-set", json={})
|
||||
form_resp = client.post("/form-fields-set", data={})
|
||||
assert body_resp.json()["fields_set"] == []
|
||||
assert form_resp.json()["fields_set"] == []
|
||||
|
||||
def test_form_all_fields_set():
|
||||
"""Form with all fields should show all fields in fields_set."""
|
||||
resp = client.post(
|
||||
"/form", data={"field_1": "False", "field_2": "test", "field_3": "100"}
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert set(fields_set) == {"field_1", "field_2", "field_3"}
|
||||
|
||||
|
||||
def test_body_field_with_same_value_as_default():
|
||||
"""JSON body field explicitly set to default value should appear in fields_set."""
|
||||
resp = client.post("/body", json={"field_1": True}) # Same as default
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
|
||||
def test_form_field_with_same_value_as_default():
|
||||
"""Form field explicitly set to default value should appear in fields_set."""
|
||||
resp = client.post("/form", data={"field_1": "True"}) # Same as default
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == ["field_1"]
|
||||
|
||||
|
||||
def test_form_default_not_validated_when_not_provided():
|
||||
"""
|
||||
Form default values should NOT be validated when not provided.
|
||||
This test ensures validation is only run on explicitly provided fields.
|
||||
"""
|
||||
resp = client.post("/form-validator", data={})
|
||||
# Should succeed because field_2 default (0) should NOT be validated
|
||||
assert resp.status_code == 200, resp.text
|
||||
fields_set = resp.json()["fields_set"]
|
||||
assert fields_set == []
|
||||
|
||||
|
||||
def test_form_default_validated_when_provided():
|
||||
"""
|
||||
Form fields should be validated when explicitly provided, even if invalid.
|
||||
"""
|
||||
resp = client.post("/form-validator", data={"field_2": "0"})
|
||||
# Should fail validation because we're providing an integer-like string
|
||||
# But actually field_2 expects a string, so this should pass
|
||||
# Let's provide an actual int type by modifying the test
|
||||
assert resp.status_code == 200, resp.text
|
||||
|
||||
|
||||
def test_body_form_consistency():
|
||||
"""
|
||||
Verify that body and form behave consistently regarding fields_set.
|
||||
"""
|
||||
# Empty data
|
||||
body_resp = client.post("/body", json={})
|
||||
form_resp = client.post("/form", data={})
|
||||
assert body_resp.json()["fields_set"] == form_resp.json()["fields_set"] == []
|
||||
|
||||
# Partial data
|
||||
body_resp = client.post("/body", json={"field_1": False, "field_3": 99})
|
||||
form_resp = client.post("/form", data={"field_1": "False", "field_3": "99"})
|
||||
assert (
|
||||
set(body_resp.json()["fields_set"])
|
||||
== set(form_resp.json()["fields_set"])
|
||||
== {
|
||||
"field_1",
|
||||
"field_3",
|
||||
}
|
||||
)
|
||||
# Partial data - both should track same fields
|
||||
body_resp = client.post(
|
||||
"/body-fields-set", json={"field_1": False, "field_3": 99}
|
||||
)
|
||||
form_resp = client.post(
|
||||
"/form-fields-set", data={"field_1": "False", "field_3": "99"}
|
||||
)
|
||||
assert set(body_resp.json()["fields_set"]) == {"field_1", "field_3"}
|
||||
assert set(form_resp.json()["fields_set"]) == {"field_1", "field_3"}
|
||||
|
|
|
|||
Loading…
Reference in New Issue