PaginatorLink para este cabeçalho
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 para este cabeçalho
- class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True)Link para esta definição
A paginator acts like a sequence of
Pagewhen usinglen()or iterating it directly.
- Paginator.object_listLink para esta definição
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 para esta definição
Required. The maximum number of items to include on a page, not including orphans (see the
orphansoptional argument below).
- Paginator.orphansLink para esta definição
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 para esta definição
Optional. Whether or not the first page is allowed to be empty. If
Falseandobject_listis empty, then anEmptyPageerror will be raised.
MétodosLink para este cabeçalho
- Paginator.get_page(number)Link para esta definição
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 para esta definição
Returns a
Pageobject with the given 1-based index. RaisesInvalidPageif the given page number doesn’t exist.
AtributosLink para este cabeçalho
- Paginator.countLink para esta definição
The total number of objects, across all pages.
- Paginator.num_pagesLink para esta definição
The total number of pages.
- Paginator.page_rangeLink para esta definição
A 1-based range iterator of page numbers, e.g. yielding
[1, 2, 3, 4].
Page classLink para este cabeçalho
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)Link para esta definição
A page acts like a sequence of
Page.object_listwhen usinglen()or iterating it directly.
MétodosLink para este cabeçalho
- Page.has_next()Link para esta definição
Returns
Trueif there’s a next page.
- Page.has_previous()Link para esta definição
Returns
Trueif there’s a previous page.
- Page.has_other_pages()Link para esta definição
Returns
Trueif there’s a next or previous page.
- Page.next_page_number()Link para esta definição
Returns the next page number. Raises
InvalidPageif next page doesn’t exist.
- Page.previous_page_number()Link para esta definição
Returns the previous page number. Raises
InvalidPageif previous page doesn’t exist.
- Page.start_index()Link para esta definição
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 para esta definição
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.
AtributosLink para este cabeçalho
- Page.object_listLink para esta definição
The list of objects on this page.
- Page.numberLink para esta definição
The 1-based page number for this page.
- Page.paginatorLink para esta definição
The associated
Paginatorobject.
ExceçõesLink para este cabeçalho
- exception InvalidPageLink para esta definição
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 PageNotAnIntegerLink para esta definição
Raised when
page()is given a value that isn’t an integer.
- exception EmptyPageLink para esta definição
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.