Django Paginator.get_elided_page_range() のサンプルコード

DjangoのPaginator.get_elided_page_range()解説

django.core.paginator.Paginator.get_elided_page_range() は、DjangoのPaginatorクラスで提供されるメソッドで、ページネーション処理において省略記号 "..." を用いてページ番号を表示する機能を提供します。これは、ページ数が多くなった場合に、すべてのページ番号を表示するのではなく、必要なページ番号のみを表示することで、ページネーションバーをよりコンパクトに表示することができます。

動作

get_elided_page_range() は、以下のパラメータを受け取ります。

• number: 現在のページ番号
• on_each_side: 現在のページ番号の前後に表示するページ数
• on_ends: 最初と最後のページの両端から表示するページ数

これらのパラメータに基づいて、get_elided_page_range() は、以下の規則でページ番号のリストを返します。

1. 現在のページ番号が最初のページまたは最後のページの場合は、すべてのページ番号を表示します。
2. 現在のページ番号が最初のページまたは最後のページから on_ends 個以内の場合は、最初のページまたは最後のページから on_ends + 1 個のページ番号を表示します。
3. それ以外の場合は、以下の規則でページ番号を表示します。
   • 最初のページ番号
   • ...
   • 現在のページ番号の前後 on_each_side 個のページ番号

例

以下の例では、Paginator クラスを使用して、100個のオブジェクトを10個ずつ表示するページネーション処理を行っています。

from django.core.paginator import Paginator

objects = list(range(100))
paginator = Paginator(objects, 10)

# 現在のページ番号が1の場合
page_range = paginator.get_elided_page_range(number=1)
print(page_range) # [1, 2, 3, 4, 5, ..., 98, 99, 100]

# 現在のページ番号が50の場合
page_range = paginator.get_elided_page_range(number=50)
print(page_range) # [1, ..., 47, 48, 49, 50, 51, 52, ..., 98, 99, 100]

# 現在のページ番号が100の場合
page_range = paginator.get_elided_page_range(number=100)
print(page_range) # [1, 2, 3, ..., 96, 97, 98, 99, 100]

テンプレートでの使用

get_elided_page_range() で返されるリストは、テンプレートでループ処理して、ページ番号を表示することができます。

{% for page_number in paginator.get_elided_page_range(number=request.GET.get('page')) %}
<a href="?page={{ page_number }}">{{ page_number }}</a>
{% endfor %}

Paginator.get_elided_page_range() は、ページネーション処理において省略記号 "..." を用いてページ番号を表示する機能を提供します。これは、ページ数が多くなった場合に、すべてのページ番号を表示するのではなく、必要なページ番号のみを表示することで、ページネーションバーをよりコンパクトに表示することができます。

Paginator.get_elided_page_range() のサンプルコード

基本的な使用例

from django.core.paginator import Paginator

objects = list(range(100))
paginator = Paginator(objects, 10)

# 現在のページ番号
page_number = 1

# ページ番号のリストを取得
page_range = paginator.get_elided_page_range(number=page_number)

# ページ番号を表示
for page in page_range:
    print(page)

前後のページ数を調整

from django.core.paginator import Paginator

objects = list(range(100))
paginator = Paginator(objects, 10)

# 現在のページ番号
page_number = 50

# 前後のページ数を調整
page_range = paginator.get_elided_page_range(number=page_number, on_each_side=2)

# ページ番号を表示
for page in page_range:
    print(page)

最初と最後のページの両端から表示

from django.core.paginator import Paginator

objects = list(range(100))
paginator = Paginator(objects, 10)

# 現在のページ番号
page_number = 50

# 最初と最後のページの両端から表示
page_range = paginator.get_elided_page_range(number=page_number, on_ends=3)

# ページ番号を表示
for page in page_range:
    print(page)

テンプレートでの使用

{% for page_number in paginator.get_elided_page_range(number=request.GET.get('page')) %}
<a href="?page={{ page_number }}">{{ page_number }}</a>
{% endfor %}

• get_elided_page_range() は、省略記号 "..." を用いてページ番号を表示する機能を提供します。
• ページ数が多くなった場合に、すべてのページ番号を表示するのではなく、必要なページ番号のみを表示することで、ページネーションバーをよりコンパクトに表示することができます。
• get_elided_page_range() のパラメータを調整することで、表示されるページ番号の範囲をカスタマイズすることができます。

Paginator.get_elided_page_range() 以外の方法

自作の関数を使用する

def get_elided_page_range(paginator, number, on_each_side=2, on_ends=3):
    """
    省略記号 "..." を用いてページ番号を表示する関数

    Args:
        paginator: Paginator オブジェクト
        number: 現在のページ番号
        on_each_side: 現在のページ番号の前後に表示するページ数
        on_ends: 最初と最後のページの両端から表示するページ数

    Returns:
        ページ番号のリスト
    """

    page_range = []

    # 最初のページ
    if number <= on_ends + on_each_side:
        page_range.extend(paginator.page_range[:on_ends + 1])

    # 中間のページ
    elif number > on_ends + on_each_side and number < paginator.num_pages - on_ends - on_each_side:
        page_range.extend([1])
        page_range.extend(["..."]