Смеси для одиночных объектов

SingleObjectMixin

class django.views.generic.detail.SingleObjectMixin

Предоставляет механизм для поиска объекта, связанного с текущим HTTP-запросом.

Методы и атрибуты

model

Модель, для которой эта страница будет отображать данные. Указание model = Foo фактически эквивалентно указанию queryset = Foo.objects.all(), где objects обозначает стандартный менеджер модели Foo.

queryset

Объект QuerySet, представляющий объекты. Если задано, значение queryset имеет приоритет над значением, указанным для model.

Предупреждение

queryset — это атрибут класса со изменяемым значением, поэтому при работе с ним необходимо соблюдать осторожность. Перед использованием вызовите его метод all() или получите его с помощью get_queryset(), который позаботится о клонировании за кулисами.

slug_field

Имя поля в модели, содержащего slug. По умолчанию, slug_field равно 'slug'.

slug_url_kwarg

Имя аргумента ключевого слова URLConf, содержащего slug. По умолчанию, slug_url_kwarg равно 'slug'.

pk_url_kwarg

Имя аргумента ключевого слова URLConf, содержащего первичный ключ. По умолчанию, pk_url_kwarg равно 'pk'.

context_object_name

Определяет имя переменной для использования в контексте.

query_pk_and_slug

Если True, заставляет get_object() выполнять поиск с использованием как первичного ключа, так и slug. По умолчанию равно False.

Этот атрибут помогает минимизировать атаки с использованием некорректных ссылок на объекты. Когда приложения разрешают доступ к отдельным объектам по последовательному первичному ключу, злоумышленник может перебрать все URL-адреса, тем самым получив список всех объектов приложения. Если пользователям, имеющим доступ к отдельным объектам, следует запретить получение этого списка, установка query_pk_and_slug на True поможет предотвратить угадывание URL-адресов, так как каждый URL-адрес будет требовать двух корректных, не последовательных аргументов. Просто использование уникального slug может служить той же цели, но эта схема позволяет иметь не уникальные slug.

get_object(queryset=None)

Возвращает единственный объект, который эта страница будет отображать. Если queryset задано, этот queryset будет использоваться в качестве источника объектов; в противном случае, используется get_queryset(). get_object() ищет аргумент pk_url_kwarg в аргументах представления; если этот аргумент найден, этот метод выполняет поиск по первичному ключу, используя это значение. Если этот аргумент не найден, он ищет аргумент slug_url_kwarg и выполняет поиск по slug, используя slug_field.

Когда query_pk_and_slug равно True, get_object() выполнит поиск, используя и первичный ключ, и slug.

get_queryset()

Возвращает queryset, который будет использоваться для получения объекта, который эта страница будет отображать. По умолчанию, get_queryset() возвращает значение атрибута queryset, если оно задано, в противном случае создает QuerySet вызвав метод all() на стандартном менеджере атрибута model.

get_context_object_name(obj)

Возвращает имя переменной контекста, которая будет использоваться для хранения данных, с которыми работает эта страница. Если context_object_name не задан, имя контекста будет сконструировано из названия модели, из которой составлен queryset. Например, модель Article будет иметь имя переменной контекста 'article'.

get_context_data(**kwargs)

Возвращает данные контекста для отображения списка объектов.

Базовая реализация этого метода требует, чтобы атрибут self.object был установлен в представлении (даже если None). Не забудьте сделать это, если вы используете этот миксин без одного из встроенных представлений, которые это делают.

Он возвращает словарь с этим содержимым:

• object: Объект, который эта страница отображает (self.object).
• context_object_name: self.object также будет сохранен под именем, возвращаемым get_context_object_name(), которое по умолчанию является нижним регистром названия модели.

Переменные контекста переопределяют значения из процессоров шаблона контекста

Любые переменные из get_context_data() имеют приоритет над переменными контекста из процессоров контекста. Например, если ваше представление задает атрибут model на User, имя переменной контекста по умолчанию user переопределит переменную user из процессора контекста django.contrib.auth.context_processors.auth(). Используйте get_context_object_name(), чтобы избежать конфликтов.

get_slug_field()

Возвращает имя поля slug, которое будет использоваться для поиска по slug. По умолчанию, это просто возвращает значение slug_field.

SingleObjectTemplateResponseMixin

class django.views.generic.detail.SingleObjectTemplateResponseMixin

Класс-миксин, который выполняет рендеринг ответа на основе шаблона для представлений, работающих с одним объектом. Требует, чтобы представление, к которому он применён, предоставляло self.object, экземпляр объекта, с которым работает представление. self.object обычно, но не обязательно, является экземпляром Django модели. Он может быть None если представление находится в процессе создания нового экземпляра.

Расширяет

• TemplateResponseMixin

Методы и атрибуты

template_name_field

Поле в текущем экземпляре объекта, которое можно использовать для определения имени кандидата в шаблоне. Если само template_name_field или значение template_name_field в текущем экземпляре объекта равно None, объект не будет использован для имени кандидата в шаблоне.

template_name_suffix

Суффикс, добавляемый к автоматически сгенерированному имени кандидата шаблона. По умолчанию суффикс _detail.

get_template_names()

Возвращает список имен кандидатных шаблонов. Возвращает следующий список:

• значение template_name в представлении (если указано)
• содержимое поля template_name_field в экземпляре объекта, с которым работает представление (если доступно)
• <app_label>/<model_name><template_name_suffix>.html