Управление формами с помощью представлений на основе классов ¶
Обработка форм обычно использует три пути:
- Начальное отображение 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
в представлении.
Заметка
При наличии класса настраиваемой формы по-прежнему необходимо определить шаблон, даже если класс form_class
является классом ModelForm
.
Сначала нам нужно добавить метод 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')
Заметка
Нам нужно использовать reverse_lazy()
вместо, reverse()
потому что конфигурация URL еще не загружена во время импорта файла.
Атрибут fields
работает так же , как fields
внутренний класс атрибут Meta
из ModelForm
. За исключением случаев, когда класс формы определен каким-либо другим способом, этот атрибут является обязательным, и представление выдает исключение, ImproperlyConfigured
если оно отсутствует.
Если вы установили как fields
и атрибуты form_class
, исключение ImproperlyConfigured
генерируется.
Наконец, мы подключаем эти новые представления в конфигурацию URL:
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'),
]
Заметка
Эти представления наследуются от того, 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
настраиваемую форму . Сначала добавьте в модель отношение внешнего ключа:
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 AuthorCreate(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 AuthorCreate(JsonableResponseMixin, CreateView):
model = Author
fields = ['name']