ページ分割 (Paginator)Link to this heading#

Paginator classLink to this heading#

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Link to this definition#

Paginator（ページネーター）は len() の使用時、または直接イテレートしたときは Page のシーケンスのように動作します。

Paginator.object_listLink to this definition#

必須です。リスト、タプル、QuerySet、または count() または __len__() メソッドを持つその他のスライス可能なオブジェクト。一貫したページ分割のためには、QuerySet は順序付けされるべきです。たとえば、order_by() 句を使用するか、モデル上のデフォルトの ordering で行います。

Paginator.per_pageLink to this definition#

必須です。ページ上に含めるアイテムの最大数で、孤立アイテムは含みません（以下の orphans オプション引数を参照）。

Paginator.orphansLink to this definition#

オプション。アイテム数が非常に少ない最終ページを作りたくない場合に使用します。もし最後のページに通常 orphans 以下の数のアイテムがある場合、それらのアイテムはそれだけで1ページに残すのではなく、前のページ（これが最後のページ）に追加されます。たとえば、23個のアイテムがあり、 per_page=10、orphans=3 の場合、最初のページには10個のアイテムが表示され、2ページ目（最後のページ）には13個のアイテムが表示されます。 orphans のデフォルトは0です。つまり、ページが結合されることはなく、最後のページには1つのアイテムしか表示されないかもしれません。

Paginator.allow_empty_first_pageLink to this definition#

オプション。最初のページが空であることを許可するかどうか。 もし False で object_list が空の場合、 EmptyPage エラーが発生します。

Paginator.error_messagesLink to this definition#

error_messages 引数を指定すると、paginator がデフォルトで返すメッセージを上書きできます。オーバーライドしたいエラーメッセージにマッチするキーを持つ辞書を渡します。使用可能なエラーメッセージのキーは invalid_page, min_page, no_results です。

たとえば、デフォルトのエラーメッセージは以下のようなものです：

Python console

>>> from django.core.paginator import Paginator
>>> paginator = Paginator([1, 2, 3], 2)
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: That page contains no results

そしてこれがカスタムエラーメッセージです:

Python console

>>> paginator = Paginator(
...     [1, 2, 3],
...     2,
...     error_messages={"no_results": "Page does not exist"},
... )
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: Page does not exist

Page クラスLink to this heading#

通常は Page オブジェクトを手動で構築することはありません。 Paginator をイテレートするか、 Paginator.page() を使ってオブジェクトを取得します。

class Page(object_list, number, paginator)Link to this definition#

1つのページは、len() を使ったり直接イテレーションした時、Page.object_list のシーケンスのように動作します。

例外Link to this heading#

exception InvalidPageLink to this definition#

pagenator に無効なページ数が渡された時に発生する例外のベースクラスです。

Paginator.page() メソッドは、リクエストされたページが無効 (つまり整数ではない) か、オブジェクトが含まれていない場合に例外を発生させます。通常、 InvalidPage 例外をキャッチすれば十分ですが、より詳細に例外をキャッチしたい場合は、以下のいずれかの例外をキャッチします：

exception PageNotAnIntegerLink to this definition#

page() に整数でない値が与えられた時に発生します。

exception EmptyPageLink to this definition#

page() に有効な値が与えられているが、そのページにオブジェクトが存在しない場合に発生します。

どちらの例外も InvalidPage のサブクラスなので、 except InvalidPage で処理できます。