Option to return both Page and Offset

[dhait]

I would like to have the page number as well as the offset returned in the response.
Currently I can either choose Page or LimitOffsetPage but not both.

[uriyyo]

Hi @dhait,

Could you please provide examples of what you want to achieve?

[dhait]

For response_model "Page", we get:

  "items": [ ... ],
  "page": 2,
  "size": 3,
  "pages": 34,
  "total": 100
}

For response_mode "LimitOffsetPage", we get:

{
  "items": [ ... ],
  "limit": 3,
  "offset": 2,
  "total": 100
}

I would like to see:

{
  "items": [ ... ],
  "page": 2,
  "size": 3,
  "offset": 3
  "pages": 34,
  "total": 100
}

Meaning, the first item displayed is "n" offset from the beginning.

I know I could figure it out by multiplying "size" by "page" but it seems like an extra unnecessary step.

Also, it would be a more flexible solution if we could supply EITHER "page" or "offset" as a parameter, depending on the need (notice that "limit" and "size" appear to be the same value).

[uriyyo]

Hi @dhait,

It has been more than 1 year and I finally managed to get to this issue.

Here is an example using pydantic v2:

from __future__ import annotations

from typing import Optional, TypeVar

from fastapi import FastAPI
from pydantic import computed_field

from fastapi_pagination import Page, add_pagination, paginate
from fastapi_pagination.types import GreaterEqualOne, GreaterEqualZero

T = TypeVar("T")


class CustomPage(Page[T]):
    @computed_field
    def limit(self) -> Optional[GreaterEqualOne]:
        return self.size

    @computed_field
    def offset(self) -> Optional[GreaterEqualZero]:
        if self.page is not None or self.size is not None:
            return self.size * (self.page - 1)

        return None


app = FastAPI()
add_pagination(app)


@app.get("/")
async def route() -> CustomPage[int]:
    return paginate([*range(1_000)])


if __name__ == "__main__":
    import uvicorn

    uvicorn.run(app)

This request GET /?size=10&page=4 will give us:

{
    "items": [30, 31, 32, 33, 34, 35, 36, 37, 38, 39],
    "total": 1000,
    "page": 4,
    "size": 10,
    "pages": 100,
    "limit": 10,
    "offset": 30,
}