Смешанные объекты нескольких типов

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 не задано, имя контекста будет именем 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