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

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

• Изначальный 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 ContactView(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 AuthorCreate(CreateView):
    model = Author
    fields = ['name']

class AuthorUpdate(UpdateView):
    model = Author
    fields = ['name']

class AuthorDelete(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 AuthorCreate, AuthorDelete, AuthorUpdate

urlpatterns = [
    # ...
    path('author/add/', AuthorCreate.as_view(), name='author-add'),
    path('author/<int:pk>/', AuthorUpdate.as_view(), name='author-update'),
    path('author/<int:pk>/delete/', AuthorDelete.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.views.generic.edit import CreateView
from myapp.models import Author

class AuthorCreate(CreateView):
    model = Author
    fields = ['name']

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

Обратите внимание, что вам необходимо отформатировать этот вид с помощью login_required(), или, как альтернативу, обрабатывать неавторизованных пользователей в form_valid().

Пример AJAX

Вот простой пример, демонстрирующий, как можно реализовать форму, которая работает как с AJAX-запросами, так и с обычными POST-запросами формы:

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

class AjaxableResponseMixin:
    """
    Mixin to add AJAX 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.is_ajax():
            return JsonResponse(form.errors, status=400)
        else:
            return response

    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.is_ajax():
            data = {
                'pk': self.object.pk,
            }
            return JsonResponse(data)
        else:
            return response

class AuthorCreate(AjaxableResponseMixin, CreateView):
    model = Author
    fields = ['name']