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.
Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True)
A paginator acts like a sequence of
Page when using
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
OFFSET query needs to count the number of
OFFSET records which takes longer as the page number gets higher.
orphansoptional argument below).
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.
orphansdefaults to zero, which means pages are never combined and the last page may have one item.
object_listis empty, then an
EmptyPageerror 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
Pageobject with the given 1-based index. Raises
InvalidPageif the given page number doesn't exist.
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
fall back to using
len(object_list). This allows objects, such as
QuerySet, to use a more efficient
count() method when
[1, 2, 3, 4].
Page(object_list, number, paginator)
len()or iterating it directly.
Trueif there's a next page.
Trueif there's a previous page.
Trueif there's a next or previous page.
InvalidPageif next page doesn't exist.
InvalidPageif previous page doesn't exist.
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