diff options
| author | Sami J. Lehtinen <sjl@iki.fi> | 2017-04-06 13:01:04 +0300 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-09-06 14:17:19 -0400 |
| commit | 407c1249c9a0296ec8a8d95e447bd695ca471b5e (patch) | |
| tree | a181ef463ae796575f0c507bd80b3a9d5d6b79d4 /docs | |
| parent | 5b1c389603a353625ae1603ba345147356336afb (diff) | |
Fixed #28032 -- Added Paginator.get_page().
Moved boilerplate from docs to a method.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/releases/2.0.txt | 6 | ||||
| -rw-r--r-- | docs/topics/pagination.txt | 24 |
2 files changed, 21 insertions, 9 deletions
diff --git a/docs/releases/2.0.txt b/docs/releases/2.0.txt index dd8183d798..e50bd36d93 100644 --- a/docs/releases/2.0.txt +++ b/docs/releases/2.0.txt @@ -290,6 +290,12 @@ Models * Added support for expressions in :attr:`Meta.ordering <django.db.models.Options.ordering>`. +Pagination +~~~~~~~~~~ + +* Added :meth:`Paginator.get_page() <django.core.paginator.Paginator.get_page>` + to provide the documented pattern of handling invalid page numbers. + Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/topics/pagination.txt b/docs/topics/pagination.txt index 2521fee312..bc936faaef 100644 --- a/docs/topics/pagination.txt +++ b/docs/topics/pagination.txt @@ -93,15 +93,7 @@ The view function looks like this:: paginator = Paginator(contact_list, 25) # Show 25 contacts per page page = request.GET.get('page') - try: - contacts = paginator.page(page) - except PageNotAnInteger: - # If page is not an integer, deliver first page. - contacts = paginator.page(1) - except EmptyPage: - # If page is out of range (e.g. 9999), deliver last page of results. - contacts = paginator.page(paginator.num_pages) - + contacts = paginator.get_page(page) return render(request, 'list.html', {'contacts': contacts}) In the template :file:`list.html`, you'll want to include navigation between @@ -177,6 +169,20 @@ Optional arguments Methods ------- +.. method:: Paginator.get_page(number) + + .. versionadded:: 2.0 + + Returns a :class:`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. + + It raises an exception (:exc:`EmptyPage`) only if you specify + ``Paginator(..., allow_empty_first_page=False)`` and the ``object_list`` is + empty. + .. method:: Paginator.page(number) Returns a :class:`Page` object with the given 1-based index. Raises |