Coverage for tests/test_aliases.py: 100%
107 statements
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-16 00:02 +0000
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-16 00:02 +0000
1import pytest 1abcdefghijklm
2from pydantic import BaseModel, ValidationError 1abcdefghijklm
3from pydantic import Field as PField 1abcdefghijklm
4from sqlmodel import Field, SQLModel 1abcdefghijklm
6""" 1abcdefghijklm
7Alias tests for SQLModel and Pydantic compatibility
8"""
11class PydanticUser(BaseModel): 1abcdefghijklm
12 full_name: str = PField(alias="fullName") 1abcdefghijklm
15class SQLModelUser(SQLModel): 1abcdefghijklm
16 full_name: str = Field(alias="fullName") 1abcdefghijklm
19# Models with config (validate_by_name=True)
20class PydanticUserWithConfig(PydanticUser): 1abcdefghijklm
21 model_config = {"validate_by_name": True} 1abcdefghijklm
24class SQLModelUserWithConfig(SQLModelUser): 1abcdefghijklm
25 model_config = {"validate_by_name": True} 1abcdefghijklm
28@pytest.mark.parametrize("model", [PydanticUser, SQLModelUser]) 1abcdefghijklm
29def test_create_with_field_name(model: type[PydanticUser] | type[SQLModelUser]): 1abcdefghijklm
30 with pytest.raises(ValidationError): 22b3b4b5b6b7b8b9b!b#b$b%b'b
31 model(full_name="Alice") 22b3b4b5b6b7b8b9b!b#b$b%b'b
34@pytest.mark.parametrize("model", [PydanticUserWithConfig, SQLModelUserWithConfig]) 1abcdefghijklm
35def test_create_with_field_name_with_config( 1abcdefghijklm
36 model: type[PydanticUserWithConfig] | type[SQLModelUserWithConfig],
37):
38 user = model(full_name="Alice") 2(b)b*b+b,b-b.b/b:b;b=b?b@b
39 assert user.full_name == "Alice" 2(b)b*b+b,b-b.b/b:b;b=b?b@b
42@pytest.mark.parametrize( 1abcdefghijklm
43 "model",
44 [PydanticUser, SQLModelUser, PydanticUserWithConfig, SQLModelUserWithConfig],
45)
46def test_create_with_alias( 1abcdefghijklm
47 model: type[PydanticUser]
48 | type[SQLModelUser]
49 | type[PydanticUserWithConfig]
50 | type[SQLModelUserWithConfig],
51):
52 user = model(fullName="Bob") # using alias 2[b]b^b_b`b{b|b}b~bacbcccdc
53 assert user.full_name == "Bob" 2[b]b^b_b`b{b|b}b~bacbcccdc
56@pytest.mark.parametrize("model", [PydanticUserWithConfig, SQLModelUserWithConfig]) 1abcdefghijklm
57def test_create_with_both_prefers_alias( 1abcdefghijklm
58 model: type[PydanticUserWithConfig] | type[SQLModelUserWithConfig],
59):
60 user = model(full_name="IGNORED", fullName="Charlie") 2ecfcgchcicjckclcmcncocpcqc
61 assert user.full_name == "Charlie" # alias should take precedence 2ecfcgchcicjckclcmcncocpcqc
64@pytest.mark.parametrize("model", [PydanticUser, SQLModelUser]) 1abcdefghijklm
65def test_dict_default_uses_field_names( 1abcdefghijklm
66 model: type[PydanticUser] | type[SQLModelUser],
67):
68 user = model(fullName="Dana") 2? @ [ ] ^ _ ` { | } ~ abbb
69 data = user.model_dump() 2? @ [ ] ^ _ ` { | } ~ abbb
70 assert "full_name" in data 2? @ [ ] ^ _ ` { | } ~ abbb
71 assert "fullName" not in data 2? @ [ ] ^ _ ` { | } ~ abbb
72 assert data["full_name"] == "Dana" 2? @ [ ] ^ _ ` { | } ~ abbb
75@pytest.mark.parametrize("model", [PydanticUser, SQLModelUser]) 1abcdefghijklm
76def test_dict_by_alias_uses_aliases( 1abcdefghijklm
77 model: type[PydanticUser] | type[SQLModelUser],
78):
79 user = model(fullName="Dana") 2cbdbebfbgbhbibjbkblbmbnbob
80 data = user.model_dump(by_alias=True) 2cbdbebfbgbhbibjbkblbmbnbob
81 assert "fullName" in data 2cbdbebfbgbhbibjbkblbmbnbob
82 assert "full_name" not in data 2cbdbebfbgbhbibjbkblbmbnbob
83 assert data["fullName"] == "Dana" 2cbdbebfbgbhbibjbkblbmbnbob
86@pytest.mark.parametrize("model", [PydanticUser, SQLModelUser]) 1abcdefghijklm
87def test_json_by_alias( 1abcdefghijklm
88 model: type[PydanticUser] | type[SQLModelUser],
89):
90 user = model(fullName="Frank") 2pbqbrbsbtbubvbwbxbybzbAbBb
91 json_data = user.model_dump_json(by_alias=True) 2pbqbrbsbtbubvbwbxbybzbAbBb
92 assert ('"fullName":"Frank"' in json_data) or ('"fullName": "Frank"' in json_data) 2pbqbrbsbtbubvbwbxbybzbAbBb
93 assert "full_name" not in json_data 2pbqbrbsbtbubvbwbxbybzbAbBb
96class PydanticUserV2(BaseModel): 1abcdefghijklm
97 first_name: str = PField(validation_alias="firstName", serialization_alias="f_name") 1abcdefghijklm
100class SQLModelUserV2(SQLModel): 1abcdefghijklm
101 first_name: str = Field(validation_alias="firstName", serialization_alias="f_name") 1abcdefghijklm
104@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2]) 1abcdefghijklm
105def test_create_with_validation_alias( 1abcdefghijklm
106 model: type[PydanticUserV2] | type[SQLModelUserV2],
107):
108 user = model(firstName="John") 2rcsctcucvcwcxcyczcAcBcCcDc
109 assert user.first_name == "John" 2rcsctcucvcwcxcyczcAcBcCcDc
112@pytest.mark.parametrize("model", [PydanticUserV2, SQLModelUserV2]) 1abcdefghijklm
113def test_serialize_with_serialization_alias( 1abcdefghijklm
114 model: type[PydanticUserV2] | type[SQLModelUserV2],
115):
116 user = model(firstName="Jane") 1%'()*+,-./:;=
117 data = user.model_dump(by_alias=True) 1%'()*+,-./:;=
118 assert "f_name" in data 1%'()*+,-./:;=
119 assert "firstName" not in data 1%'()*+,-./:;=
120 assert "first_name" not in data 1%'()*+,-./:;=
121 assert data["f_name"] == "Jane" 1%'()*+,-./:;=
124def test_schema_extra_validation_alias_sqlmodel_v2(): 1abcdefghijklm
125 class M(SQLModel): 2CbDbEbFbGbHbIbJbKbLbMbNbOb
126 f: str = Field(schema_extra={"validation_alias": "f_alias"}) 2CbDbEbFbGbHbIbJbKbLbMbNbOb
128 m = M.model_validate({"f_alias": "asd"}) 2CbDbEbFbGbHbIbJbKbLbMbNbOb
129 assert m.f == "asd" 2CbDbEbFbGbHbIbJbKbLbMbNbOb
132def test_schema_extra_serialization_alias_sqlmodel_v2(): 1abcdefghijklm
133 class M(SQLModel): 1nopqrstuvwxyz
134 f: str = Field(schema_extra={"serialization_alias": "f_out"}) 1nopqrstuvwxyz
136 m = M(f="x") 1nopqrstuvwxyz
137 data = m.model_dump(by_alias=True) 1nopqrstuvwxyz
138 assert "f_out" in data 1nopqrstuvwxyz
139 assert "f" not in data 1nopqrstuvwxyz
140 assert data["f_out"] == "x" 1nopqrstuvwxyz
143def test_alias_plus_validation_alias_prefers_validation_alias_sqlmodel_v2(): 1abcdefghijklm
144 class M(SQLModel): 2PbQbRbSbTbUbVbWbXbYbZb0b1b
145 first_name: str = Field(alias="fullName", validation_alias="v_name") 2PbQbRbSbTbUbVbWbXbYbZb0b1b
147 m = M.model_validate({"fullName": "A", "v_name": "B"}) 2PbQbRbSbTbUbVbWbXbYbZb0b1b
148 assert m.first_name == "B" 2PbQbRbSbTbUbVbWbXbYbZb0b1b
151def test_alias_plus_serialization_alias_prefers_serialization_alias_sqlmodel_v2(): 1abcdefghijklm
152 class M(SQLModel): 1ABCDEFGHIJKLM
153 first_name: str = Field(alias="fullName", serialization_alias="f_name") 1ABCDEFGHIJKLM
155 m = M(fullName="Z") 1ABCDEFGHIJKLM
156 data = m.model_dump(by_alias=True) 1ABCDEFGHIJKLM
157 assert "f_name" in data 1ABCDEFGHIJKLM
158 assert "fullName" not in data 1ABCDEFGHIJKLM
159 assert data["f_name"] == "Z" 1ABCDEFGHIJKLM
162def test_alias_generator_works_sqlmodel_v2(): 1abcdefghijklm
163 class M(SQLModel): 1NOPQRSTUVWXYZ
164 model_config = {"alias_generator": lambda s: "gen_" + s} 1NOPQRSTUVWXYZ
165 f: str = Field() 1NOPQRSTUVWXYZ
167 m = M.model_validate({"gen_f": "ok"}) 1NOPQRSTUVWXYZ
168 assert m.f == "ok" 1NOPQRSTUVWXYZ
169 data = m.model_dump(by_alias=True) 1NOPQRSTUVWXYZ
170 assert "gen_f" in data and data["gen_f"] == "ok" 1NOPQRSTUVWXYZ
173def test_alias_generator_with_explicit_alias_prefers_field_alias_sqlmodel_v2(): 1abcdefghijklm
174 class M(SQLModel): 10123456789!#$
175 model_config = {"alias_generator": lambda s: "gen_" + s} 10123456789!#$
176 f: str = Field(alias="custom") 10123456789!#$
178 m = M.model_validate({"custom": "ok"}) 10123456789!#$
179 assert m.f == "ok" 10123456789!#$
180 data = m.model_dump(by_alias=True) 10123456789!#$
181 assert "custom" in data and "gen_f" not in data 10123456789!#$