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

Рассмотрим простую контактную форму:

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() просто осуществляет редирект на URL, хранящийся в атрибуте success_url.

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

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

• Если указано значение атрибута model, то будет использоваться этот класс модели.

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

• Если указан атрибут queryset, то будет использована модель этого запроса(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 и «сотоварищей» чтобы выполнить необходимую работу. Обратите внимание, что мы лишь создаем конфигурацию для CBV; нам не нужно писать никакого кода, реализующего логику:

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. Первое, добавьте внешний ключ (foreign key) к модели:

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)