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

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

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