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

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) или как переменная 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