Django provides a few classes that help you manage paginated data – that is,\ndata that’s split across several pages, with «Previous/Next» links. These\nclasses live in django/core/paginator.py.
\nFor examples, see the Pagination topic guide.
\nPaginator classLink to this heading#A paginator acts like a sequence of Page when using len() or\niterating it directly.
Required. A list, tuple, QuerySet, or other sliceable object with a\ncount() or __len__() method. For consistent pagination,\nQuerySets should be ordered, e.g. with an\norder_by() clause or with a default\nordering on the model.
Required. The maximum number of items to include on a page, not including\norphans (see the orphans optional argument below).
Optional. Use this when you don’t want to have a last page with very few\nitems. If the last page would normally have a number of items less than or\nequal to orphans, then those items will be added to the previous page\n(which becomes the last page) instead of leaving the items on a page by\nthemselves. For example, with 23 items, per_page=10, and orphans=3,\nthere will be two pages; the first page with 10 items and the second\n(and last) page with 13 items. orphans defaults to zero, which means\npages are never combined and the last page may have one item.
Optional. Whether or not the first page is allowed to be empty. If\nFalse and object_list is empty, then an EmptyPage error will\nbe raised.
The error_messages argument lets you override the default messages that\nthe paginator will raise. Pass in a dictionary with keys matching the error\nmessages you want to override. Available error message keys are:\ninvalid_page, min_page, and no_results.
For example, here is the default error message:
\n>>> from django.core.paginator import Paginator\n>>> paginator = Paginator([1, 2, 3], 2)\n>>> paginator.page(5)\nTraceback (most recent call last):\n ...\nEmptyPage: That page contains no results\nAnd here is a custom error message:
\n>>> paginator = Paginator(\n... [1, 2, 3],\n... 2,\n... error_messages={"no_results": "Page does not exist"},\n... )\n>>> paginator.page(5)\nTraceback (most recent call last):\n ...\nEmptyPage: Page does not exist\nReturns a Page object with the given 1-based index, while also\nhandling out of range and invalid page numbers.
If the page isn’t a number, it returns the first page. If the page number\nis negative or greater than the number of pages, it returns the last page.
\nRaises an EmptyPage exception only if you specify\nPaginator(..., allow_empty_first_page=False) and the object_list is\nempty.
Returns a Page object with the given 1-based index. Raises\nPageNotAnInteger if the number cannot be converted to an integer\nby calling int(). Raises EmptyPage if the given page number\ndoesn’t exist.
Returns a 1-based list of page numbers similar to\nPaginator.page_range, but may add an ellipsis to either or both\nsides of the current page number when Paginator.num_pages is large.
The number of pages to include on each side of the current page number is\ndetermined by the on_each_side argument which defaults to 3.
The number of pages to include at the beginning and end of page range is\ndetermined by the on_ends argument which defaults to 2.
For example, with the default values for on_each_side and on_ends,\nif the current page is 10 and there are 50 pages, the page range will be\n[1, 2, '…', 7, 8, 9, 10, 11, 12, 13, '…', 49, 50]. This will result in\npages 7, 8, and 9 to the left of and 11, 12, and 13 to the right of the\ncurrent page as well as pages 1 and 2 at the start and 49 and 50 at the\nend.
Raises InvalidPage if the given page number doesn’t exist.
A translatable string used as a substitute for elided page numbers in the\npage range returned by get_elided_page_range(). Default is\n'…'.
The total number of objects, across all pages.
\n\nThe total number of pages.
\nA 1-based range iterator of page numbers, e.g. yielding [1, 2, 3, 4].
Page classLink to this heading#You usually won’t construct Page objects by hand – you’ll get them by\niterating Paginator, or by using Paginator.page().
A page acts like a sequence of Page.object_list when using\nlen() or iterating it directly.
Returns True if there’s a next page.
Returns True if there’s a previous page.
Returns True if there’s a next or previous page.
Returns the next page number. Raises InvalidPage if next page\ndoesn’t exist.
Returns the previous page number. Raises InvalidPage if previous\npage doesn’t exist.
Returns the 1-based index of the first object on the page, relative to all\nof the objects in the paginator’s list. For example, when paginating a list\nof 5 objects with 2 objects per page, the second page’s\nstart_index() would return 3.
Returns the 1-based index of the last object on the page, relative to all\nof the objects in the paginator’s list. For example, when paginating a list\nof 5 objects with 2 objects per page, the second page’s\nend_index() would return 4.
The list of objects on this page.
\nThe 1-based page number for this page.
\nThe associated Paginator object.
A base class for exceptions raised when a paginator is passed an invalid\npage number.
\nThe Paginator.page() method raises an exception if the requested page is\ninvalid (i.e. not an integer) or contains no objects. Generally, it’s enough\nto catch the InvalidPage exception, but if you’d like more granularity,\nyou can catch either of the following exceptions:
Raised when page() is given a value that isn’t an integer.
Raised when page() is given a valid value but no objects\nexist on that page.
Both of the exceptions are subclasses of InvalidPage, so you can handle\nthem both with except InvalidPage.