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

Встроенные представления Django на основе классов предоставляют много функциональности, но некоторые части можно использовать по отдельности. Например, вы можете написать представление, которое отображает шаблон для создания HTTP-ответа, но вы не можете использовать представления Django на основе классов; возможно, вам нужно отобразить шаблон только при POST, а GET выполняет что-то совершенно другое. Хотя вы можете напрямую использовать TemplateResponse, это, скорее всего, приведет к дублированию кода.

По этой причине Django также предоставляет ряд миксинов, которые обеспечивают более дискретную функциональность. Например, отображение шаблона инкапсулировано в TemplateResponseMixin. Документация по справочной информации Django содержит полную документацию по всем миксинам.

Контекст и ответы шаблонов

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

TemplateResponseMixin

Вся встроенная функция, которая возвращает TemplateResponse, вызовет метод render_to_response(), который TemplateResponseMixin предоставляет. В большинстве случаев это будет вызываться за вас (например, оно вызывается методом get(), реализованным как TemplateView, так и DetailView); аналогично, вам, скорее всего, не придется его переопределять, хотя если вы хотите, чтобы ваш ответ возвращал что-то, не отображаемое с помощью шаблона Django, вам нужно это сделать. Пример этого см. в примере JSONResponseMixin.

render_to_response() сам вызывает get_template_names(), который по умолчанию будет искать template_name в представлении на основе класса; два других миксина (SingleObjectTemplateResponseMixin и MultipleObjectTemplateResponseMixin) переопределяют это, чтобы предоставить более гибкие значения по умолчанию при работе с фактическими объектами.

ContextMixin

Вся встроенная функция, которой требуется контекстная информация, например, для отображения шаблона (включая TemplateResponseMixin выше), должна вызывать get_context_data(), передавая все данные, которые она хочет включить, в качестве именованных аргументов. get_context_data() возвращает словарь; в ContextMixin он возвращает свои именованные аргументы, но часто требуется переопределять его, чтобы добавить больше элементов в словарь. Вы также можете использовать атрибут extra_context.

Создание представлений Django на основе классов с общим использованием

Давайте рассмотрим, как два общих представления Django на основе классов построены из миксинов, обеспечивающих дискретную функциональность. Мы рассмотрим DetailView, который отображает представление «детали» объекта, и ListView, который отобразит список объектов, как правило, из набора запросов, и при необходимости разделит их на страницы. Это познакомит нас с четырьмя миксинами, которые вместе предоставляют полезную функциональность при работе как с одним объектом Django, так и с несколькими объектами.

Также есть миксины, связанные с общими представлениями редактирования (FormView, и модель-специфическими представлениями CreateView, UpdateView и DeleteView), а также в представлениях, основанных на датах. Они описаны в документации по миксинам.

DetailView: работа с одним объектом Django

Чтобы отобразить детали объекта, нам в основном нужно сделать две вещи: найти объект и создать TemplateResponse с соответствующим шаблоном и этим объектом в качестве контекста.

Для получения объекта DetailView полагается на SingleObjectMixin, который предоставляет метод get_object(), который определяет объект на основе URL запроса (он ищет pk и slug именованные аргументы, как указано в URLConf, и находит объект либо из атрибута model представления, либо из атрибута queryset, если он указан). SingleObjectMixin также переопределяет get_context_data(), который используется во всех встроенных представлениях Django на основе классов для предоставления контекстных данных для отображения шаблона.

Для создания TemplateResponse, DetailView использует SingleObjectTemplateResponseMixin, который расширяет TemplateResponseMixin, переопределяя get_template_names(), как обсуждалось выше. Фактически, он предоставляет довольно сложный набор опций, но основная, которую большинство людей будут использовать, это <app_label>/<model_name>_detail.html. Часть _detail может быть изменена, установив template_name_suffix в подклассе на что-то другое. (Например, входные точки редактирования используют _form для просмотров создания и обновления и _confirm_delete для просмотров удаления.)

ListView: работа со многими объектами Django

Списки объектов следуют примерно тому же принципу: нам нужен (возможно, постраничный) список объектов, обычно QuerySet, и затем нам нужно создать TemplateResponse с соответствующим шаблоном, используя этот список объектов.

Для получения объектов ListView использует MultipleObjectMixin, который предоставляет как get_queryset(), так и paginate_queryset(). В отличие от SingleObjectMixin, нет необходимости использовать части URL для определения используемого набора запросов, поэтому по умолчанию используется атрибут queryset или model в классе представления. Частая причина переопределения get_queryset() заключается в динамическом изменении объектов, например, в зависимости от текущего пользователя или для исключения сообщений в будущем для блога.

MultipleObjectMixin также переопределяет get_context_data() для включения соответствующих переменных контекста для постраничности (предоставляя заглушки, если постраничность отключена). Он полагается на object_list, переданный в качестве ключевого аргумента, что ListView организует.

Для создания TemplateResponse, ListView затем использует MultipleObjectTemplateResponseMixin; как и SingleObjectTemplateResponseMixin выше, это переопределяет get_template_names() для предоставления a range of options, причём наиболее часто используется <app_label>/<model_name>_list.html, а часть _list снова берется из атрибута template_name_suffix. (Дата-зависимые общие представления используют суффиксы, такие как _archive, _archive_year и т.д., для использования различных шаблонов для различных специализированных дата-зависимых списков представлений.)

Использование наборов миксинов Django для представлений с классами

Теперь, когда мы увидели, как общие представления Django с классами используют предоставленные наборы миксинов, давайте рассмотрим другие способы их комбинирования. Мы по-прежнему будем комбинировать их с встроенными представлениями с классами или другими общими представлениями с классами, но есть ряд более редких проблем, которые можно решить, чем те, которые предоставляет Django по умолчанию.

Использование SingleObjectMixin с View

Если мы хотим написать представление с классом, которое будет реагировать только на POST, мы унаследуем от View и напишем метод post() в подклассе. Однако если мы хотим, чтобы наша обработка работала с определенным объектом, идентифицируемым по URL, нам потребуется функциональность, предоставляемая SingleObjectMixin.

Мы продемонстрируем это с моделью Author, которую мы использовали в введении в представления с классами.

from django.http import HttpResponseForbidden, HttpResponseRedirect
from django.urls import reverse
from django.views import View
from django.views.generic.detail import SingleObjectMixin
from books.models import Author


class RecordInterestView(SingleObjectMixin, View):
    """Records the current user's interest in an author."""

    model = Author

    def post(self, request, *args, **kwargs):
        if not request.user.is_authenticated:
            return HttpResponseForbidden()

        # Look up the author we're interested in.
        self.object = self.get_object()
        # Actually record interest somehow here!

        return HttpResponseRedirect(
            reverse("author-detail", kwargs={"pk": self.object.pk})
        )

На практике, скорее всего, вы захотите записывать интерес к ключу-значению в хранилище ключей-значений, а не в реляционной базе данных, поэтому мы эту часть убрали. Единственная часть представления, которая должна беспокоиться о использовании SingleObjectMixin, это место, где мы хотим найти автора, который нас интересует, что оно делает с вызовом self.get_object(). Всё остальное за нас обрабатывается миксином.

Мы можем легко подключить это к нашим URL:

from django.urls import path
from books.views import RecordInterestView

urlpatterns = [
    # ...
    path(
        "author/<int:pk>/interest/",
        RecordInterestView.as_view(),
        name="author-interest",
    ),
]

Обратите внимание на именованную группу pk, которую get_object() использует для поиска экземпляра Author. Вы также можете использовать слаг или любые другие функции SingleObjectMixin.

Использование SingleObjectMixin с ListView

ListView предоставляет встроенную постраничную навигацию, но вы можете захотеть постранично просматривать список объектов, которые все связаны (с помощью внешнего ключа) с другим объектом. В нашем примере публикации вы можете захотеть просмотреть все книги конкретного издателя.

Один из способов сделать это — объединить ListView с SingleObjectMixin, чтобы набор запросов для постраничного списка книг мог зависеть от издателя, найденного как единственный объект. Для этого нам нужно иметь два разных набора запросов:

Book queryset for use by ListView

Поскольку у нас есть доступ к Publisher, чьи книги мы хотим отобразить, мы переопределяем get_queryset() и используем менеджер обратного внешнего ключа Publisher.

Publisher queryset for use in get_object()

Мы будем полагаться на стандартную реализацию get_object() для получения правильного объекта Publisher. Однако нам необходимо явно передать аргумент queryset, потому что в противном случае стандартная реализация get_object() вызовет get_queryset(), которое мы переопределили для возврата объектов Book вместо объектов Publisher.

Теперь мы можем написать новую PublisherDetailView:

from django.views.generic import ListView
from django.views.generic.detail import SingleObjectMixin
from books.models import Publisher


class PublisherDetailView(SingleObjectMixin, ListView):
    paginate_by = 2
    template_name = "books/publisher_detail.html"

    def get(self, request, *args, **kwargs):
        self.object = self.get_object(queryset=Publisher.objects.all())
        return super().get(request, *args, **kwargs)

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context["publisher"] = self.object
        return context

    def get_queryset(self):
        return self.object.book_set.all()

Обратите внимание, как мы установили self.object в get(), чтобы мы могли использовать его снова позже в get_context_data() и get_queryset(). Если вы не установите template_name, шаблон по умолчанию будет использовать стандартный вариант ListView, который в данном случае будет "books/book_list.html", потому что это список книг; ListView ничего не знает о SingleObjectMixin, поэтому у него нет никаких представлений о том, что это представление связано с Publisher.

Примерно paginate_by преднамеренно невелик, чтобы вам не приходилось создавать много книг, чтобы увидеть, как работает постраничная навигация! Вот шаблон, который вы хотели бы использовать:

{% extends "base.html" %}

{% block content %}
    <h2>Publisher {{ publisher.name }}</h2>

    <ol>
      {% for book in page_obj %}
        <li>{{ book.title }}</li>
      {% endfor %}
    </ol>

    <div class="pagination">
        <span class="step-links">
            {% if page_obj.has_previous %}
                <a href="?page={{ page_obj.previous_page_number }}">previous</a>
            {% endif %}

            <span class="current">
                Page {{ page_obj.number }} of {{ paginator.num_pages }}.
            </span>

            {% if page_obj.has_next %}
                <a href="?page={{ page_obj.next_page_number }}">next</a>
            {% endif %}
        </span>
    </div>
{% endblock %}

Избегайте чего-либо более сложного

Как правило, вы можете использовать TemplateResponseMixin и SingleObjectMixin, когда вам нужна их функциональность. Как показано выше, при небольших усилиях вы даже можете объединить SingleObjectMixin с ListView. Однако вещи становятся все более сложными, когда вы пытаетесь это сделать, и хорошим правилом является:

Чтобы продемонстрировать, что происходит, когда вы пытаетесь сделать что-то более сложное, мы покажем пример, который жертвует удобочитаемостью и поддерживаемостью, когда есть более простое решение. Сначала посмотрим на наивный метод объединения DetailView с FormMixin, чтобы позволить нам POST Django Form по тому же URL, что и отображение объекта с помощью DetailView.

Использование FormMixin с DetailView

Вспомните наш предыдущий пример использования View и SingleObjectMixin вместе. Мы записывали интерес пользователя к конкретному автору; скажем теперь, что мы хотим дать им возможность оставить сообщение, объясняя, почему им нравится этот автор. Опять же, предположим, что мы не будем хранить это в реляционной базе данных, а вместо этого в чем-то более экзотическом, о чем мы здесь беспокоиться не будем.

На этом этапе естественно обратиться к Form для инкапсуляции информации, отправленной браузером пользователя Django. Предположим также, что мы сильно ориентированы на REST, поэтому мы хотим использовать один и тот же URL для отображения автора и для получения сообщения от пользователя. Давайте перепишем наш AuthorDetailView для этого.

Мы сохраним обработку GET от DetailView, хотя нам нужно будет добавить Form в данные контекста, чтобы мы могли отобразить его в шаблоне. Мы также захотим включить обработку формы из FormMixin и написать немного кода, чтобы при POST форма вызывалась должным образом.

Наш новый AuthorDetailView выглядит следующим образом:

# CAUTION: you almost certainly do not want to do this.
# It is provided as part of a discussion of problems you can
# run into when combining different generic class-based view
# functionality that is not designed to be used together.

from django import forms
from django.http import HttpResponseForbidden
from django.urls import reverse
from django.views.generic import DetailView
from django.views.generic.edit import FormMixin
from books.models import Author


class AuthorInterestForm(forms.Form):
    message = forms.CharField()


class AuthorDetailView(FormMixin, DetailView):
    model = Author
    form_class = AuthorInterestForm

    def get_success_url(self):
        return reverse("author-detail", kwargs={"pk": self.object.pk})

    def post(self, request, *args, **kwargs):
        if not request.user.is_authenticated:
            return HttpResponseForbidden()
        self.object = self.get_object()
        form = self.get_form()
        if form.is_valid():
            return self.form_valid(form)
        else:
            return self.form_invalid(form)

    def form_valid(self, form):
        # Here, we would record the user's interest using the message
        # passed in form.cleaned_data['message']
        return super().form_valid(form)

get_success_url() предоставляет место для перенаправления, которое используется в реализации form_valid() по умолчанию. Мы должны предоставить собственную post(), как отмечалось ранее.

Более эффективное решение

Количество тонких взаимодействий между FormMixin и DetailView уже проверяет нашу способность управлять вещами. Вряд ли вам захочется писать этот тип класса самостоятельно.

В этом случае вы могли бы написать метод post() самостоятельно, сохраняя DetailView единственной общей функцией, хотя написание кода обработки Form влечёт за собой много дублирования.

В качестве альтернативы, это всё равно было бы проще, чем вышеупомянутый подход, иметь отдельное представление для обработки формы, которое могло бы использовать FormView, отличное от DetailView без опасений.

Альтернативное более эффективное решение

На самом деле, мы пытаемся использовать два разных представления на основе классов из одного URL. Так почему бы не сделать именно так? У нас есть очень чёткое разделение: запросы GET должны получить DetailView (с Form, добавленным в данные контекста), а запросы POST должны получить FormView. Давайте сначала настроим эти представления.

Представление AuthorDetailView почти такое же, как когда мы впервые представили AuthorDetailView; нам нужно написать собственное get_context_data() для того, чтобы AuthorInterestForm было доступно шаблону. Мы пропустим переопределение get_object() из предыдущего примера для ясности:

from django import forms
from django.views.generic import DetailView
from books.models import Author


class AuthorInterestForm(forms.Form):
    message = forms.CharField()


class AuthorDetailView(DetailView):
    model = Author

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context["form"] = AuthorInterestForm()
        return context

Затем AuthorInterestFormView является FormView, но нам нужно включить SingleObjectMixin, чтобы мы могли найти автора, о котором идёт речь, и нам нужно помнить, чтобы установить template_name для того, чтобы ошибки формы отображались в том же шаблоне, что и AuthorDetailView использует в GET:

from django.http import HttpResponseForbidden
from django.urls import reverse
from django.views.generic import FormView
from django.views.generic.detail import SingleObjectMixin


class AuthorInterestFormView(SingleObjectMixin, FormView):
    template_name = "books/author_detail.html"
    form_class = AuthorInterestForm
    model = Author

    def post(self, request, *args, **kwargs):
        if not request.user.is_authenticated:
            return HttpResponseForbidden()
        self.object = self.get_object()
        return super().post(request, *args, **kwargs)

    def get_success_url(self):
        return reverse("author-detail", kwargs={"pk": self.object.pk})

Наконец, мы объединяем всё это в новом представлении AuthorView. Мы уже знаем, что вызов as_view() для представления на основе класса даёт нам нечто, что ведёт себя точно как представление на основе функции, поэтому мы можем сделать это в тот момент, когда выбираем между двумя подпредставлениями.

Вы можете передать ключевые аргументы в as_view() таким же способом, как в вашем URLconf, например, если вы хотели, чтобы поведение AuthorInterestFormView также появилось в другом URL, но с использованием другого шаблона:

from django.views import View


class AuthorView(View):
    def get(self, request, *args, **kwargs):
        view = AuthorDetailView.as_view()
        return view(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        view = AuthorInterestFormView.as_view()
        return view(request, *args, **kwargs)

Этот подход также можно использовать с любыми другими представлениями на основе классов или собственными представлениями на основе классов, наследующими непосредственно от View или TemplateView, так как он позволяет держать разные представления максимально независимыми.

Больше чем просто HTML

Преимущество представлений на основе классов проявляется, когда вам нужно сделать одно и то же многократно. Предположим, вы пишете API, и каждое представление должно возвращать JSON вместо рендеринг HTML.

Мы можем создать класс миксин, чтобы использовать его во всех наших представлениях, обрабатывая преобразование в JSON один раз.

Например, миксин JSON может выглядеть примерно так:

from django.http import JsonResponse


class JSONResponseMixin:
    """
    A mixin that can be used to render a JSON response.
    """

    def render_to_json_response(self, context, **response_kwargs):
        """
        Returns a JSON response, transforming 'context' to make the payload.
        """
        return JsonResponse(self.get_data(context), **response_kwargs)

    def get_data(self, context):
        """
        Returns an object that will be serialized as JSON by json.dumps().
        """
        # Note: This is *EXTREMELY* naive; in reality, you'll need
        # to do much more complex handling to ensure that arbitrary
        # objects -- such as Django model instances or querysets
        # -- can be serialized as JSON.
        return context

Этот миксин предоставляет метод render_to_json_response() с той же сигнатурой, что и render_to_response(). Для его использования нам нужно смешать его в TemplateView и переопределить render_to_response() для вызова render_to_json_response() вместо этого:

from django.views.generic import TemplateView


class JSONView(JSONResponseMixin, TemplateView):
    def render_to_response(self, context, **response_kwargs):
        return self.render_to_json_response(context, **response_kwargs)

Аналогично, мы могли бы использовать наш миксин с одним из общих представлений. Мы можем создать собственную версию DetailView, смешав JSONResponseMixin с BaseDetailView – (поведение DetailView до рендеринга шаблона было включено):

from django.views.generic.detail import BaseDetailView


class JSONDetailView(JSONResponseMixin, BaseDetailView):
    def render_to_response(self, context, **response_kwargs):
        return self.render_to_json_response(context, **response_kwargs)

Это представление можно развернуть так же, как и любое другое DetailView, с точно таким же поведением – за исключением формата ответа.

Если вы хотите быть действительно смелыми, вы можете даже смешать подкласс DetailView, который может возвращать как HTML, так и JSON-контент, в зависимости от свойства HTTP-запроса, такого как аргумент запроса или заголовок HTTP. Смешайте как JSONResponseMixin , так и SingleObjectTemplateResponseMixin, и переопределите реализацию render_to_response() для перехода к соответствующему методу рендеринга в зависимости от типа ответа, который запросил пользователь:

from django.views.generic.detail import SingleObjectTemplateResponseMixin


class HybridDetailView(
    JSONResponseMixin, SingleObjectTemplateResponseMixin, BaseDetailView
):
    def render_to_response(self, context):
        # Look for a 'format=json' GET argument
        if self.request.GET.get("format") == "json":
            return self.render_to_json_response(context)
        else:
            return super().render_to_response(context)

Из-за того, как Python решает перегрузку методов, вызов super().render_to_response(context) приводит к вызову реализации render_to_response() в TemplateResponseMixin.