PaginatorLink to this heading
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 classLink to this heading
- class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True)Link to this definition
- Paginator.object_listLink to this definition
Required. A list, tuple,
QuerySet, or other sliceable object with acount()or__len__()method. For consistent pagination,QuerySets should be ordered, e.g. with anorder_by()clause or with a defaultorderingon the model.
- Paginator.per_pageLink to this definition
Required. The maximum number of items to include on a page, not including orphans (see the
orphansoptional argument below).
- Paginator.orphansLink to this definition
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, andorphans=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.
- Paginator.allow_empty_first_pageLink to this definition
Optional. Whether or not the first page is allowed to be empty. If
Falseandobject_listis empty, then anEmptyPageerror will be raised.
方法Link to this heading
- Paginator.get_page(number)Link to this definition
Returns a
Pageobject 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.
Raises an
EmptyPageexception only if you specifyPaginator(..., allow_empty_first_page=False)and theobject_listis empty.
- Paginator.page(number)Link to this definition
Returns a
Pageobject with the given 1-based index. RaisesInvalidPageif the given page number doesn't exist.
属性Link to this heading
- Paginator.countLink to this definition
The total number of objects, across all pages.
- Paginator.num_pagesLink to this definition
The total number of pages.
- Paginator.page_rangeLink to this definition
A 1-based range iterator of page numbers, e.g. yielding
[1, 2, 3, 4].
Page classLink to this heading
你通常不会手动实例化Page对象 - 你会使用方法Paginator.page()。
- class Page(object_list, number, paginator)Link to this definition
A page acts like a sequence of
Page.object_listwhen usinglen()or iterating it directly.
方法Link to this heading
- Page.has_next()Link to this definition
Returns
Trueif there's a next page.
- Page.has_previous()Link to this definition
Returns
Trueif there's a previous page.
- Page.has_other_pages()Link to this definition
Returns
Trueif there's a next or previous page.
- Page.next_page_number()Link to this definition
Returns the next page number. Raises
InvalidPageif next page doesn't exist.
- Page.previous_page_number()Link to this definition
Returns the previous page number. Raises
InvalidPageif previous page doesn't exist.
- Page.start_index()Link to this definition
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 return3.
- Page.end_index()Link to this definition
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 return4.
属性Link to this heading
- Page.object_listLink to this definition
此页上的对象列表。
- Page.numberLink to this definition
此页的基于 1 的页码。
- Page.paginatorLink to this definition
关联的
Paginator对象。
例外Link to this heading
- exception InvalidPageLink to this definition
当paginator对象试图访问无效页码时引发异常的基类。
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 PageNotAnIntegerLink to this definition
Raised when
page()is given a value that isn't an integer.
- exception EmptyPageLink to this definition
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.