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

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

A 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

Смешанный класс, который выполняет отрисовку ответа на основе шаблона для представлений, работающих со списком экземпляров объектов. Требуется, чтобы представление, с которым он смешан, предоставляло 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