Смеси для отображения нескольких объектов

MultipleObjectMixin

class django.views.generic.list.MultipleObjectMixin

Смесь, используемая для отображения списка объектов.

Если paginate_by указано, Django будет странировать полученные результаты. Вы можете указать номер страницы в URL двумя способами:

• Используйте параметр page в URLconf. Например, ваш URLconf может выглядеть так:

  url(r'^objects/page(?P<page>[0-9]+)/$', 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) или в качестве переменной, указанной в 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

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