Skip to content

Index

frequenz.client.common.pagination ¤

Pagination types used by common clients.

Classes¤

frequenz.client.common.pagination.PaginationInfo dataclass ¤

Information about the pagination of a list request.

Source code in src/frequenz/client/common/pagination/_pagination_info.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@dataclass(frozen=True, kw_only=True)
class PaginationInfo:
    """Information about the pagination of a list request."""

    total_items: int
    """The total number of items that match the request."""

    next_page_token: str | None = None
    """The token identifying the next page of results."""

    def __post_init__(self) -> None:
        """Validate pagination information."""
        if self.total_items < 0:
            raise ValueError(
                f"total_items must be non-negative, not {self.total_items}"
            )
Attributes¤
next_page_token class-attribute instance-attribute ¤
next_page_token: str | None = None

The token identifying the next page of results.

total_items instance-attribute ¤
total_items: int

The total number of items that match the request.

Methods:¤
__post_init__ ¤
__post_init__() -> None

Validate pagination information.

Source code in src/frequenz/client/common/pagination/_pagination_info.py 
19
20
21
22
23
24
def __post_init__(self) -> None:
    """Validate pagination information."""
    if self.total_items < 0:
        raise ValueError(
            f"total_items must be non-negative, not {self.total_items}"
        )