フォームの処理には、一般に3つの場合分けが存在します。
\n最初の GET リクエスト (空白またはデフォルト値が埋め込まれたフォームを返す)
無効なデータの POST リクエスト (よくあるパターンは、エラー表示を追加したフォームを再表示する)
有効なデータの POST リクエスト (データを処理し、普通はリダイレクトを行う)
これらの処理を自分で実装しようとすると、多くの場合、多数の繰り返しの定型コードを書くことになってしまいます (ビューでフォームを使う を参照)。これを避けるために、Django はフォームを処理するための一般的なクラスビューを用意しています。
\n以下のようなコンタクトフォームがあったとします。
\nforms.pyfrom django import forms\n\n\nclass ContactForm(forms.Form):\n name = forms.CharField()\n message = forms.CharField(widget=forms.Textarea)\n\n def send_email(self):\n # send email using the self.cleaned_data dictionary\n pass\nこのとき、ビューは FormView を使うことで構築できます。
views.pyfrom myapp.forms import ContactForm\nfrom django.views.generic.edit import FormView\n\n\nclass ContactFormView(FormView):\n template_name = "contact.html"\n form_class = ContactForm\n success_url = "/thanks/"\n\n def form_valid(self, form):\n # This method is called when valid form data has been POSTed.\n # It should return an HttpResponse.\n form.send_email()\n return super().form_valid(form)\nメモ:
\nFormView は TemplateResponseMixin を継承するため、ここでは template_name を使うことができます。
form_valid() デフォルトの実装は、ただ単に success_url にリダイレクトするというものです。
ジェネリックビューが輝きを見せるのは、モデルとともに使用した時です。ジェネリックビューは ModelForm を自動的に生成するので、どのモデルクラスを使うのかを選択できます。
model 属性が与えられた場合には、そのモデルクラスが使用されます。
get_object() がオブジェクトを帰す場合には、そのオブジェクトのクラスが使用されます。
queryset が与えられた場合には、そのクエリセットに対するモデルが使用されます。
モデルフォームビューはモデルを自動的に保存する form_valid() 実装を提供します。 もし特別な要件があれば、これをオーバーライドできます。以下の例を参照してください。
CreateView や UpdateView には success_url を指定する必要はありません。モデルオブジェクトに get_absolute_url() があればそれを使用します。
カスタムの ModelForm を使いたい場合 (インスタンスでバリデーションを追加したい場合)、 form_class をビューに指定してください。
最初に、Author クラスに get_absolute_url() を追加する必要があります:
models.pyfrom django.db import models\nfrom django.urls import reverse\n\n\nclass Author(models.Model):\n name = models.CharField(max_length=200)\n\n def get_absolute_url(self):\n return reverse("author-detail", kwargs={"pk": self.pk})\nそうしたら、CreateView およびその仲間たちを使って実際に動作させることができます。ここでは一般的なクラスベースのビューのみを設定している点が重要です; 自分自身でロジックを書く必要はありません:
views.pyfrom django.urls import reverse_lazy\nfrom django.views.generic.edit import CreateView, DeleteView, UpdateView\nfrom myapp.models import Author\n\n\nclass AuthorCreateView(CreateView):\n model = Author\n fields = ["name"]\n\n\nclass AuthorUpdateView(UpdateView):\n model = Author\n fields = ["name"]\n\n\nclass AuthorDeleteView(DeleteView):\n model = Author\n success_url = reverse_lazy("author-list")\nfields 属性は ModelForm の内部 Meta クラスの fields 属性と同じように動作します。別の方法でフォームクラスを定義しない限り、この属性は必須であり、属性がない場合、ビューは ImproperlyConfigured 例外を発生させます。
fields 属性と form_class 属性の両方を指定した場合、 ImproperlyConfigured 例外が発生します。
最後に、これらの新しいビューをURLconfにフックします:
\nurls.pyfrom django.urls import path\nfrom myapp.views import AuthorCreateView, AuthorDeleteView, AuthorUpdateView\n\nurlpatterns = [\n # ...\n path("author/add/", AuthorCreateView.as_view(), name="author-add"),\n path("author/<int:pk>/", AuthorUpdateView.as_view(), name="author-update"),\n path("author/<int:pk>/delete/", AuthorDeleteView.as_view(), name="author-delete"),\n]\nrequest.userLink to this heading#CreateView を使ってオブジェクトを作成したユーザを追跡するには、カスタムの ModelForm を使います。まず、モデルに外部キー関係を追加します：
models.pyfrom django.contrib.auth.models import User\nfrom django.db import models\n\n\nclass Author(models.Model):\n name = models.CharField(max_length=200)\n created_by = models.ForeignKey(User, on_delete=models.CASCADE)\n\n # ...\nビューでは、編集するフィールドのリストに created_by が含まれていないことを確認し、 form_valid() をオーバーライドしてユーザーを追加します:
views.pyfrom django.contrib.auth.mixins import LoginRequiredMixin\nfrom django.views.generic.edit import CreateView\nfrom myapp.models import Author\n\n\nclass AuthorCreateView(LoginRequiredMixin, CreateView):\n model = Author\n fields = ["name"]\n\n def form_valid(self, form):\n form.instance.created_by = self.request.user\n return super().form_valid(form)\nLoginRequiredMixin はログインしていないユーザーがフォームにアクセスできないようにします。これを省略した場合、 form_valid() で未承認ユーザを処理する必要があります。
ここでは、API ベースのワークフローと「通常の」フォーム POST で動作するフォームの実装例を紹介します:
\nfrom django.http import JsonResponse\nfrom django.views.generic.edit import CreateView\nfrom myapp.models import Author\n\n\nclass JsonableResponseMixin:\n """\n Mixin to add JSON support to a form.\n Must be used with an object-based FormView (e.g. CreateView)\n """\n\n def form_invalid(self, form):\n response = super().form_invalid(form)\n if self.request.accepts("text/html"):\n return response\n else:\n return JsonResponse(form.errors, status=400)\n\n def form_valid(self, form):\n # We make sure to call the parent's form_valid() method because\n # it might do some processing (in the case of CreateView, it will\n # call form.save() for example).\n response = super().form_valid(form)\n if self.request.accepts("text/html"):\n return response\n else:\n data = {\n "pk": self.object.pk,\n }\n return JsonResponse(data)\n\n\nclass AuthorCreateView(JsonableResponseMixin, CreateView):\n model = Author\n fields = ["name"]\n上の例では、クライアントが text/html をサポートしている場合、それを優先するという前提になっています。しかし、これは常に正しいとは限りません。たとえば、.css ファイルをリクエストする際、多くのブラウザは Accept: text/css,*/*;q=0.1 というヘッダーを送信し、CSS を優先するが他の形式でも構わないという意図を示します。この場合でも request.accepts("text/html") は True を返します。
クライアントの優先度を考慮して正しいフォーマットを判断するには、 django.http.HttpRequest.get_preferred_type() を使用してください。
class JsonableResponseMixin:\n """\n Mixin to add JSON support to a form.\n Must be used with an object-based FormView (e.g. CreateView).\n """\n\n accepted_media_types = ["text/html", "application/json"]\n\n def dispatch(self, request, *args, **kwargs):\n if request.get_preferred_type(self.accepted_media_types) is None:\n # No format in common.\n return HttpResponse(\n status_code=406, headers={"Accept": ",".join(self.accepted_media_types)}\n )\n\n return super().dispatch(request, *args, **kwargs)\n\n def form_invalid(self, form):\n response = super().form_invalid(form)\n accepted_type = self.request.get_preferred_type(self.accepted_media_types)\n if accepted_type == "text/html":\n return response\n elif accepted_type == "application/json":\n return JsonResponse(form.errors, status=400)\n\n def form_valid(self, form):\n # We make sure to call the parent's form_valid() method because\n # it might do some processing (in the case of CreateView, it will\n # call form.save() for example).\n response = super().form_valid(form)\n accepted_type = self.request.get_preferred_type(self.accepted_media_types)\n if accepted_type == "text/html":\n return response\n elif accepted_type == "application/json":\n data = {\n "pk": self.object.pk,\n }\n return JsonResponse(data)\n