Debian Codegraph @

docs/examples/pagination/using_cursor_pagination.py

raw
1 import dataclasses
2 from typing import List, Optional, Tuple
3
4 from polyfactory.factories.dataclass_factory import DataclassFactory
5
6 from litestar import Litestar, get
7 from litestar.pagination import AbstractSyncCursorPaginator, CursorPagination
8 from litestar.params import FromQuery
9
10
11 @dataclasses.dataclass
12 class Person:
13 id: str
14 name: str
15
16
17 class PersonFactory(DataclassFactory[Person]):
18 __model__ = Person
19
20
21 # we will implement a paginator - the paginator must implement the method 'get_items'.
22
23
24 class PersonCursorPaginator(AbstractSyncCursorPaginator[str, Person]):
25 def __init__(self) -> None:
26 self.data = PersonFactory.batch(50)
27
28 def get_items(self, cursor: Optional[str], results_per_page: int) -> Tuple[List[Person], Optional[str]]:
29 results = self.data[:results_per_page]
30 return results, results[-1].id
31
32
33 paginator = PersonCursorPaginator()
34
35
36 # we now create a regular handler. The handler will receive a single query parameter - 'cursor', which
37 # we will pass to the paginator.
38 @get("/people", sync_to_thread=False)
39 def people_handler(cursor: FromQuery[Optional[str]], results_per_page: FromQuery[int]) -> CursorPagination[str, Person]:
40 return paginator(cursor=cursor, results_per_page=results_per_page)
41
42
43 app = Litestar(route_handlers=[people_handler])