Skip to content

Commit da87543

Browse files
cofincofin
authored
feat: additional tests and helper methods (#225)
* feat: additional tests and helper methods * feat: re-use functions * feat: simplify logic further
1 parent cfd5e1b commit da87543

File tree

5 files changed

+60
-25
lines changed

5 files changed

+60
-25
lines changed

‎advanced_alchemy/service/__init__.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,15 @@
1616
ModelDictT,
1717
ModelDTOT,
1818
is_dict,
19+
is_dict_with_field,
20+
is_dict_without_field,
1921
is_msgspec_model,
22+
is_msgspec_model_with_field,
23+
is_msgspec_model_without_field,
2024
is_pydantic_model,
25+
is_pydantic_model_with_field,
26+
is_pydantic_model_without_field,
27+
schema_dump,
2128
)
2229

2330
__all__ = (
@@ -34,8 +41,15 @@
3441
"find_filter",
3542
"ResultConverter",
3643
"is_dict",
44+
"is_dict_with_field",
45+
"is_dict_without_field",
3746
"is_msgspec_model",
47+
"is_pydantic_model_with_field",
48+
"is_msgspec_model_without_field",
3849
"is_pydantic_model",
50+
"is_msgspec_model_with_field",
51+
"is_pydantic_model_without_field",
52+
"schema_dump",
3953
"LoadSpec",
4054
"model_from_dict",
4155
"ModelT",

‎advanced_alchemy/service/typing.py

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222

2323
from typing_extensions import TypeAlias, TypeGuard
2424

25-
from advanced_alchemy.exceptions import AdvancedAlchemyError
2625
from advanced_alchemy.filters import StatementFilter # noqa: TCH001
2726
from advanced_alchemy.repository.typing import ModelT
2827

@@ -37,6 +36,8 @@
3736
class BaseModel(Protocol): # type: ignore[no-redef] # pragma: nocover
3837
"""Placeholder Implementation"""
3938

39+
model_fields: ClassVar[dict[str, Any]]
40+
4041
def model_dump(*args: Any, **kwargs: Any) -> dict[str, Any]:
4142
"""Placeholder"""
4243
return {}
@@ -108,24 +109,34 @@ def is_dict_without_field(v: Any, field_name: str) -> TypeGuard[dict[str, Any]]:
108109

109110

110111
def is_pydantic_model_with_field(v: Any, field_name: str) -> TypeGuard[BaseModel]:
111-
return PYDANTIC_INSTALLED and isinstance(v, BaseModel) and field_name in v.model_fields # pyright: ignore[reportAttributeAccessIssue,reportUnknownMemberType]
112+
return is_pydantic_model(v) and field_name in v.model_fields
113+
114+
115+
def is_pydantic_model_without_field(v: Any, field_name: str) -> TypeGuard[BaseModel]:
116+
return not is_pydantic_model_with_field(v, field_name)
112117

113118

114119
def is_msgspec_model_with_field(v: Any, field_name: str) -> TypeGuard[Struct]:
115-
return MSGSPEC_INSTALLED and isinstance(v, Struct) and field_name in v.__struct_fields__
120+
return is_msgspec_model(v) and field_name in v.__struct_fields__
121+
122+
123+
def is_msgspec_model_without_field(v: Any, field_name: str) -> TypeGuard[Struct]:
124+
return not is_msgspec_model_with_field(v, field_name)
116125

117126

118-
def schema_to_dict(v: Any, exclude_unset: bool = True) -> dict[str, Any]:
119-
if is_dict(v):
120-
return v
121-
if is_pydantic_model(v):
122-
return v.model_dump(exclude_unset=exclude_unset)
123-
if is_msgspec_model(v) and exclude_unset:
124-
return {f: val for f in v.__struct_fields__ if (val := getattr(v, f, None)) != UNSET}
125-
if is_msgspec_model(v) and not exclude_unset:
126-
return {f: getattr(v, f, None) for f in v.__struct_fields__}
127-
msg = f"Unable to convert model to dictionary for '{type(v)}' types"
128-
raise AdvancedAlchemyError(msg)
127+
def schema_dump(
128+
data: dict[str, Any] | ModelT | Struct | BaseModel,
129+
exclude_unset: bool = True,
130+
) -> dict[str, Any] | ModelT:
131+
if is_dict(data):
132+
return data
133+
if is_pydantic_model(data):
134+
return data.model_dump(exclude_unset=exclude_unset)
135+
if is_msgspec_model(data) and exclude_unset:
136+
return {f: val for f in data.__struct_fields__ if (val := getattr(data, f, None)) != UNSET}
137+
if is_msgspec_model(data) and not exclude_unset:
138+
return {f: getattr(data, f, None) for f in data.__struct_fields__}
139+
return cast("ModelT", data)
129140

130141

131142
__all__ = (
@@ -143,9 +154,12 @@ def schema_to_dict(v: Any, exclude_unset: bool = True) -> dict[str, Any]:
143154
"UNSET",
144155
"is_dict",
145156
"is_dict_with_field",
157+
"is_dict_without_field",
146158
"is_msgspec_model",
147159
"is_pydantic_model_with_field",
160+
"is_msgspec_model_without_field",
148161
"is_pydantic_model",
149162
"is_msgspec_model_with_field",
150-
"schema_to_dict",
163+
"is_pydantic_model_without_field",
164+
"schema_dump",
151165
)

‎tests/fixtures/bigint/services.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
SQLAlchemyAsyncRepositoryService,
99
SQLAlchemySyncRepositoryService,
1010
)
11-
from advanced_alchemy.service.typing import ModelDictT, is_dict_with_field, is_dict_without_field, schema_to_dict
11+
from advanced_alchemy.service.typing import ModelDictT, is_dict_with_field, is_dict_without_field, schema_dump
1212
from tests.fixtures.bigint.models import (
1313
BigIntAuthor,
1414
BigIntBook,
@@ -228,7 +228,7 @@ async def to_model(
228228
data: ModelDictT[BigIntSlugBook],
229229
operation: str | None = None,
230230
) -> BigIntSlugBook:
231-
data = schema_to_dict(data)
231+
data = schema_dump(data)
232232
if is_dict_without_field(data, "slug") and operation == "create":
233233
data["slug"] = await self.repository.get_available_slug(data["title"])
234234
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -250,7 +250,7 @@ def to_model(
250250
data: ModelDictT[BigIntSlugBook],
251251
operation: str | None = None,
252252
) -> BigIntSlugBook:
253-
data = schema_to_dict(data)
253+
data = schema_dump(data)
254254
if is_dict_without_field(data, "slug") and operation == "create":
255255
data["slug"] = self.repository.get_available_slug(data["title"])
256256
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -272,7 +272,7 @@ async def to_model(
272272
data: ModelDictT[BigIntSlugBook],
273273
operation: str | None = None,
274274
) -> BigIntSlugBook:
275-
data = schema_to_dict(data)
275+
data = schema_dump(data)
276276
if is_dict_without_field(data, "slug") and operation == "create":
277277
data["slug"] = await self.repository.get_available_slug(data["title"])
278278
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -294,7 +294,7 @@ def to_model(
294294
data: ModelDictT[BigIntSlugBook],
295295
operation: str | None = None,
296296
) -> BigIntSlugBook:
297-
data = schema_to_dict(data)
297+
data = schema_dump(data)
298298
if is_dict_without_field(data, "slug") and operation == "create":
299299
data["slug"] = self.repository.get_available_slug(data["title"])
300300
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":

‎tests/fixtures/uuid/services.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
PydanticOrMsgspecT,
1313
is_dict_with_field,
1414
is_dict_without_field,
15-
schema_to_dict,
15+
schema_dump,
1616
)
1717
from tests.fixtures.uuid.models import (
1818
UUIDAuthor,
@@ -229,7 +229,7 @@ async def to_model(
229229
data: UUIDSlugBook | dict[str, Any] | PydanticOrMsgspecT,
230230
operation: str | None = None,
231231
) -> UUIDSlugBook:
232-
data = schema_to_dict(data)
232+
data = schema_dump(data)
233233
if is_dict_without_field(data, "slug") and operation == "create":
234234
data["slug"] = await self.repository.get_available_slug(data["title"])
235235
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -250,7 +250,7 @@ def to_model(
250250
data: UUIDSlugBook | dict[str, Any] | PydanticOrMsgspecT,
251251
operation: str | None = None,
252252
) -> UUIDSlugBook:
253-
data = schema_to_dict(data)
253+
data = schema_dump(data)
254254
if is_dict_without_field(data, "slug") and operation == "create":
255255
data["slug"] = self.repository.get_available_slug(data["title"])
256256
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -272,7 +272,7 @@ async def to_model(
272272
data: UUIDSlugBook | dict[str, Any] | PydanticOrMsgspecT,
273273
operation: str | None = None,
274274
) -> UUIDSlugBook:
275-
data = schema_to_dict(data)
275+
data = schema_dump(data)
276276
if is_dict_without_field(data, "slug") and operation == "create":
277277
data["slug"] = await self.repository.get_available_slug(data["title"])
278278
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":
@@ -294,7 +294,7 @@ def to_model(
294294
data: UUIDSlugBook | dict[str, Any] | PydanticOrMsgspecT,
295295
operation: str | None = None,
296296
) -> UUIDSlugBook:
297-
data = schema_to_dict(data)
297+
data = schema_dump(data)
298298
if is_dict_without_field(data, "slug") and operation == "create":
299299
data["slug"] = self.repository.get_available_slug(data["title"])
300300
if is_dict_without_field(data, "slug") and is_dict_with_field(data, "title") and operation == "update":

‎tests/integration/test_sqlquery_service.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
from advanced_alchemy.service.typing import (
2121
is_msgspec_model,
2222
is_msgspec_model_with_field,
23+
is_msgspec_model_without_field,
2324
is_pydantic_model,
2425
is_pydantic_model_with_field,
26+
is_pydantic_model_without_field,
2527
)
2628
from advanced_alchemy.utils.fixtures import open_fixture, open_fixture_async
2729

@@ -161,6 +163,7 @@ def test_sync_fixture_and_query() -> None:
161163
assert isinstance(_pydantic_obj, StateQueryBaseModel)
162164
assert is_pydantic_model(_pydantic_obj)
163165
assert is_pydantic_model_with_field(_pydantic_obj, "state_abbreviation")
166+
assert not is_pydantic_model_without_field(_pydantic_obj, "state_abbreviation")
164167

165168
_msgspec_obj = query_service.to_schema(
166169
data=_get_one_or_none_1,
@@ -169,6 +172,7 @@ def test_sync_fixture_and_query() -> None:
169172
assert isinstance(_msgspec_obj, StateQueryStruct)
170173
assert is_msgspec_model(_msgspec_obj)
171174
assert is_msgspec_model_with_field(_msgspec_obj, "state_abbreviation")
175+
assert not is_msgspec_model_without_field(_msgspec_obj, "state_abbreviation")
172176

173177
_get_one_or_none = query_service.repository.get_one_or_none(
174178
statement=select(StateQuery).filter_by(state_name="Nope"),
@@ -234,6 +238,8 @@ async def test_async_fixture_and_query() -> None:
234238
assert isinstance(_pydantic_obj, StateQueryBaseModel)
235239
assert is_pydantic_model(_pydantic_obj)
236240
assert is_pydantic_model_with_field(_pydantic_obj, "state_abbreviation")
241+
assert not is_pydantic_model_without_field(_pydantic_obj, "state_abbreviation")
242+
237243
_msgspec_obj = query_service.to_schema(
238244
data=_get_one_or_none_1,
239245
schema_type=StateQueryStruct,
@@ -244,4 +250,5 @@ async def test_async_fixture_and_query() -> None:
244250
_get_one_or_none = await query_service.repository.get_one_or_none(
245251
select(StateQuery).filter_by(state_name="Nope"),
246252
)
253+
assert not is_msgspec_model_without_field(_msgspec_obj, "state_abbreviation")
247254
assert _get_one_or_none is None

0 commit comments

Comments
 (0)