Paginator¶

Paginator класс¶

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 в модели.

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

Если вы используете 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¶

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 класс¶

Обычно вы не создаете объекты 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, поэтому их можно обрабатывать с помощью except InvalidPage.