import dataclasses
from collections.abc import Sequence
from typing import Generic, TypeVar
_ModelT = TypeVar('_ModelT')
[docs]
@dataclasses.dataclass(slots=True, frozen=True, kw_only=True)
class Page(Generic[_ModelT]):
"""
Default page model for serialization.
Can be used when using pagination with ``django-modern-rest``.
"""
number: int
# Does not support `_SupportsPagination` type,
# explicit type cast to `list` or `tuple` is required,
# because it is hard to serialize complex `_SupportsPagination` protocol.
object_list: Sequence[_ModelT]
[docs]
@dataclasses.dataclass(slots=True, frozen=True, kw_only=True)
class Paginated(Generic[_ModelT]):
"""
Helper type to serialize the default ``Paginator`` object.
Django already ships a pagination system, we don't want to replicate it.
So, we only provide metadata.
See :class:`django.core.paginator.Paginator` for the exact API.
"""
count: int
num_pages: int
per_page: int
page: Page[_ModelT]
django-modern-rest