ページ付け

Djangoは、ページ付けされたデータ、つまり「前へ/次へ」リンクを使用して複数のページに分割されたデータを管理するのに役立つ高レベルおよび低レベルの方法を提供します。

Paginatorクラス

内部的には、ページ付けのすべてのメソッドは Paginator クラスを使用します。 QuerySetを Page オブジェクトに実際に分割するという面倒な作業をすべて行います。

例

Paginator にオブジェクトのリストと、各ページに配置するアイテムの数を指定します。これにより、各ページのアイテムにアクセスするためのメソッドが提供されます。

>>> from django.core.paginator import Paginator
>>> objects = ['john', 'paul', 'george', 'ringo']
>>> p = Paginator(objects, 2)

>>> p.count
4
>>> p.num_pages
2
>>> type(p.page_range)
<class 'range_iterator'>
>>> p.page_range
range(1, 3)

>>> page1 = p.page(1)
>>> page1
<Page 1 of 2>
>>> page1.object_list
['john', 'paul']

>>> page2 = p.page(2)
>>> page2.object_list
['george', 'ringo']
>>> page2.has_next()
False
>>> page2.has_previous()
True
>>> page2.has_other_pages()
True
>>> page2.next_page_number()
Traceback (most recent call last):
...
EmptyPage: That page contains no results
>>> page2.previous_page_number()
1
>>> page2.start_index() # The 1-based index of the first item on this page
3
>>> page2.end_index() # The 1-based index of the last item on this page
4

>>> p.page(0)
Traceback (most recent call last):
...
EmptyPage: That page number is less than 1
>>> p.page(3)
Traceback (most recent call last):
...
EmptyPage: That page contains no results

ノート

Paginatorにリスト/タプル、Django QuerySet、またはcount()または__len__()メソッドを使用するその他のオブジェクトを指定できることに注意してください。渡されたオブジェクトに含まれるオブジェクトの数を決定するとき、Paginatorは最初にcount()の呼び出しを試み、次に渡されたオブジェクトにcount()がない場合は、len()の使用にフォールバックします。 ] 方法。これにより、DjangoのQuerySetなどのオブジェクトは、使用可能な場合、より効率的なcount()メソッドを使用できます。

ListViewのページング

django.views.generic.list.ListView は、表示されたリストをページ付けするための組み込みの方法を提供します。これを行うには、 paginate_by 属性をビュークラスに追加します。次に例を示します。

from django.views.generic import ListView

from myapp.models import Contact

class ContactList(ListView):
    paginate_by = 2
    model = Contact

これにより、ページあたりのオブジェクト数が制限され、paginatorとpage_objがcontextに追加されます。ユーザーがページ間を移動できるようにするには、次のようにテンプレートに次のページと前のページへのリンクを追加します。

{% for contact in page_obj %}
    {# Each "contact" is a Contact model object. #}
    {{ contact.full_name|upper }}<br>
    ...
{% endfor %}

<div class="pagination">
    <span class="step-links">
        {% if page_obj.has_previous %}
            <a href="?page=1">&laquo; first</a>
            <a href="?page={{ page_obj.previous_page_number }}">previous</a>
        {% endif %}

        <span class="current">
            Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}.
        </span>

        {% if page_obj.has_next %}
            <a href="?page={{ page_obj.next_page_number }}">next</a>
            <a href="?page={{ page_obj.paginator.num_pages }}">last &raquo;</a>
        {% endif %}
    </span>
</div>

ビュー機能でPaginatorを使用する

次に、ビュー関数で Paginator を使用してクエリセットをページ付けする例を示します。

from django.core.paginator import Paginator
from django.shortcuts import render

from myapp.models import Contact

def listing(request):
    contact_list = Contact.objects.all()
    paginator = Paginator(contact_list, 25) # Show 25 contacts per page.

    page_number = request.GET.get('page')
    page_obj = paginator.get_page(page_number)
    return render(request, 'list.html', {'page_obj': page_obj})

テンプレートlist.htmlには、上記のListViewのテンプレートと同じ方法で、ページ間のナビゲーションを含めることができます。

ページ付け—Djangoドキュメント

目次