Debian Codegraph @

docs/examples/data_transfer_objects/factory/renaming_fields.py

raw
1 from datetime import datetime
2
3 from sqlalchemy.orm import Mapped, mapped_column
4 from typing_extensions import Annotated
5
6 from litestar import Litestar, post
7 from litestar.dto import DTOConfig, dto_field
8 from litestar.plugins.sqlalchemy import SQLAlchemyDTO
9
10 from .my_lib import Base
11
12
13 class User(Base):
14 name: Mapped[str]
15 password: Mapped[str] = mapped_column(info=dto_field("private"))
16 created_at: Mapped[datetime] = mapped_column(info=dto_field("read-only"))
17
18
19 config = DTOConfig(rename_fields={"name": "userName"})
20 UserDTO = SQLAlchemyDTO[Annotated[User, config]]
21
22
23 @post("/users", dto=UserDTO, sync_to_thread=False)
24 def create_user(data: User) -> User:
25 assert data.name == "Litestar User"
26 data.created_at = datetime.min
27 return data
28
29
30 app = Litestar(route_handlers=[create_user])
31
32 # run: /users -H "Content-Type: application/json" -d '{"userName":"Litestar User","password":"xyz","created_at":"2023-04-24T00:00:00Z"}'