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

Обработка форм, как правило, имеет 3 пути:

• Изначальный GET-запрос (пустая или заполненная форма)
• POST-запрос с некорректными данными (как правило, повторное отображение формы с ошибками)
• POST-запрос с корректными данными (обработка данных и, как правило, перенаправление)

Реализация этого самостоятельно часто приводит к большому количеству повторяющегося кода (см. Использование формы в представлении). Для того, чтобы избежать этого, Django предоставляет набор обобщенных представлений на основе классов для обработки форм.

Базовые формы

Рассмотрим форму обратной связи:

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(), которая автоматически сохраняет модель. Вы можете переопределить её, если у вас есть особые требования; см. примеры ниже.

Вам даже не нужно указывать success_url для CreateView или UpdateView — они будут использовать 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.

Наконец, мы подключаем эти новые представления к URLconf:

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"]