python/sqlmodel
1
0
Fork 0
mirror of https://github.com/fastapi/sqlmodel.git synced 2026-03-13 09:29:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add deprecated param to Field, add tests

Browse Source
This commit is contained in:
Yurii Motov
2026-01-28 14:11:19 +01:00
parent 12ed8dc02f
commit 159838fc89
2 changed files with 35 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
tests/test_pydantic/test_field.py
View File

@@ -148,3 +148,30 @@ def test_examples_via_schema_extra(): # Current workaround. Remove after some t
model_schema = Model.model_json_schema()
assert model_schema["properties"]["name"]["examples"] == ["Alice", "Bob"]
def test_deprecated():
class Model(SQLModel):
old_field: str = Field(deprecated=True)
another_old_field: str = Field(deprecated="This field is deprecated")
model_schema = Model.model_json_schema()
assert model_schema["properties"]["old_field"]["deprecated"] is True
assert model_schema["properties"]["another_old_field"]["deprecated"] is True
def test_deprecated_via_schema_extra(): # Current workaround. Remove after some time
with pytest.warns(
DeprecationWarning,
match="Pass `deprecated` parameter directly to Field instead of passing it via `schema_extra`",
):
class Model(SQLModel):
old_field: str = Field(schema_extra={"deprecated": True})
another_old_field: str = Field(
schema_extra={"deprecated": "This field is deprecated"}
)
model_schema = Model.model_json_schema()
assert model_schema["properties"]["old_field"]["deprecated"] is True
assert model_schema["properties"]["another_old_field"]["deprecated"] is True