Debian Codegraph @

docs/examples/contrib/piccolo/app.py

raw
1 from typing import List
2
3 from piccolo.columns import Boolean, Varchar
4 from piccolo.table import Table, create_db_tables
5
6 from litestar import Litestar, MediaType, delete, get, patch, post
7 from litestar.contrib.piccolo import PiccoloDTO
8 from litestar.dto import DTOConfig, DTOData
9 from litestar.exceptions import NotFoundException
10 from litestar.params import FromPath
11
12 from .piccolo_conf import DB
13
14
15 class Task(Table, db=DB):
16 """
17 An example table.
18 """
19
20 name = Varchar()
21 completed = Boolean(default=False)
22
23
24 class PatchDTO(PiccoloDTO[Task]):
25 """Allow partial updates."""
26
27 config = DTOConfig(exclude={"id"}, partial=True)
28
29
30 @get(
31 "/tasks",
32 return_dto=PiccoloDTO[Task],
33 media_type=MediaType.JSON,
34 tags=["Task"],
35 )
36 async def tasks() -> List[Task]:
37 return await Task.select().order_by(Task.id, ascending=False)
38
39
40 @post(
41 "/tasks",
42 dto=PiccoloDTO[Task],
43 return_dto=PiccoloDTO[Task],
44 media_type=MediaType.JSON,
45 tags=["Task"],
46 )
47 async def create_task(data: Task) -> Task:
48 await data.save()
49 await data.refresh()
50 return data
51
52
53 @patch(
54 "/tasks/{task_id:int}",
55 dto=PatchDTO,
56 return_dto=PiccoloDTO[Task],
57 media_type=MediaType.JSON,
58 tags=["Task"],
59 )
60 async def update_task(task_id: FromPath[int], data: DTOData[Task]) -> Task:
61 task = await Task.objects().get(Task.id == task_id)
62 if not task:
63 raise NotFoundException("Task does not exist")
64 result = data.update_instance(task)
65 await result.save()
66 return result
67
68
69 @delete("/tasks/{task_id:int}", tags=["Task"])
70 async def delete_task(task_id: FromPath[int]) -> None:
71 task = await Task.objects().get(Task.id == task_id)
72 if not task:
73 raise NotFoundException("Task does not exist")
74 await task.remove()
75
76
77 async def on_startup():
78 await create_db_tables(Task, if_not_exists=True)
79
80
81 app = Litestar(route_handlers=[tasks, create_task, delete_task, update_task], on_startup=[on_startup], debug=True)