Встроенные виды редактирования


Обработка формы обычно имеет 3 пути:

Первоначальный GET (пустой или заполненный бланк)
POST с недопустимыми данными (обычно повторное отображение формы с ошибками)
POST с действительными данными (обработка данных и типичное перенаправление)
Реализация этого самостоятельно часто приводит к большому количеству повторяющегося кода (см. Using a form in a view). Чтобы помочь избежать этого, Django предоставляет коллекцию общих представлений на основе классов для обработки форм.

Основные формы
Дана контактная форма:

forms.py
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:

views.py
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 на вашем представлении.

Примечание

При указании пользовательского класса формы вы должны указать модель, даже если form_class может быть ModelForm.

Сначала нам нужно добавить get_absolute_url() к нашему классу Author:

models.py
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 и друзей для выполнения фактической работы. Обратите внимание, что здесь мы просто настраиваем общие представления на основе классов; нам не нужно писать никакой логики самостоятельно:

views.py
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')
Примечание

Мы должны использовать reverse_lazy() вместо reverse(), так как урлы не загружаются при импорте файла.

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

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

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

urls.py
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'),
]
Примечание

Эти представления наследуют SingleObjectTemplateResponseMixin, которое использует template_name_suffix для построения template_name на основе модели.

В данном примере:

CreateView и UpdateView используют myapp/author_form.html
DeleteView использует myapp/author_confirm_delete.html
Если вы хотите иметь отдельные шаблоны для CreateView и UpdateView, вы можете установить template_name или template_name_suffix в вашем классе представления.

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

models.py
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() для добавления пользователя:

views.py
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']