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 examples param to Field, add tests

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

8
sqlmodel/main.py
View File

@@ -212,6 +212,7 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
examples: Optional[list[Any]] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
const: Optional[bool] = None,
@@ -256,6 +257,7 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
examples: Optional[list[Any]] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
const: Optional[bool] = None,
@@ -309,6 +311,7 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
examples: Optional[list[Any]] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
const: Optional[bool] = None,
@@ -343,6 +346,7 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
examples: Optional[list[Any]] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
const: Optional[bool] = None,
@@ -377,7 +381,7 @@ def Field(
) -> Any:
current_schema_extra = schema_extra or {}
for param_name in ("strict",):
for param_name in ("strict", "examples"):
if param_name in current_schema_extra:
msg = f"Pass `{param_name}` parameter directly to Field instead of passing it via `schema_extra`"
warnings.warn(msg, DeprecationWarning, stacklevel=2)
@@ -386,10 +390,12 @@ def Field(
schema_validation_alias = current_schema_extra.pop("validation_alias", None)
schema_serialization_alias = current_schema_extra.pop("serialization_alias", None)
current_strict = strict or current_schema_extra.pop("strict", None)
current_examples = examples or current_schema_extra.pop("examples", None)
field_info_kwargs = {
"alias": alias,
"title": title,
"description": description,
"examples": current_examples,
"exclude": exclude,
"include": include,
"const": const,

21
tests/test_pydantic/test_field.py
View File

@@ -127,3 +127,24 @@ def test_strict_via_schema_extra(): # Current workaround. Remove after some tim
with pytest.raises(ValidationError):
Model(val=123, val_strict="456")
def test_examples():
class Model(SQLModel):
name: str = Field(examples=["Alice", "Bob"])
model_schema = Model.model_json_schema()
assert model_schema["properties"]["name"]["examples"] == ["Alice", "Bob"]
def test_examples_via_schema_extra(): # Current workaround. Remove after some time
with pytest.warns(
DeprecationWarning,
match="Pass `examples` parameter directly to Field instead of passing it via `schema_extra`",
):
class Model(SQLModel):
name: str = Field(schema_extra={"examples": ["Alice", "Bob"]})
model_schema = Model.model_json_schema()
assert model_schema["properties"]["name"]["examples"] == ["Alice", "Bob"]