orionis.orm.collections.Paginator

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class Paginator: (source)

Constructor: Paginator(items, total, page, per_page)

View In Hierarchy

Length-aware page of query results.

Wraps a Collection of items together with the pagination metadata required to render page controls: total row count, current page, page size, and derived navigation flags.

Method	`__init__`	Initialize the paginator with its items and metadata.
Method	`__len__`	Return the number of items in the current page.
Method	`__repr__`	Return a concise developer representation of the paginator.
Method	`toDict`	Serialize the page and its metadata into a dictionary.
Method	`toJson`	Serialize the page and its metadata into a JSON string.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_items`	Undocumented
Instance Variable	`_page`	Undocumented
Instance Variable	`_per_page`	Undocumented
Instance Variable	`_total`	Undocumented
Property	`hasNext`	Report whether a page exists after the current one.
Property	`hasPrevious`	Report whether a page exists before the current one.
Property	`items`	Return the items for the current page.
Property	`lastPage`	Return the number of the last available page.
Property	`page`	Return the current page number.
Property	`perPage`	Return the configured page size.
Property	`total`	Return the total number of rows across all pages.

def __init__(self, items: Collection, total: int, page: int, per_page: int): (source) ¶

Initialize the paginator with its items and metadata.

Parameters
items:`Collection`	Items for the current page.
total:`int`	Total number of rows across all pages.
page:`int`	Current page number, starting at 1.
per_page:`int`	Number of items per page.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If the page or page size are not positive integers.

def __len__(self) -> int: (source) ¶

Return the number of items in the current page.

Returns
`int`	Item count of the current page.

def __repr__(self) -> str: (source) ¶

Return a concise developer representation of the paginator.

Returns
`str`	Representation including page, page size, and total.

def toDict(self) -> dict[str, Any]: (source) ¶

Serialize the page and its metadata into a dictionary.

Returns
`dict`	Dictionary with items and pagination metadata.

def toJson(self, **kwargs: Any) -> str: (source) ¶

Serialize the page and its metadata into a JSON string.

Parameters
**kwargs:`Any`	Additional keyword arguments forwarded to `json.dumps`.

Returns
`str`	JSON representation of the page.

__slots__: tuple[str, ...] = (source) ¶

Undocumented

_items = (source) ¶

Undocumented

_page = (source) ¶

Undocumented

_per_page = (source) ¶

Undocumented

_total = (source) ¶

Undocumented

@property

hasNext: bool = (source) ¶

Report whether a page exists after the current one.

Returns
`bool`	`True` when the current page is not the last.

@property

hasPrevious: bool = (source) ¶

Report whether a page exists before the current one.

Returns
`bool`	`True` when the current page is not the first.

@property

items: Collection = (source) ¶

Return the items for the current page.

Returns
`Collection`	Items of the current page.

@property

lastPage: int = (source) ¶

Return the number of the last available page.

Returns
`int`	Last page number, never lower than 1.

@property

page: int = (source) ¶

Return the current page number.

Returns
`int`	Current page, starting at 1.

@property

perPage: int = (source) ¶

Return the configured page size.

Returns
`int`	Number of items per page.

@property

total: int = (source) ¶

Return the total number of rows across all pages.

Returns
`int`	Total row count.