Debian Codegraph @

docs/examples/data_transfer_objects/factory/included_fields.py

raw
1 from datetime import datetime
2 from typing import List
3 from uuid import UUID
4
5 from sqlalchemy import ForeignKey
6 from sqlalchemy.orm import Mapped, mapped_column, relationship
7 from typing_extensions import Annotated
8
9 from litestar import Litestar, post
10 from litestar.dto import DTOConfig, dto_field
11 from litestar.plugins.sqlalchemy import SQLAlchemyDTO
12
13 from .my_lib import Base
14
15
16 class Address(Base):
17 street: Mapped[str]
18 city: Mapped[str]
19 state: Mapped[str]
20 zip: Mapped[str]
21
22
23 class Pets(Base):
24 name: Mapped[str]
25 user_id: Mapped[UUID] = mapped_column(ForeignKey("user.id"))
26
27
28 class User(Base):
29 name: Mapped[str]
30 password: Mapped[str] = mapped_column(info=dto_field("private"))
31 created_at: Mapped[datetime] = mapped_column(info=dto_field("read-only"))
32 address_id: Mapped[UUID] = mapped_column(ForeignKey("address.id"), info=dto_field("private"))
33 address: Mapped[Address] = relationship(info=dto_field("read-only"))
34 pets: Mapped[List[Pets]] = relationship(info=dto_field("read-only"))
35
36
37 UserDTO = SQLAlchemyDTO[User]
38 config = DTOConfig(
39 include={
40 "address.street",
41 "pets.0.name",
42 }
43 )
44 ReadUserDTO = SQLAlchemyDTO[Annotated[User, config]]
45
46
47 @post("/users", dto=UserDTO, return_dto=ReadUserDTO, sync_to_thread=False)
48 def create_user(data: User) -> User:
49 data.created_at = datetime.min
50 data.address = Address(street="123 Main St", city="Anytown", state="NY", zip="12345")
51 data.pets = [Pets(id=1, name="Fido"), Pets(id=2, name="Spot")]
52 return data
53
54
55 app = Litestar(route_handlers=[create_user])
56
57 # run: /users -H "Content-Type: application/json" -d '{"name":"Litestar User","password":"xyz","created_at":"2023-04-24T00:00:00Z"}'