Pagination

BasePagination ¶

Bases: BaseModel

The pagination implementation must be a Pydantic model and implement two methods: get_limit and get_offset.

get_limit() -> int

Limit Getter.

Source code in pydantic_filters/pagination/_base.py

@abstractmethod
def get_limit(self) -> int:
    """Limit Getter."""

get_offset() -> int

Offset Getter.

Source code in pydantic_filters/pagination/_base.py

@abstractmethod
def get_offset(self) -> int:
    """Offset Getter."""

Limit-Offset Pagination implementation.

limit: int = Field(100, ge=1)

Limit field

offset: int = Field(0, ge=0)

Offset field

Page-PerPage Pagination implementation.

page: int = Field(1, ge=1)

Page number field

per_page: int = Field(100, ge=1)

Items per page field