Debian Codegraph @

docs/examples/data_transfer_objects/defining_dtos_on_layers.py

raw
1 from __future__ import annotations
2
3 from dataclasses import dataclass, field
4 from typing import List
5 from uuid import UUID, uuid4
6
7 from litestar import Controller, delete, get, post, put
8 from litestar.app import Litestar
9 from litestar.dto import DataclassDTO
10 from litestar.dto.config import DTOConfig
11 from litestar.params import FromPath
12
13
14 @dataclass
15 class User:
16 name: str
17 email: str
18 age: int
19 id: UUID = field(default_factory=uuid4)
20
21
22 class UserWriteDTO(DataclassDTO[User]):
23 config = DTOConfig(exclude={"id"})
24
25
26 class UserReadDTO(DataclassDTO[User]): ...
27
28
29 class UserController(Controller):
30 dto = UserWriteDTO
31 return_dto = UserReadDTO
32
33 @post("/", sync_to_thread=False)
34 def create_user(self, data: User) -> User:
35 return data
36
37 @get("/", sync_to_thread=False)
38 def get_users(self) -> List[User]:
39 return [User(name="Mr Sunglass", email="[email protected]", age=30)]
40
41 @get("/{user_id:uuid}", sync_to_thread=False)
42 def get_user(self, user_id: FromPath[UUID]) -> User:
43 return User(id=user_id, name="Mr Sunglass", email="[email protected]", age=30)
44
45 @put("/{user_id:uuid}", sync_to_thread=False)
46 def update_user(self, data: User) -> User:
47 return data
48
49 @delete("/{user_id:uuid}", return_dto=None, sync_to_thread=False)
50 def delete_user(self, user_id: FromPath[UUID]) -> None:
51 return None
52
53
54 app = Litestar([UserController])