Django はページネーションしたデータの管理を助けるクラスを提供しています。つまり、データをいくつかのページに分割して、「戻る/次へ」リンクを使って移動できるようにします。これらのクラスは django/core/paginator.py で実装されています。
Paginator にオブジェクトのリストと、各ページに持たせたいアイテムの数を与えてください。すると、各ページのアイテムにアクセスできるメソッドが使えるようになります。
>>> from django.core.paginator import Paginator\n>>> objects = ['john', 'paul', 'george', 'ringo']\n>>> p = Paginator(objects, 2)\n\n>>> p.count\n4\n>>> p.num_pages\n2\n>>> type(p.page_range)\n<class 'range_iterator'>\n>>> p.page_range\nrange(1, 3)\n\n>>> page1 = p.page(1)\n>>> page1\n<Page 1 of 2>\n>>> page1.object_list\n['john', 'paul']\n\n>>> page2 = p.page(2)\n>>> page2.object_list\n['george', 'ringo']\n>>> page2.has_next()\nFalse\n>>> page2.has_previous()\nTrue\n>>> page2.has_other_pages()\nTrue\n>>> page2.next_page_number()\nTraceback (most recent call last):\n...\nEmptyPage: That page contains no results\n>>> page2.previous_page_number()\n1\n>>> page2.start_index() # The 1-based index of the first item on this page\n3\n>>> page2.end_index() # The 1-based index of the last item on this page\n4\n\n>>> p.page(0)\nTraceback (most recent call last):\n...\nEmptyPage: That page number is less than 1\n>>> p.page(3)\nTraceback (most recent call last):\n...\nEmptyPage: That page contains no results\nPaginator をビューで使用するLink to this heading#次は、ビューの中で queryset をページネーションするために Paginator を使用する、もう少し複雑な例を見てみましょう。ページネーションの結果を表示する方法を見せるために、ビューとテンプレートの両方を示します。この例では、Contacts モデルはあらかじめインポートされているものとします。
ビュー関数は次のようになります。
\nfrom django.core.paginator import Paginator\nfrom django.shortcuts import render\n\ndef listing(request):\n contact_list = Contacts.objects.all()\n paginator = Paginator(contact_list, 25) # Show 25 contacts per page\n\n page = request.GET.get('page')\n contacts = paginator.get_page(page)\n return render(request, 'list.html', {'contacts': contacts})\nIn the template list.html, you'll want to include navigation between\npages along with any interesting information from the objects themselves:
{% for contact in contacts %}\n {# Each "contact" is a Contact model object. #}\n {{ contact.full_name|upper }}<br>\n ...\n{% endfor %}\n\n<div class="pagination">\n <span class="step-links">\n {% if contacts.has_previous %}\n <a href="?page=1">« first</a>\n <a href="?page={{ contacts.previous_page_number }}">previous</a>\n {% endif %}\n\n <span class="current">\n Page {{ contacts.number }} of {{ contacts.paginator.num_pages }}.\n </span>\n\n {% if contacts.has_next %}\n <a href="?page={{ contacts.next_page_number }}">next</a>\n <a href="?page={{ contacts.paginator.num_pages }}">last »</a>\n {% endif %}\n </span>\n</div>\nPaginator オブジェクトLink to this heading#Paginator には次のようなコンストラクタがあります。
object_listリスト、タプル、QuerySet、あるいはその他のスライス可能なオブジェクトで、count() または __len__() を実装しているオブジェクトを指定します。一貫性のあるページネーションのためには、QuerySet は並び替えられていなければなりません。たとえば、order_by() 句を使用したり、モデルでデフォルトの ordering を指定します。
per_page1ページごとに含まれる最大のアイテム数です。これには孤立したアイテム (orphan) は含まれません (詳しくは以下の orphans オプション引数をご覧ください)。
orphans最後のページに少数のアイテムだけが表示されるのを防ぎたい時に使用します。もし最後のページに orphans で指定した数以下のアイテムしか含まれない場合、最終ページではなく、1つ前のページにそれらのアイテムが追加されます (そのページが最終ページになります)。たとえば、23個のアイテムがあり、per_page=10 と orphans=3 をしていしたとします。その場合、ページ数は2になり、最初のページには10個のアイテムが、2つ目の (最後の) ページには13個のアイテムが表示されることになります。orphans はデフォルトで0になっているため、ページが合体することはなく、最後のページには1アイテムだけが表示されるかもしれません。
allow_empty_first_page最初のページがからであることを許すかどうかを指定します。もし False を指定し、object_list が空だった場合、EmptyPage エラーが起こります。
1から始まるインデックスをもつ Page オブジェクトを返します。このオブジェクトは、範囲外のページ数や無効なページ数もハンドリングします。
与えられた値が数字でなかった場合は、最初のページを返します。ページ数が負の数や全体のページ数より大きかった場合は、最後のページを返します。
\n例外 (EmptyPage) が発生するのは、Paginator(..., allow_empty_first_page=False) を指定して``object_list`` が空であるとき、かつそのときに限ります。
1から始まるインデックスをもつ Page オブジェクトを返します。与えられたページ数が存在しない場合、InvalidPage 例外を起こします。
すべてのページに渡るオブジェクト全体の数です。
\n\nトータルのページ数
\n1から始まるページ数の範囲のイテレータです。たとえば、[1, 2, 3, 4] を生成します。
InvalidPage 例外Link to this heading#pagenator に無効なページ数が渡された時に発生する例外のベースクラスです。
\nリクエストされたページが無効な値だったり (たとえば、整数でなかったなど)、オブジェクトが1つも含まれていなかった場合、Paginator.page() メソッドは例外を起こします。一般には、InvalidPage 例外を捕捉すれば十分ですが、粒度を細かくしたい場合は、以下の例外のいずれかを捕捉することもできます。
整数以外の値が page() に与えられた時に発生します。
page() には有効な値が与えられたが、そのページにオブジェクトが1つも存在しなかった時に発生します。
2つの例外は InvalidPage のサブクラスであるため、両方とも単に except InvalidPage と書くだけでハンドリングできます。
Page オブジェクトLink to this heading#通常は Page オブジェクトを手動で作ることはありません。Paginator.page() メソッドで作成します。
1つのページは、len() を使ったり直接イテレーションした時、Page.object_list のシーケンスのように振る舞います。
次のページが存在する時、True を返します。
前のページが存在する時、True を返します。
次のページ または 前のページがが存在する時、True を返します。
次のページ数を返します。次のページが存在しないときは InvalidPage 例外を起こします。
前のページ数を返します。前のページが存在しないときは InvalidPage 例外を起こします。
ページ上の最初のオブジェクトに対する、1から始まるインデックスを返します。これは、ページネータのリストに含まれる全オブジェクトに対するインデックスです。たとえば、5個のオブジェクトのリストを各ページ2オブジェクトでページネーションしている場合、2ページ目の start_index() は 3 を返すでしょう。
ページ上の最後のオブジェクトに対する、1から始まるインデックスを返します。これは、ページネータのリストに含まれる全オブジェクトに対するインデックスです。たとえば、5個のオブジェクトのリストを各ページ2オブジェクトでページネーションしている場合、2ページ目の end_index() は 4 を返すでしょう。
当該のページに含まれるオブジェクトのリストです。
\n1から数えた現在のページのページ数です。
\n関連する Paginator オブジェクトです。