WesternFriend/WF-website

from dataclasses import dataclass
from collections.abc import Iterator
from django.core.paginator import Paginator, Page
from django.db.models import QuerySet


@dataclass
class PaginatorPageWithElidedPageRange:
    """A page of items with an elided page range."""

    page: Page
    elided_page_range: Iterator[int | str]


def get_paginated_items(
    items: QuerySet,
    items_per_page: int,
    page_number: str = "1",
) -> PaginatorPageWithElidedPageRange:
    """Paginate items and return a page of items."""

    paginator: Paginator = Paginator(items, items_per_page)

    paginator_page_number = 1

    # Make sure page is numeric
    # and less than or equal to the total pages
    if page_number.isdigit() and int(page_number) <= paginator.num_pages:
        paginator_page_number = int(page_number)

    elided_page_range = paginator.get_elided_page_range(
        paginator_page_number,
    )

    return PaginatorPageWithElidedPageRange(
        page=paginator.page(paginator_page_number),
        elided_page_range=elided_page_range,
    )