コンテンツにスキップ

pytilpack.paginator

pytilpack.paginator

ページネーション用ユーティリティ。

Paginator(page, per_page, items, total)

ページング用の簡易ヘルパ。

引数：

名前 タイプ デスクリプション デフォルト
page int

1オリジンのページ番号

 必須
per_page int

1ページあたりのアイテム数

 必須
items list[T]

現在のページのデータ

 必須
total int

全データ件数

 必須

例::

{% macro render_pagination(endpoint, paginator, **kwargs) %}
<nav>
    <ul class="pagination justify-content-center">
        <li class="page-item{% if not paginator.has_prev %} disabled{% endif %}">
            <a class="page-link" href="{{ url_for(endpoint, page=paginator.prev_num, **kwargs) }}">&lt;</a>
        </li>
        {% for page in paginator.iter_pages() %}
            {% if page is none %}
                <li class="page-item disabled">...</li>
            {% else %}
                <li class="page-item{% if paginator.page == page %} active{% endif %}">
                    <a class="page-link" href="{{ url_for(endpoint, page=page, **kwargs) }}">{{ page }}</a>
                </li>
            {% endif %}
        {% endfor %}
        <li class="page-item{% if not paginator.has_next %} disabled{% endif %}">
            <a class="page-link" href="{{ url_for(endpoint, page=paginator.next_num, **kwargs) }}">&gt;</a>
        </li>
    </ul>
</nav>
{% endmacro %}
参考
ソースコード位置： pytilpack/paginator.py 
44
45
46
47
48
49
50
51
def __init__(self, page: int, per_page: int, items: list[T], total: int):
    assert page >= 1
    assert per_page >= 1
    assert total >= 0
    self.page = page
    self.per_page = per_page
    self.items = items
    self.total_items = total

pages property

ページ数。

has_prev property

前ページがあるか否か。

has_next property

次ページがあるか否か。

prev_num property

前ページのページ番号。

next_num property

次ページのページ番号。

next()

次ページのPaginatorオブジェクト。

ソースコード位置： pytilpack/paginator.py 
80
81
82
83
84
85
86
87
88
89
def next(self) -> typing.Self:
    """次ページのPaginatorオブジェクト。"""
    if not self.has_next:
        raise ValueError("No next page")
    return self.__class__(
        page=self.next_num,
        per_page=self.per_page,
        items=self.items,
        total=self.total_items,
    )

prev()

前ページのPaginatorオブジェクト。

ソースコード位置： pytilpack/paginator.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def prev(self) -> typing.Self:
    """前ページのPaginatorオブジェクト。"""
    if not self.has_prev:
        raise ValueError("No previous page")
    return self.__class__(
        page=self.prev_num,
        per_page=self.per_page,
        items=self.items,
        total=self.total_items,
    )

iter_pages(left_edge=2, left_current=2, right_current=4, right_edge=2)

ページネーションウィジェット用のページ番号を生成する。

ページの先頭と末尾の間でスキップされるページは None で表現する。 例えば、総ページ数が 20 ページで現在のページが 7 ページの場合、以下の値が生成される。 1, 2, None, 5, 6, 7, 8, 9, 10, 11, None, 19, 20

引数：

名前 タイプ デスクリプション デフォルト
left_edge int

最初のページから表示するページ数。

 2
left_current int

現在のページの左側に表示されるページ数。

 2
right_current int

現在のページの右側に表示されるページ数。

 4
right_edge int

最後のページから表示するページ数。

 2

戻り値：

タイプ デスクリプション
list[int | None]

ページ番号のリスト。ページ番号が連続していない場合はNoneを挟む。
ソースコード位置： pytilpack/paginator.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
def iter_pages(
    self,
    left_edge: int = 2,
    left_current: int = 2,
    right_current: int = 4,
    right_edge: int = 2,
) -> list[int | None]:
    """ページネーションウィジェット用のページ番号を生成する。

    ページの先頭と末尾の間でスキップされるページは None で表現する。
    例えば、総ページ数が 20 ページで現在のページが 7 ページの場合、以下の値が生成される。
    1, 2, None, 5, 6, 7, 8, 9, 10, 11, None, 19, 20

    Args:
        left_edge: 最初のページから表示するページ数。
        left_current: 現在のページの左側に表示されるページ数。
        right_current: 現在のページの右側に表示されるページ数。
        right_edge: 最後のページから表示するページ数。

    Returns:
        ページ番号のリスト。ページ番号が連続していない場合はNoneを挟む。
    """
    last = 0
    result: list[int | None] = []
    for num in range(1, self.pages + 1):
        if (
            num <= left_edge
            or (self.page - left_current <= num <= self.page + right_current)
            or num > self.pages - right_edge
        ):
            if last + 1 != num:
                result.append(None)
            result.append(num)
            last = num
    return result