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

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