Skip to content

Paginated Module Reference

paginated is a utility module for offset pagination related functions.

Function Definition

compute_offset(page, items_per_page)

Calculate the offset for pagination based on the given page number and items per page.

The offset represents the starting point in a dataset for the items on a given page. For example, if each page displays 10 items and you want to display page 3, the offset will be 20, meaning the display should start with the 21st item.

Parameters

page : int The current page number. Page numbers should start from 1. items_per_page : int The number of items to be displayed on each page.

Returns

int The calculated offset.

Examples

offset(1, 10) 0 offset(3, 10) 20

Source code in fastcrud/paginated/helper.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def compute_offset(page: int, items_per_page: int) -> int:
    """Calculate the offset for pagination based on the given page number and items per page.

    The offset represents the starting point in a dataset for the items on a given page.
    For example, if each page displays 10 items and you want to display page 3, the offset will be 20,
    meaning the display should start with the 21st item.

    Parameters
    ----------
    page : int
        The current page number. Page numbers should start from 1.
    items_per_page : int
        The number of items to be displayed on each page.

    Returns
    -------
    int
        The calculated offset.

    Examples
    --------
    >>> offset(1, 10)
    0
    >>> offset(3, 10)
    20
    """
    return (page - 1) * items_per_page

paginated_response(crud_data, page, items_per_page)

Create a paginated response based on the provided data and pagination parameters.

Parameters

crud_data : ListResponse[SchemaType] Data to be paginated, including the list of items and total count. page : int Current page number. items_per_page : int Number of items per page.

Returns

dict[str, Any] A structured paginated response dict containing the list of items, total count, pagination flags, and numbers.

Note

The function does not actually paginate the data but formats the response to indicate pagination metadata.

Source code in fastcrud/paginated/response.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def paginated_response(
    crud_data: dict, page: int, items_per_page: int
) -> dict[str, Any]:
    """Create a paginated response based on the provided data and pagination parameters.

    Parameters
    ----------
    crud_data : ListResponse[SchemaType]
        Data to be paginated, including the list of items and total count.
    page : int
        Current page number.
    items_per_page : int
        Number of items per page.

    Returns
    -------
    dict[str, Any]
        A structured paginated response dict containing the list of items, total count, pagination flags, and numbers.

    Note
    ----
    The function does not actually paginate the data but formats the response to indicate pagination metadata.
    """
    return {
        "data": crud_data["data"],
        "total_count": crud_data["total_count"],
        "has_more": (page * items_per_page) < crud_data["total_count"],
        "page": page,
        "items_per_page": items_per_page,
    }