Skip to content

🏷️ Allow AliasChoices and AliasPath for validation_alias in Field #1728

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
YuriiMotov wants to merge 1 commit into
base: main
Choose a base branch
from
+46 −7
Open

🏷️ Allow AliasChoices and AliasPath for validation_alias in Field #1728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions sqlmodel/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
__version__ = "0.0.31"

# Re-export from Pydantic
from pydantic import AliasChoices as AliasChoices
from pydantic import AliasPath as AliasPath

# Re-export from SQLAlchemy
from sqlalchemy.engine import create_engine as create_engine
from sqlalchemy.engine import create_mock_engine as create_mock_engine
Expand Down
10 changes: 5 additions & 5 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
overload,
)

from pydantic import BaseModel, EmailStr
from pydantic import AliasChoices, AliasPath, BaseModel, EmailStr
from pydantic.fields import FieldInfo as PydanticFieldInfo
from sqlalchemy import (
Boolean,
Expand Down Expand Up @@ -207,7 +207,7 @@ def Field(
*,
default_factory: Optional[NoArgAnyCallable] = None,
alias: Optional[str] = None,
validation_alias: Optional[str] = None,
validation_alias: Union[str, AliasPath, AliasChoices, None] = None,
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
Expand Down Expand Up @@ -250,7 +250,7 @@ def Field(
*,
default_factory: Optional[NoArgAnyCallable] = None,
alias: Optional[str] = None,
validation_alias: Optional[str] = None,
validation_alias: Union[str, AliasPath, AliasChoices, None] = None,
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
Expand Down Expand Up @@ -302,7 +302,7 @@ def Field(
*,
default_factory: Optional[NoArgAnyCallable] = None,
alias: Optional[str] = None,
validation_alias: Optional[str] = None,
validation_alias: Union[str, AliasPath, AliasChoices, None] = None,
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
Expand Down Expand Up @@ -335,7 +335,7 @@ def Field(
*,
default_factory: Optional[NoArgAnyCallable] = None,
alias: Optional[str] = None,
validation_alias: Optional[str] = None,
validation_alias: Union[str, AliasPath, AliasChoices, None] = None,
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
Expand Down
39 changes: 37 additions & 2 deletions tests/test_aliases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
from typing import Union
from typing import Optional, Union

import pytest
from pydantic import AliasChoices as PAliasChoices
from pydantic import AliasPath as PAliasPath
from pydantic import BaseModel, ValidationError
from pydantic import Field as PField
from sqlmodel import Field, SQLModel
from sqlmodel import AliasChoices, AliasPath, Field, SQLModel

"""
Alias tests for SQLModel and Pydantic compatibility
Expand Down Expand Up @@ -99,10 +101,22 @@ def test_json_by_alias(

class PydanticUserV2(BaseModel):
first_name: str = PField(validation_alias="firstName", serialization_alias="f_name")
second_name: Optional[str] = PField(
default=None, validation_alias=PAliasChoices("secondName", "surname")
)
nickname: Optional[str] = PField(
default=None, validation_alias=PAliasPath("names", 2)
)


class SQLModelUserV2(SQLModel):
first_name: str = Field(validation_alias="firstName", serialization_alias="f_name")
second_name: Optional[str] = Field(
default=None, validation_alias=AliasChoices("secondName", "surname")
)
nickname: Optional[str] = Field(
default=None, validation_alias=AliasPath("names", 2)
)


@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2])
Expand All @@ -113,6 +127,27 @@ def test_create_with_validation_alias(
assert user.first_name == "John"


@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2])
def test_create_with_validation_alias_alias_choices(
model: Union[type[PydanticUserV2], type[SQLModelUserV2]],
):
user = model.model_validate({"firstName": "John", "secondName": "Doe"})
assert user.second_name == "Doe"

user2 = model.model_validate({"firstName": "John", "surname": "Doe"})
assert user2.second_name == "Doe"


@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2])
def test_create_with_validation_alias_alias_path(
model: Union[type[PydanticUserV2], type[SQLModelUserV2]],
):
user = model.model_validate(
{"firstName": "John", "names": ["John", "Doe", "Johnny"]}
)
assert user.nickname == "Johnny"


@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2])
def test_serialize_with_serialization_alias(
model: Union[type[PydanticUserV2], type[SQLModelUserV2]],
Expand Down