Класс Пагинатор¶

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)¶

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

Paginator.object_list¶

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

Проблемы с производительностью при разбиении на страницы больших QuerySetов.

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

Paginator.per_page¶

Необходимый. Максимальное количество элементов, которые можно включить на страницу, не включая потерянные элементы (см. необязательный аргумент orphans ниже).

Paginator.orphans¶

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

Paginator.allow_empty_first_page¶

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

Paginator.error_messages¶

New in Django 5.0.

Аргумент 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 вручную — вы получите их путем итерации Paginator или с помощью Paginator.page().

class Page(object_list, number, paginator)¶

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

Исключения¶

exception InvalidPage¶

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

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

exception PageNotAnInteger¶

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

exception EmptyPage¶

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

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