Разделитель страниц

Paginator класс

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None) [source]

Разделитель страниц ведет себя как последовательность Page при использовании len() или итерации напрямую.

Paginator.object_list

Обязательно. Список, кортеж, QuerySet или другой объект с возможностью срезов, имеющий метод count() или __len__(). Для согласованной постраничной навигации объекты должны быть упорядочены, например, с помощью условия order_by() или со стандартным значением ordering в модели.

Проблемы производительности при постраничной навигации по большим QuerySet

Если вы используете QuerySet с очень большим количеством элементов, запрос высоких номеров страниц может быть медленным на некоторых базах данных, поскольку полученный LIMIT/OFFSET запрос должен подсчитать количество OFFSET записей, что занимает больше времени по мере увеличения номера страницы.

Paginator.per_page

Обязательно. Максимальное количество элементов на странице, не считая «сирот» (см. необязательный аргумент orphans ниже).

Paginator.orphans

Необязательно. Используйте этот аргумент, когда вы не хотите иметь последнюю страницу с очень небольшим количеством элементов. Если последняя страница обычно содержит количество элементов меньше или равное orphans, то эти элементы будут добавлены к предыдущей странице (которая станет последней), вместо того, чтобы оставлять эти элементы на странице сами по себе. Например, с 23 элементами, per_page=10 и orphans=3, будет две страницы: первая страница с 10 элементами и вторая (и последняя) страница с 13 элементами. orphans по умолчанию равен нулю, что означает, что страницы никогда не объединяются, и последняя страница может содержать один элемент.

Paginator.allow_empty_first_page

Необязательно. Разрешает ли пустую первую страницу. Если False и object_list пусто, будет поднята ошибка EmptyPage.

Paginator.error_messages

Аргумент error_messages позволяет переопределить стандартные сообщения, которые будет генерировать разделитель страниц. Передайте словарь с ключами, соответствующими сообщениям об ошибках, которые вы хотите переопределить. Доступные ключи сообщений об ошибках: invalid_page, min_page и no_results.

Например, вот стандартное сообщение об ошибке:

>>> 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

А вот настраиваемое сообщение об ошибке:

>>> 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

Page класс

Обычно вы не создаёте объекты Page вручную — вы получаете их, итерируя Paginator или используя Paginator.page().

class Page(object_list, number, paginator) [source]

Страница ведет себя как последовательность Page.object_list при использовании len() или при непосредственной итерации.

Исключения

exception InvalidPage [source]

Базовый класс исключений, которые генерируются, когда пагинатору передан недопустимый номер страницы.

Метод Paginator.page() генерирует исключение, если запрошенная страница недопустима (то есть не является целым числом) или не содержит объектов. Обычно достаточно перехватить исключение InvalidPage, но если вам нужно больше контроля, вы можете перехватить любое из следующих исключений:

exception PageNotAnInteger [source]

Вызывается, когда page() получает значение, которое не является целым числом.

exception EmptyPage [source]

Вызывается, когда page() получает допустимое значение, но на этой странице нет объектов.

Оба исключения являются подклассами InvalidPage, поэтому вы можете обработать оба их с помощью except InvalidPage.