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

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 объектами на странице. Представление будет ожидать параметр строки запроса %%%CODE_BLOCK_35%% (через 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 не задано, имя контекста будет именем model_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