分页器Link to this heading#

Paginator 类Link to this heading#

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Link to this definition#

当使用 len() 或直接迭代时，分页器的作用就像一个 Page 的序列。

Paginator.object_listLink to this definition#

必要的。一个列表、元组、QuerySet 或其他具有 count() 或 __len__() 方法的可切片对象。为了实现一致的分页，QuerySet 应该是有序的，例如使用 order_by() 子句或使用模型上的默认 ordering。

Paginator.per_pageLink to this definition#

必要的。一个页面中包含的最大项目数，不包括 orphans（参见下面的 orphans 可选参数）。

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, and orphans=3, there will be two pages; the first page with 10 items and the second (and last) page with 13 items. orphans defaults to zero, which means pages are never combined and the last page may have one item. orphans should be less than the per_page value.

Paginator.allow_empty_first_pageLink to this definition#

Optional. Whether or not the first page is allowed to be empty. If False and object_list is empty, then an EmptyPage error will be raised.

Paginator.error_messagesLink to this definition#

error_messages 参数允许你覆盖分页器将引发的默认消息。传入一个字典，其中的键与你想要覆盖的错误消息相匹配。可用的错误消息键包括：invalid_page、min_page 和 no_results。

例如，这里是默认的错误消息：

Python console

>>> from django.core.paginator import Paginator
>>> paginator = Paginator([1, 2, 3], 2)
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: That page contains no results

以下是一个自定义错误消息的示例：

Python console

>>> paginator = Paginator(
...     [1, 2, 3],
...     2,
...     error_messages={"no_results": "Page does not exist"},
... )
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: Page does not exist

AsyncPaginator classLink to this heading#

class AsyncPaginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Link to this definition#

Asynchronous version of Paginator.

AsyncPaginator has the same attributes and signatures as Paginator, with the following exceptions:

• The attribute Paginator.count is supported as an asynchronous method AsyncPaginator.acount().

• The attribute Paginator.num_pages is supported as an asynchronous method AsyncPaginator.anum_pages().

• The attribute Paginator.page_range is supported as an asynchronous method AsyncPaginator.apage_range().

AsyncPaginator has asynchronous versions of the same methods as Paginator, using an a prefix - for example, use await async_paginator.aget_page(number) rather than paginator.get_page(number).

Page 类Link to this heading#

你通常不会手工构建 Page 对象 —— 你将通过迭代 Paginator，或使用 Paginator.page() 获得它们。

class Page(object_list, number, paginator)Link to this definition#

当使用 len() 或直接迭代时，一个页面就像一个 Page.object_list 的序列。

AsyncPage classLink to this heading#

class AsyncPage(object_list, number, paginator)Link to this definition#

Asynchronous version of Page.

AsyncPage has the same attributes and signatures as Page, as well as asynchronous versions of all the same methods, using an a prefix - for example, use await async_page.ahas_next() rather than page.has_next().

AsyncPage has the following additional method:

aget_object_list()Link to this definition#

Returns AsyncPage.object_list as a list. This method must be awaited before AsyncPage can be treated as a sequence of AsyncPage.object_list.

异常Link to this heading#

exception InvalidPageLink to this definition#

当分页器被传递一个无效的页码时引发异常的基类。

Paginator.page() 方法在请求的页面无效（即不是整数）或不包含任何对象时引发异常。一般来说，只要捕获 InvalidPage 异常就够了，但如果你想要更细化，你可以捕获以下任何一种异常。

exception PageNotAnIntegerLink to this definition#

当 page() 的值不是整数时发生该事件。

exception EmptyPageLink to this definition#

当 page() 被赋予一个有效的值，但该页面上没有对象存在时，引发该异常。

这两个异常都是 InvalidPage 的子类，所以你可以用 except InvalidPage 处理这两个异常。