分页¶

class litestar.pagination.AbstractAsyncClassicPaginator¶

基类：ABC, Generic[T]

异步经典分页的基础分页器类。实现此类以使用经典分页方案返回分页结果集。

abstractmethod async get_total(page_size: int) → int¶: 返回记录总数。 Args: page_size: 要返回的最大记录数。 Returns: 一个整数。

abstractmethod async get_items(page_size: int, current_page: int) → list[T]¶: 返回与 current_page 对应的、大小为 page_size 的项目列表。 Args: page_size: 要返回的最大记录数。 current_page: 要返回的当前结果页。 Returns: 项目列表。

async __call__(page_size: int, current_page: int) → ClassicPagination[T]¶: 返回分页结果集。 Args: page_size: 要返回的最大记录数。 current_page: 要返回的当前结果页。 Returns: 分页结果集。

class litestar.pagination.AbstractAsyncCursorPaginator¶

基类：ABC, Generic[C, T]

用于异步游标分页的基础分页器类。实现此类以使用游标分页方案返回分页结果集。

abstractmethod async get_items(cursor: C | None, results_per_page: int) → tuple[list[T], C | None]¶: 返回一个包含 results_per_page 个项目的列表，这些项目位于给定游标（如果存在）之后。 Args: cursor: 一个唯一标识符，作为应返回结果之后的“游标”。 results_per_page: 要返回的最大结果数量。 Returns: 一个元组，包含结果集和一个标记已检索最后记录的新游标。该新游标可用于请求下一批（'next_cursor'）结果。

async __call__(cursor: C | None, results_per_page: int) → CursorPagination[C, T]¶: 给定一个可选的游标（唯一 ID）和要返回的最大结果数，返回分页结果集。 Args: cursor: 一个唯一标识符，作为返回结果之后的“游标”。 results_per_page: 要返回的最大结果数。 Returns: 分页结果集。

class litestar.pagination.AbstractAsyncOffsetPaginator¶

基类：ABC, Generic[T]

用于限制/偏移分页的基础分页器类。实现此类以使用限制/偏移分页方案返回分页结果集。

abstractmethod async get_total() → int¶: 返回记录总数。 Returns: 一个整数。

abstractmethod async get_items(limit: int, offset: int) → list[T]¶: 返回从位置 offset 开始、大小为 limit 的项目列表。 Args: limit: 要返回的最大记录数。 offset: 结果集中的起始位置（假设索引 0 为起始位置）。 Returns: 项目列表。

async __call__(limit: int, offset: int) → OffsetPagination[T]¶: 返回分页结果集。 Args: limit: 要返回的最大记录数。 offset: 结果集中的起始位置（假设索引 0 为起始位置）。 Returns: 分页结果集。

class litestar.pagination.AbstractSyncClassicPaginator¶

基类：ABC, Generic[T]

同步经典分页的基础分页器类。实现此类以使用经典分页方案返回分页结果集。

abstractmethod get_total(page_size: int) → int¶: 返回记录总数。 Args: page_size: 要返回的最大记录数。 Returns: 一个整数。

abstractmethod get_items(page_size: int, current_page: int) → list[T]¶: 返回与 current_page 对应的、大小为 page_size 的项目列表。 Args: page_size: 要返回的最大记录数。 current_page: 要返回的当前结果页。 Returns: 项目列表。

__call__(page_size: int, current_page: int) → ClassicPagination[T]¶: 返回分页结果集。 Args: page_size: 要返回的最大记录数。 current_page: 要返回的当前结果页。 Returns: 分页结果集。

class litestar.pagination.AbstractSyncCursorPaginator¶

基类：ABC, Generic[C, T]

同步游标分页的基础分页器类。实现此类以使用游标分页方案返回分页结果集。

abstractmethod get_items(cursor: C | None, results_per_page: int) → tuple[list[T], C | None]¶: 返回一个包含 results_per_page 个项目的列表，这些项目位于给定游标（如果存在）之后。 Args: cursor: 一个唯一标识符，作为返回结果之后的“游标”。 results_per_page: 要返回的最大结果数量。 Returns: 一个元组，包含结果集和一个标记已检索最后记录的新游标。该新游标可用于请求下一批（'next_cursor'）结果。

__call__(cursor: C | None, results_per_page: int) → CursorPagination[C, T]¶: 给定一个可选的游标（唯一 ID）和要返回的最大结果数，返回分页结果集。 Args: cursor: 一个唯一标识符，作为返回结果之后的“游标”。 results_per_page: 要返回的最大结果数。 Returns: 分页结果集。

class litestar.pagination.AbstractSyncOffsetPaginator¶

基类：ABC, Generic[T]

用于限制/偏移分页的基础分页器类。实现此类以使用限制/偏移分页方案返回分页结果集。

abstractmethod get_total() → int¶: 返回记录总数。 Returns: 一个整数。

abstractmethod get_items(limit: int, offset: int) → list[T]¶: 返回从位置 offset 开始、大小为 limit 的项目列表。 Args: limit: 要返回的最大记录数。 offset: 结果集中的起始位置（假设索引 0 为起始位置）。 Returns: 项目列表。

__call__(limit: int, offset: int) → OffsetPagination[T]¶: 返回分页结果集。 Args: limit: 要返回的最大记录数。 offset: 结果集中的起始位置（假设索引 0 为起始位置）。 Returns: 分页结果集。

class litestar.pagination.ClassicPagination¶

基类：Generic[T]

使用 limit/offset 分页返回数据的容器。

items: List[T]¶: List of data being sent as part of the response.

page_size: int¶: Number of items per page.

current_page: int¶: Current page number.

total_pages: int¶: Total number of pages.

__init__(items: List[T], page_size: int, current_page: int, total_pages: int) → None¶

class litestar.pagination.CursorPagination¶

基类：Generic[C, T]

使用游标分页返回的数据的容器。

items: List[T]¶: List of data being sent as part of the response.

results_per_page: int¶: Maximal number of items to send.

cursor: C | None¶

Unique ID, designating the last identifier in the given data set.

This value can be used to request the "next" batch of records.

__init__(items: List[T], results_per_page: int, cursor: C | None) → None¶

class litestar.pagination.OffsetPagination¶

基类：Generic[T]

Container for data returned using limit/offset pagination.

items: Sequence[T]¶: List of data being sent as part of the response.

limit: int¶: Maximal number of items to send.

__init__(items: Sequence[T], limit: int, offset: int, total: int) → None¶

offset: int¶

Offset from the beginning of the query.

Identical to an index.

total: int¶: Total number of items.