Обработка форм с помощью представлений на основе классов

Простые формы

Предположим, у нас есть контактная форма:

from django import forms


class ContactForm(forms.Form):
    name = forms.CharField()
    message = forms.CharField(widget=forms.Textarea)

    def send_email(self):
        # send email using the self.cleaned_data dictionary
        pass

Представление можно создать с помощью FormView:

from myapp.forms import ContactForm
from django.views.generic.edit import FormView


class ContactFormView(FormView):
    template_name = "contact.html"
    form_class = ContactForm
    success_url = "/thanks/"

    def form_valid(self, form):
        # This method is called when valid form data has been POSTed.
        # It should return an HttpResponse.
        form.send_email()
        return super().form_valid(form)

Примечания:

• FormView наследуется от TemplateResponseMixin, поэтому здесь можно использовать template_name.
• Реализация form_valid() по умолчанию просто перенаправляет на success_url.

Формы моделей

Универсальные представления особенно полезны при работе с моделями. Эти представления автоматически создают ModelForm, если могут определить, какой класс модели использовать:

• Если задан атрибут model, будет использоваться этот класс модели.
• Если get_object() возвращает объект, будет использоваться класс этого объекта.
• Если задан queryset, будет использоваться модель этого набора запросов.

Представления форм моделей предоставляют реализацию form_valid(), которая автоматически сохраняет модель. При необходимости можно переопределить этот метод; примеры приведены ниже.

Для CreateView или UpdateView даже не нужно задавать success_url — они используют get_absolute_url() объекта модели, если он доступен.

Чтобы использовать пользовательский ModelForm (например, для добавления дополнительной проверки), задайте в представлении form_class.

Сначала добавим get_absolute_url() в класс Author:

from django.db import models
from django.urls import reverse


class Author(models.Model):
    name = models.CharField(max_length=200)

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

Затем можно использовать CreateView и другие представления для выполнения основной работы. Обратите внимание: здесь мы лишь настраиваем универсальные представления на основе классов и не пишем логику самостоятельно:

from django.urls import reverse_lazy
from django.views.generic.edit import CreateView, DeleteView, UpdateView
from myapp.models import Author


class AuthorCreateView(CreateView):
    model = Author
    fields = ["name"]


class AuthorUpdateView(UpdateView):
    model = Author
    fields = ["name"]


class AuthorDeleteView(DeleteView):
    model = Author
    success_url = reverse_lazy("author-list")

Атрибут fields работает так же, как атрибут fields во внутреннем классе Meta в ModelForm. Если не определить класс формы другим способом, этот атрибут обязателен, и представление вызовет исключение ImproperlyConfigured, если он не задан.

Если задать одновременно атрибуты fields и form_class, будет вызвано исключение ImproperlyConfigured.

Наконец, добавим эти новые представления в конфигурацию URL:

from django.urls import path
from myapp.views import AuthorCreateView, AuthorDeleteView, AuthorUpdateView

urlpatterns = [
    # ...
    path("author/add/", AuthorCreateView.as_view(), name="author-add"),
    path("author/<int:pk>/", AuthorUpdateView.as_view(), name="author-update"),
    path("author/<int:pk>/delete/", AuthorDeleteView.as_view(), name="author-delete"),
]

Модели и request.user

Чтобы отслеживать пользователя, создавшего объект с помощью CreateView, можно использовать пользовательский ModelForm. Сначала добавьте в модель связь с внешним ключом:

from django.contrib.auth.models import User
from django.db import models


class Author(models.Model):
    name = models.CharField(max_length=200)
    created_by = models.ForeignKey(User, on_delete=models.CASCADE)

    # ...

В представлении исключите created_by из списка редактируемых полей и переопределите form_valid(), чтобы добавить пользователя:

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import CreateView
from myapp.models import Author


class AuthorCreateView(LoginRequiredMixin, CreateView):
    model = Author
    fields = ["name"]

    def form_valid(self, form):
        form.instance.created_by = self.request.user
        return super().form_valid(form)

LoginRequiredMixin не позволяет незалогиненным пользователям обращаться к форме. Если не использовать этот миксин, необходимо обработать запросы неавторизованных пользователей в form_valid().

Пример согласования содержимого

Ниже приведён пример реализации формы, которая работает как с API-сценарием, так и с обычными POST-запросами формы:

from django.http import JsonResponse
from django.views.generic.edit import CreateView
from myapp.models import Author


class JsonableResponseMixin:
    """
    Mixin to add JSON support to a form.
    Must be used with an object-based FormView (e.g. CreateView)
    """

    def form_invalid(self, form):
        response = super().form_invalid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            return JsonResponse(form.errors, status=400)

    def form_valid(self, form):
        # We make sure to call the parent's form_valid() method because
        # it might do some processing (in the case of CreateView, it will
        # call form.save() for example).
        response = super().form_valid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            data = {
                "pk": self.object.pk,
            }
            return JsonResponse(data)


class AuthorCreateView(JsonableResponseMixin, CreateView):
    model = Author
    fields = ["name"]

В приведённом выше примере предполагается, что клиент предпочитает text/html, если поддерживает его. Однако так бывает не всегда. При запросе файла .css многие браузеры отправляют заголовок Accept: text/css,*/*;q=0.1, указывая, что предпочитают CSS, но подходят и любые другие данные. Это означает, что request.accepts("text/html") будет True.

Чтобы определить подходящий формат с учётом предпочтений клиента, используйте django.http.HttpRequest.get_preferred_type():

class JsonableResponseMixin:
    """
    Mixin to add JSON support to a form.
    Must be used with an object-based FormView (e.g. CreateView).
    """

    accepted_media_types = ["text/html", "application/json"]

    def dispatch(self, request, *args, **kwargs):
        if request.get_preferred_type(self.accepted_media_types) is None:
            # No format in common.
            return HttpResponse(
                status_code=406, headers={"Accept": ",".join(self.accepted_media_types)}
            )

        return super().dispatch(request, *args, **kwargs)

    def form_invalid(self, form):
        response = super().form_invalid(form)
        accepted_type = self.request.get_preferred_type(self.accepted_media_types)
        if accepted_type == "text/html":
            return response
        elif accepted_type == "application/json":
            return JsonResponse(form.errors, status=400)

    def form_valid(self, form):
        # We make sure to call the parent's form_valid() method because
        # it might do some processing (in the case of CreateView, it will
        # call form.save() for example).
        response = super().form_valid(form)
        accepted_type = self.request.get_preferred_type(self.accepted_media_types)
        if accepted_type == "text/html":
            return response
        elif accepted_type == "application/json":
            data = {
                "pk": self.object.pk,
            }
            return JsonResponse(data)