How to use pydantic model on UseAdditionalFields ?

[Kavan72]

I've my pydantic model and i want to use on UseAdditionalFields, like this

CustomPage = CustomizedPage[
    Page[T],
    UseAdditionalFields(
        extra=MyCustomModel
    ),
]

[Kavan72]

I’ve noticed one thing: using add_pagination(app) works, but I’m not using it.

[Kavan72]

minimal code

from typing import TypeVar

from pydantic import BaseModel, ConfigDict, EmailStr, Field
from fastapi import FastAPI
from fastapi_pagination import Page, Params
from fastapi_pagination import Page, add_pagination, paginate
from fastapi_pagination.customization import CustomizedPage, UseAdditionalFields

app = FastAPI()

T = TypeVar("T")

class UserCount(BaseModel):
    active: int
    invited: int
    banned: int
    rejected: int

CustomPage = CustomizedPage[
    Page[T],
    UseAdditionalFields(
        extra=UserCount,
    ),
]

@app.get("/nums")
async def get_nums(is_admin: bool = False) -> CustomPage[int]:
    return paginate(
        range(1_000),
        params=Params(page=1, size=10),
        additional_data={
            "extra": UserCount(active=1, banned=2, rejected=3, invited=4),
        }
    )

[uriyyo]

Hi @Kavan72,

You actually need to use add_pagination, without it code will not work.

Here is working example:

from typing import TypeVar

from fastapi import FastAPI
from pydantic import BaseModel

from fastapi_pagination import Page, add_pagination, paginate
from fastapi_pagination.customization import CustomizedPage, UseAdditionalFields

app = FastAPI()
add_pagination(app)

T = TypeVar("T")

class UserCount(BaseModel):
    active: int
    invited: int
    banned: int
    rejected: int

CustomPage = CustomizedPage[
    Page[T],
    UseAdditionalFields(
        extra=UserCount,
    ),
]

@app.get("/nums")
async def get_nums(is_admin: bool = False) -> CustomPage[int]:
    return paginate(
        range(1_000),
        additional_data={
            "extra": UserCount(active=1, banned=2, rejected=3, invited=4),
        }
    )

[Kavan72]

Thank for it ❤️. Sorry, but I don’t prefer using add_pagination or set_page