raito.plugins.pagination.paginators.protocol module¶

class raito.plugins.pagination.paginators.protocol.IPaginator(*args, **kwargs)[исходный код]¶

Базовые классы: Protocol

Protocol for paginator implementations.

Defines the interface that all paginator classes must implement.

property current_page: int¶

Get current page number.

Результат:: current page number
Тип результата:: int

property total_pages: int | None¶

Get total pages count.

Результат:: total pages or None
Тип результата:: int | None

property limit: int¶

Get items per page limit.

Результат:: items per page
Тип результата:: int

property mode: PaginationMode¶

Get pagination mode.

Результат:: pagination mode
Тип результата:: PaginationMode

async paginate()[исходный код]¶

Start pagination.

Тип результата:: None

get_previous_page()[исходный код]¶

Get previous page number.

Результат:: previous page number
Тип результата:: int

get_next_page()[исходный код]¶

Get next page number.

Результат:: next page number
Тип результата:: int

build_navigation()[исходный код]¶

Build navigation keyboard.

Результат:: navigation keyboard markup
Тип результата:: InlineKeyboardMarkup

classmethod calc_total_pages(total_items, limit)[исходный код]¶

Calculate total pages from items count.

Параметры:

total_items (int) – total items count
limit (int) – items per page

Результат:

total pages count

Тип результата: