Django provides a few classes that help you manage paginated data – that is, data that’s split across several pages, with “Previous/Next” links. These classes live in django/core/paginator.py.
class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True)
A paginator acts like a sequence of
Page when using
len() or iterating it directly.
Support for iterating over
Paginator was added.
Required. A list, tuple,
QuerySet, or other sliceable object with a
__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
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
OFFSET query needs to count the number of
OFFSET records which takes longer as the page number gets higher.
Required. The maximum number of items to include on a page, not including orphans (see the
orphans optional argument below).
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,
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.
Optional. Whether or not the first page is allowed to be empty. If
object_list is empty, then an
EmptyPage error will be raised.
Page object with the given 1-based index, while also handling out of range and invalid page numbers.
If the page isn’t a number, it returns the first page. If the page number is negative or greater than the number of pages, it returns the last page.
EmptyPage exception only if you specify
Paginator(..., allow_empty_first_page=False) and the
object_list is empty.
The total number of objects, across all pages.
When determining the number of objects contained in
Paginator will first try calling
object_list has no
count() method, then
Paginator will fall back to using
len(object_list). This allows objects, such as
QuerySet, to use a more efficient
count() method when available.
The total number of pages.
A 1-based range iterator of page numbers, e.g. yielding
[1, 2, 3, 4].
class Page(object_list, number, paginator)
A page acts like a sequence of
Page.object_list when using
len() or iterating it directly.
True if there’s a next page.
True if there’s a previous page.
True if there’s a next or previous page.
Returns the next page number. Raises
InvalidPage if next page doesn’t exist.
Returns the previous page number. Raises
InvalidPage if previous page doesn’t exist.
Returns the 1-based index of the first object on the page, relative to all of the objects in the paginator’s list. For example, when paginating a list of 5 objects with 2 objects per page, the second page’s
start_index() would return
Returns the 1-based index of the last object on the page, relative to all of the objects in the paginator’s list. For example, when paginating a list of 5 objects with 2 objects per page, the second page’s
end_index() would return
The list of objects on this page.
The 1-based page number for this page.
A base class for exceptions raised when a paginator is passed an invalid page number.
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:
page() is given a value that isn’t an integer.
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
© Django Software Foundation and individual contributors
Licensed under the BSD License.