Paginator class¶

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)[código-fonte]¶

A paginator acts like a sequence of Page when using len() or iterating it directly.

Paginator.object_list¶

Required. A list, tuple, QuerySet, or other sliceable object with a count() or __len__() method. For consistent pagination, QuerySets should be ordered, e.g. with an order_by() clause or with a default ordering on the model.

Performance issues paginating large QuerySets

If you’re using a QuerySet with a very large number of items, requesting high page numbers might be slow on some databases, because the resulting LIMIT/OFFSET query needs to count the number of OFFSET records which takes longer as the page number gets higher.

Paginator.per_page¶

Required. The maximum number of items to include on a page, not including orphans (see the orphans optional argument below).

Paginator.orphans¶

Optional. Use this when you don’t want to have a last page with very few items. If the last page would normally have a number of items less than or equal to orphans, then those items will be added to the previous page (which becomes the last page) instead of leaving the items on a page by themselves. For example, with 23 items, per_page=10, and orphans=3, there will be two pages; the first page with 10 items and the second (and last) page with 13 items. orphans defaults to zero, which means pages are never combined and the last page may have one item.

Paginator.allow_empty_first_page¶

Optional. Whether or not the first page is allowed to be empty. If False and object_list is empty, then an EmptyPage error will be raised.

Paginator.error_messages¶

New in Django 5.0.

The error_messages argument lets you override the default messages that the paginator will raise. Pass in a dictionary with keys matching the error messages you want to override. Available error message keys are: invalid_page, min_page, and no_results.

For example, here is the default error message:

>>> 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

And here is a custom error message:

>>> 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 class¶

You usually won’t construct Page objects by hand – you’ll get them by iterating Paginator, or by using Paginator.page().

class Page(object_list, number, paginator)[código-fonte]¶

A page acts like a sequence of Page.object_list when using len() or iterating it directly.

Exceções¶

exception InvalidPage[código-fonte]¶

A base class for exceptions raised when a paginator is passed an invalid page number.

The Paginator.page() method raises an exception if the requested page is invalid (i.e. not an integer) or contains no objects. Generally, it’s enough to catch the InvalidPage exception, but if you’d like more granularity, you can catch either of the following exceptions:

exception PageNotAnInteger[código-fonte]¶

Raised when page() is given a value that isn’t an integer.

exception EmptyPage[código-fonte]¶

Raised when page() is given a valid value but no objects exist on that page.

Both of the exceptions are subclasses of InvalidPage, so you can handle them both with except InvalidPage.