Многообъектные миксины

MultipleObjectMixin

class django.views.generic.list.MultipleObjectMixin

Миксин, который может использоваться для отображения списка объектов.

Если paginate_by указано, Django будет странировать результаты, возвращаемые этим миксином. Вы можете указать номер страницы в URL двумя способами:

• Используйте параметр page в URLconf. Например, так может выглядеть ваш URLconf:

  path("objects/page<int:page>/", PaginatedView.as_view()),
  

• Передайте номер страницы через параметр page в строке запроса. Например, URL будет выглядеть так:

  /objects/?page=3
  

Эти значения и списки нумеруются с 1, а не с 0, поэтому первая страница будет представлена как страница 1.

Подробнее о пагинации читайте в документации по пагинации.

В качестве специального случая, вы также можете использовать last в качестве значения для page:

/objects/?page=last

Это позволяет вам получить доступ к последней странице результатов, не определяя предварительно количество страниц.

Обратите внимание, что page обязательно должно быть либо корректным номером страницы, либо значением last; любое другое значение для page приведет к ошибке 404.

Расширяет

• django.views.generic.base.ContextMixin

Методы и атрибуты

allow_empty

Булево значение, определяющее, отображать ли страницу, если доступных объектов нет. Если это значение False и доступных объектов нет, представление вернет ошибку 404 вместо отображения пустой страницы. По умолчанию, это True.

model

Модель, для которой это представление будет отображать данные. Указание model = Foo фактически эквивалентно указанию queryset = Foo.objects.all(), где objects обозначает стандартный менеджер для Foo.

queryset

Объект QuerySet, представляющий объекты. Если он указан, значение queryset переопределяет значение, предоставленное для model.

Предупреждение

queryset — это атрибут класса со изменяемым значением, поэтому при его непосредственном использовании необходимо соблюдать осторожность. Перед его использованием вызовите метод all() или получите его с помощью get_queryset(), что позаботится о клонировании в фоновом режиме.

ordering

Строка или список строк, определяющие порядок сортировки queryset. Допустимые значения аналогичны тем, что используются в order_by().

paginate_by

Целое число, указывающее количество объектов на странице. Если это значение задано, представление будет странировать объекты с paginate_by объектами на странице. Представление будет ожидать параметр строки запроса page (через request.GET) или переменную page, указанную в URLconf.

paginate_orphans

Целое число, указывающее количество «лишних» объектов, которые может содержать последняя страница. Это расширяет ограничение paginate_by на последней странице до paginate_orphans, чтобы избежать слишком маленького количества объектов на последней странице.

page_kwarg

Строка, указывающая имя параметра страницы. Представление будет ожидать этот параметр как параметр строки запроса (через request.GET) или как переменную kwarg, указанную в URLconf. По умолчанию это page.

paginator_class

Класс пагинатора, используемый для пагинации. По умолчанию используется django.core.paginator.Paginator. Если у пользовательского класса пагинатора нет такого же интерфейса конструктора, что и у django.core.paginator.Paginator, вам также потребуется реализовать get_paginator().

context_object_name

Указывает имя переменной для использования в контексте.

get_queryset()

Получить список элементов для этого представления. Это должен быть итерируемый объект, который может быть набором запросов (в этом случае будут включены специфичные для набора запросов функции).

get_ordering()

Возвращает строку (или итерируемый объект строк), определяющую порядок сортировки queryset.

По умолчанию возвращает ordering.

paginate_queryset(queryset, page_size)

Возвращает кортеж из 4 элементов, содержащий (paginator, page, object_list, is_paginated).

Сформирован путем странирования queryset на страницы размером page_size. Если запрос содержит аргумент page, как аргумент URL, так и аргумент GET, object_list будет соответствовать объектам с этой страницы.

get_paginate_by(queryset)

Возвращает количество элементов для страниц, или None для отсутствия пагинации. По умолчанию, возвращает значение paginate_by.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True)

Возвращает экземпляр пагинатора, используемого для этого представления. По умолчанию, создает экземпляр paginator_class.

get_paginate_orphans()

Целое число, указывающее количество «лишних» объектов, которые может содержать последняя страница. По умолчанию, возвращает значение paginate_orphans.

get_allow_empty()

Возвращает булево значение, указывающее, отображать ли страницу, если доступных объектов нет. Если этот метод возвращает False и доступных объектов нет, представление вернет ошибку 404 вместо отображения пустой страницы. По умолчанию, это True.

get_context_object_name(object_list)

Возвращает имя контекстной переменной, которое будет использоваться для хранения списка данных, с которыми работает это представление. Если object_list является набором запросов Django объектов, и context_object_name не задано, имя контекстной переменной будет именем модели, из которой составлен набор запросов, с добавлением постфикса '_list'. Например, модель Article будет иметь контекстную переменную с именем article_list.

get_context_data(**kwargs)

Возвращает данные контекста для отображения списка объектов.

Контекст

• object_list: Список объектов, отображаемых этим представлением. Если context_object_name задан, эта переменная также будет установлена в контексте со значением, равным object_list.
• is_paginated: Логическое значение, указывающее, отформатированы ли результаты постранично. В частности, это значение установлено в False, если размер страницы не указан или доступные объекты не занимают несколько страниц.
• paginator: Экземпляр django.core.paginator.Paginator. Если страница не постраничена, эта переменная контекста будет None.
• page_obj: Экземпляр django.core.paginator.Page. Если страница не постраничена, эта переменная контекста будет None.

MultipleObjectTemplateResponseMixin

class django.views.generic.list.MultipleObjectTemplateResponseMixin

Mixin-класс, выполняющий рендеринг ответа на основе шаблона для представлений, работающих со списком экземпляров объектов. Требует, чтобы представление, к которому он применён, предоставляло self.object_list, список экземпляров объектов, на которых работает представление. self.object_list может быть, но не обязательно, QuerySet.

Расширяет

• TemplateResponseMixin

Методы и атрибуты

template_name_suffix

Суффикс, добавляемый к автоматически сгенерированному имени шаблона. По умолчанию суффикс _list.

get_template_names()

Возвращает список кандидатов на имя шаблона. Возвращает следующий список:

• значение template_name в представлении (если задано)
• <app_label>/<model_name><template_name_suffix>.html