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

Основные формы ¶

Учитывая контактную форму:

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_urlfor 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']