Skip to content

🐛 Fix alias support for Pydantic v2 #1577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ravishan16 wants to merge 16 commits into
base: main
Choose a base branch
from
Open

🐛 Fix alias support for Pydantic v2 #1577

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
785270a
feat: Add support for Pydantic v2 aliases
ravishan16 Sep 25, 2025
72e8c36
fix: Skip alias tests in Pydantic v1
ravishan16 Sep 25, 2025
15c7954
feat: Add support for Pydantic v2 aliases
ravishan16 Sep 25, 2025
3cc2b1e
fix: Skip alias tests in Pydantic v1
ravishan16 Sep 25, 2025
34d2a45
fix: Add Pydantic v2 alias support with backward compatibility
ravishan16 Sep 25, 2025
6667109
Apply suggestion from @YuriiMotov
ravishan16 Sep 30, 2025
382a52d
fix: move this outside of if..else.. block to avoid duplicati as per …
ravishan16 Sep 30, 2025
d3e761e
fix: Addressed yurii's comments
ravishan16 Sep 30, 2025
e3dbf75
Merge branch 'fastapi:main' into issue-1536-alias-pydantic-v2
ravishan16 Oct 8, 2025
e07a259
Update tests/test_aliases.py
ravishan16 Oct 8, 2025
6b7a0a1
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Oct 8, 2025
322c6af
Field: support schema_extra aliases (v2); add alias tests
ravishan16 Oct 9, 2025
6b13381
Field: support schema_extra aliases (v2); add alias tests
ravishan16 Oct 9, 2025
7b2bc2c
compat: drop redundant v2 check in post_init_field_info;
ravishan16 Oct 9, 2025
68b31d7
Simplify alias propagation logic for Pydantic v2
YuriiMotov Oct 9, 2025
9440956
Fix test name and avoid deprecation warnings
YuriiMotov Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: Add Pydantic v2 alias support with backward compatibility 
This commit fixes Field(alias="...") functionality in Pydantic v2 while
maintaining full backward compatibility with Pydantic v1.
  • Loading branch information
@ravishan16
ravishan16 committed Sep 25, 2025
commit 34d2a4500e26a62f7b9e30982eebd44538e08859
9 changes: 7 additions & 2 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,6 @@ def Field(
current_schema_extra = schema_extra or {}
field_info_kwargs = {
"alias": alias,
"validation_alias": validation_alias,
"serialization_alias": serialization_alias,
"title": title,
"description": description,
"exclude": exclude,
Expand Down Expand Up @@ -433,6 +431,13 @@ def Field(
**current_schema_extra,
}
if IS_PYDANTIC_V2:
# Add Pydantic v2 specific parameters
field_info_kwargs.update(
{
"validation_alias": validation_alias,
"serialization_alias": serialization_alias,
}
)
field_info = FieldInfo(
default,
default_factory=default_factory,
Expand Down
8 changes: 4 additions & 4 deletions tests/test_aliases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def test_dict_default_uses_field_names(
model: Union[Type[PydanticUser], Type[SQLModelUser]],
):
user = model(fullName="Dana")
data = user.model_dump()
data = user.dict()
assert "full_name" in data
assert "fullName" not in data
assert data["full_name"] == "Dana"
Expand All @@ -111,7 +111,7 @@ def test_dict_default_uses_aliases(
model: Union[Type[PydanticUser], Type[SQLModelUser]],
):
user = model(fullName="Dana")
data = user.model_dump(by_alias=True)
data = user.dict(by_alias=True)
assert "fullName" in data
assert "full_name" not in data
assert data["fullName"] == "Dana"
Expand All @@ -125,7 +125,7 @@ def test_json_by_alias(
model: Union[Type[PydanticUser], Type[SQLModelUser]],
):
user = model(fullName="Frank")
json_data = user.model_dump_json(by_alias=True)
json_data = user.json(by_alias=True)
assert ('"fullName":"Frank"' in json_data) or ('"fullName": "Frank"' in json_data)
assert "full_name" not in json_data

Expand Down Expand Up @@ -169,7 +169,7 @@ def test_serialize_with_serialization_alias(
model: Union[Type[PydanticUserV2], Type[SQLModelUserV2]],
):
user = model(firstName="Jane")
data = user.model_dump(by_alias=True)
data = user.dict(by_alias=True)
assert "f_name" in data
assert "firstName" not in data
assert "first_name" not in data
Expand Down
Loading