Paginate inner model field

Great library, thanks!

How would you go about using it on an endpoint which doesn’t directly return a sequence, but a model in which a field is the sequence to paginate, e.g.:

class ResponseType(BaseModel):
    other_data: int
    data_to_paginate: Sequence[str]

[uriyyo]

Hi @davidbrochart, I am closing this issue, please reopen it if you have more questions.

[uriyyo]

Hi @davidbrochart,

Now it should be easier to implement this feature. Example:

from typing import Any, TypeVar, Generic, Sequence, Type

from fastapi import FastAPI
from pydantic import BaseModel, Field

from fastapi_pagination import paginate, Params
from fastapi_pagination.api import pagination_items, add_pagination
from fastapi_pagination.bases import AbstractPage, AbstractParams

app = FastAPI()
add_pagination(app)

T = TypeVar("T")
C = TypeVar("C")


class PageWithInnerItems(AbstractPage[T], Generic[T]):
    __root__: T
    __params_type__ = Params

    @classmethod
    def create(
            cls: Type[C],
            items: Sequence[T],
            params: AbstractParams,
            **kwargs: Any,
    ) -> C:
        return cls(__root__=kwargs)


class ResponseType(BaseModel):
    other_data: int
    data_to_paginate: Sequence[str] = Field(default_factory=pagination_items)


@app.get(
    "/",
    response_model=PageWithInnerItems[ResponseType],
)
async def route() -> Any:
    data = [*range(100)]

    return paginate(data, additional_data={"other_data": 1000000})


if __name__ == '__main__':
    import uvicorn

    uvicorn.run(app)