1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
from __future__ import annotations
from dataclasses import replace
from typing import TYPE_CHECKING, Generic, TypeVar
from msgspec import NODEFAULT, Struct, structs
from litestar.dto.base_dto import AbstractDTO
from litestar.dto.data_structures import DTOFieldDefinition
from litestar.dto.field import DTO_FIELD_META_KEY, DTOField
from litestar.types.empty import Empty
if TYPE_CHECKING:
from typing import Any, Collection, Generator
from litestar.typing import FieldDefinition
__all__ = ("MsgspecDTO",)
T = TypeVar("T", bound="Struct | Collection[Struct]")
class MsgspecDTO(AbstractDTO[T], Generic[T]):
"""Support for domain modelling with Msgspec."""
@classmethod
def generate_field_definitions(cls, model_type: type[Struct]) -> Generator[DTOFieldDefinition, None, None]:
msgspec_fields = {f.name: f for f in structs.fields(model_type)}
def default_or_empty(value: Any) -> Any:
return Empty if value is NODEFAULT else value
def default_or_none(value: Any) -> Any:
return None if value is NODEFAULT else value
for key, field_definition in cls.get_model_type_hints(model_type).items():
msgspec_field = msgspec_fields[key]
dto_field = (field_definition.extra or {}).pop(DTO_FIELD_META_KEY, DTOField())
yield replace(
DTOFieldDefinition.from_field_definition(
field_definition=field_definition,
dto_field=dto_field,
model_name=model_type.__name__,
default_factory=default_or_none(msgspec_field.default_factory),
),
default=default_or_empty(msgspec_field.default),
name=key,
)
@classmethod
def detect_nested_field(cls, field_definition: FieldDefinition) -> bool:
return field_definition.is_subclass_of(Struct)
|
