フォームセットとは、同じページで複数のフォームを扱うための抽象化レイヤで、いわばデータグリッドのようなものです。フォームセットを説明するために、まず以下のようなフォームを考えましょう。
\n>>> from django import forms\n>>> class ArticleForm(forms.Form):\n... title = forms.CharField()\n... pub_date = forms.DateField()\nこのフォームを使って、ユーザが一度に複数の記事を作成できるようにしたいとします。ArticleForm からフォームセットを生成するには、次のようにします。
>>> from django.forms import formset_factory\n>>> ArticleFormSet = formset_factory(ArticleForm)\nYou now have created a formset class named ArticleFormSet.\nInstantiating the formset gives you the ability to iterate over the forms\nin the formset and display them as you would with a regular form:
>>> formset = ArticleFormSet()\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" id="id_form-0-pub_date"></td></tr>\nAs you can see it only displayed one empty form. The number of empty forms\nthat is displayed is controlled by the extra parameter. By default,\nformset_factory() defines one extra form; the\nfollowing example will create a formset class to display two blank forms:
>>> ArticleFormSet = formset_factory(ArticleForm, extra=2)\nIterating over a formset will render the forms in the order they were\ncreated. You can change this order by providing an alternate implementation for\nthe __iter__() method.
フォームセットでは、インデックスをつけて、一致するフォームを返すこともできます。__iter__ をオーバーライドした場合、動作を一貫させるため __getitem__ もオーバーライドする必要があります。
初期データは、フォームセットのユーザビリティに大きく影響します。上述したように、追加するフォーム数を指定できます。 これが意味するのは、初期データから生成するフォーム数に加えて、追加的なフォームをいくつ表示するかをフォームセットに指定している、ということです。以下の例を見てください:
\n>>> import datetime\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, extra=2)\n>>> formset = ArticleFormSet(initial=[\n... {'title': 'Django is now open source',\n... 'pub_date': datetime.date.today(),}\n... ])\n\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" value="Django is now open source" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" value="2008-05-12" id="id_form-0-pub_date"></td></tr>\n<tr><th><label for="id_form-1-title">Title:</label></th><td><input type="text" name="form-1-title" id="id_form-1-title"></td></tr>\n<tr><th><label for="id_form-1-pub_date">Pub date:</label></th><td><input type="text" name="form-1-pub_date" id="id_form-1-pub_date"></td></tr>\n<tr><th><label for="id_form-2-title">Title:</label></th><td><input type="text" name="form-2-title" id="id_form-2-title"></td></tr>\n<tr><th><label for="id_form-2-pub_date">Pub date:</label></th><td><input type="text" name="form-2-pub_date" id="id_form-2-pub_date"></td></tr>\n上の例では、今度は 3 つのフォームが表示されました。初期データとして渡された 1 つと、2 つの追加フォームです。初期データとして、辞書のリストを渡していることにも注意してください。
\nフォームセットを描画するために initial を使う場合、フォームセットの送信を処理するときに同じ initial を渡して、どのフォームがユーザによって変更されたかをフォームセットが検出できるようにしてください。例えば、ArticleFormSet(request.POST, initial=[...]) のようになるでしょう。
formset_factory() に max_num パラメータを指定すると、フォームセット中に表示されるフォームの最大数を制限できます。
>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, extra=2, max_num=1)\n>>> formset = ArticleFormSet()\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" id="id_form-0-pub_date"></td></tr>\nもし、max_num の値が初期データ内に存在するオブジェクトの合計より大きい場合、 extra を上限として空のフォームがフォームセットに追加されます。 フォームの合計の長さは max_num を超えることはできません。例えば、extra=2 と max_num=2、そしてフォームセットが 1 つの initial 項目で初期化される場合、この初期項目のフォームと 1 つの空のフォームが表示されます。
初期データ内の項目数が max_num を超える場合、max_num の値に関わらず全ての初期データのフォームが表示され、追加フォームは 1 つも表示されません。例えば、extra=3 と max_num=1、そしてフォームセットが 2 つの初期項目で初期化される場合、2 つのフォームが初期データとともに表示されます。
max_num の値が None (デフォルト) だった場合、表示されるフォームの上限は大きな数になります (1000)。この数は、実際には制限がないと見なせるでしょう。
デフォルトでは、max_num はいくつのフォームが表示されるかだけに影響し、バリデーションには影響しません。validate_max=True が formset_factory() に渡される場合は、max_num はバリデーションに影響します。validate_max をご覧ください。
The absolute_max parameter to formset_factory() allows limiting the\nnumber of forms that can be instantiated when supplying POST data. This\nprotects against memory exhaustion attacks using forged POST requests:
>>> from django.forms.formsets import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, absolute_max=1500)\n>>> data = {\n... 'form-TOTAL_FORMS': '1501',\n... 'form-INITIAL_FORMS': '0',\n... }\n>>> formset = ArticleFormSet(data)\n>>> len(formset.forms)\n1500\n>>> formset.is_valid()\nFalse\n>>> formset.non_form_errors()\n['Please submit at most 1000 forms.']\nWhen absolute_max is None, it defaults to max_num + 1000. (If\nmax_num is None, it defaults to 2000).
If absolute_max is less than max_num, a ValueError will be raised.
フォームセットのバリデーションは、普通の Form とほぼ同じです。フォームセットにも is_valid メソッドがあり、フォームセット内の全てのフォームを簡単に検証できます。
>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm)\n>>> data = {\n... 'form-TOTAL_FORMS': '1',\n... 'form-INITIAL_FORMS': '0',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nTrue\nこの例では、フォームセットにデータを渡さなかったので、有効なフォームを返しています。フォームセットは賢くて、データの変更されなかったフォームを無視してくれます。不適切な記事を提供しようとすると、以下のようになります。
\n>>> data = {\n... 'form-TOTAL_FORMS': '2',\n... 'form-INITIAL_FORMS': '0',\n... 'form-0-title': 'Test',\n... 'form-0-pub_date': '1904-06-16',\n... 'form-1-title': 'Test',\n... 'form-1-pub_date': '', # <-- this date is missing but required\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nFalse\n>>> formset.errors\n[{}, {'pub_date': ['This field is required.']}]\n見て分かるように、 formset.errors はリストで、 そのエントリーはフォームセット内のフォームと一致します。 バリデーションは、2 つのフォームそれぞれに働いて、2 つ目の項目にエラーメッセージが表示されています。
通常の Form を使うときとまったく同じように、フォームセットのフォーム内のそれぞれのフィールドは、ブラウザのバリデーションのための maxlength のような HTML 属性を含むことができます。ただし、フォームセットのフォームフィールドは、required 属性を含みません。これは、フォームを追加したり削除するときにバリデーションが正しく働かない可能性があるためです。
フォームセット内にいくつのエラーがあるかを確かめるためには、total_error_count メソッドが使えます。
>>> # Using the previous example\n>>> formset.errors\n[{}, {'pub_date': ['This field is required.']}]\n>>> len(formset.errors)\n2\n>>> formset.total_error_count()\n1\nまた、フォームに入力されたデータと初期データが異なっているかどうかもチェックできます (たとえば、フォームがデータなしで送信された場合など)。
\n>>> data = {\n... 'form-TOTAL_FORMS': '1',\n... 'form-INITIAL_FORMS': '0',\n... 'form-0-title': '',\n... 'form-0-pub_date': '',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.has_changed()\nFalse\nManagementForm を理解するLink to this heading#You may have noticed the additional data (form-TOTAL_FORMS,\nform-INITIAL_FORMS) that was required in the formset's data above. This\ndata is required for the ManagementForm. This form is used by the formset\nto manage the collection of forms contained in the formset. If you don't\nprovide this management data, the formset will be invalid:
>>> data = {\n... 'form-0-title': 'Test',\n... 'form-0-pub_date': '',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nFalse\nこれは、表示されているフォームインスタンスの数を追跡するために使用されます。 JavaScriptを使用して新しいフォームを追加する場合は、フォームのカウントフィールドもインクリメントする必要があります。 一方、既存のオブジェクトの削除を許可するためにJavaScriptを使用している場合は、POST データに form-#-DELETE を含めることで、削除対象のマークが適切に削除されていることを確認する必要があります。 すべてのフォームがそれにかかわらず POST データに存在することが期待されます。
ManagementFormは、フォームセット自体の属性として使用できます。 テンプレートでフォームセットをレンダリングするときは、{{ my_formset.management_form }} (my_formsetは適切な名前に置き換えます)をレンダリングすることで、すべての管理データを含めることができます。
total_form_count と initial_form_countLink to this heading#BaseFormSet には、ManagementForm、total_form_count、initial_form_count と密接に関わる 2 つのメソッドがあります。
total_form_count は、対象のフィールドセット内のフォームの合計数を返します。initial_form_count は、記入前のフォームセット内のフォームの数を返し、またいくつのフォームが必須なのかを決めるためにも使われます。通常、これらのメソッドをオーバーライドする必要はありませんが、もし必要な場合はメソッドの動作を理解してからオーバーライドしてください。
empty_formLink to this heading#BaseFormSet には追加の属性 empty_form があり、__prefix__ というプレフィックスとともにフォームのインスタンスを返します。これにより、JavaScript で動的にフォームを操作することが容易となります。
error_messagesLink to this heading#The error_messages argument lets you override the default messages that the\nformset will raise. Pass in a dictionary with keys matching the error messages\nyou want to override. For example, here is the default error message when the\nmanagement form is missing:
>>> formset = ArticleFormSet({})\n>>> formset.is_valid()\nFalse\n>>> formset.non_form_errors()\n['ManagementForm data is missing or has been tampered with. Missing fields: form-TOTAL_FORMS, form-INITIAL_FORMS. You may need to file a bug report if the issue persists.']\nAnd here is a custom error message:
\n>>> formset = ArticleFormSet({}, error_messages={'missing_management_form': 'Sorry, something went wrong.'})\n>>> formset.is_valid()\nFalse\n>>> formset.non_form_errors()\n['Sorry, something went wrong.']\nフォームセットには、Form クラスと同じような clean メソッドがあります。フォームセットのレベルで検証するためのバリデーションは、ここに記述します:
>>> from django.core.exceptions import ValidationError\n>>> from django.forms import BaseFormSet\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n\n>>> class BaseArticleFormSet(BaseFormSet):\n... def clean(self):\n... """Checks that no two articles have the same title."""\n... if any(self.errors):\n... # Don't bother validating the formset unless each form is valid on its own\n... return\n... titles = []\n... for form in self.forms:\n... if self.can_delete and self._should_delete_form(form):\n... continue\n... title = form.cleaned_data.get('title')\n... if title in titles:\n... raise ValidationError("Articles in a set must have distinct titles.")\n... titles.append(title)\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet)\n>>> data = {\n... 'form-TOTAL_FORMS': '2',\n... 'form-INITIAL_FORMS': '0',\n... 'form-0-title': 'Test',\n... 'form-0-pub_date': '1904-06-16',\n... 'form-1-title': 'Test',\n... 'form-1-pub_date': '1912-06-23',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nFalse\n>>> formset.errors\n[{}, {}]\n>>> formset.non_form_errors()\n['Articles in a set must have distinct titles.']\nフォームセットの clean メソッドは、Form.clean メソッドが呼ばれた後に呼び出されます。エラーを取得するには、フォームセットの non_form_errors() メソッドを使います。
Non-form errors will be rendered with an additional class of nonform to\nhelp distinguish them from form-specific errors. For example,\n{{ formset.non_form_errors }} would look like:
<ul class="errorlist nonform">\n <li>Articles in a set must have distinct titles.</li>\n</ul>\n送信されたフォームの最小および最大数を検証するために、Django にはいくつかの方法が用意されています。フォームの数のバリデーションをさらにカスタマイズする必要があるときは、カスタムのフォームセットバリデーションを使用する必要があります。
\nvalidate_maxLink to this heading#If validate_max=True is passed to\nformset_factory(), validation will also check\nthat the number of forms in the data set, minus those marked for\ndeletion, is less than or equal to max_num.
>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, max_num=1, validate_max=True)\n>>> data = {\n... 'form-TOTAL_FORMS': '2',\n... 'form-INITIAL_FORMS': '0',\n... 'form-0-title': 'Test',\n... 'form-0-pub_date': '1904-06-16',\n... 'form-1-title': 'Test 2',\n... 'form-1-pub_date': '1912-06-23',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nFalse\n>>> formset.errors\n[{}, {}]\n>>> formset.non_form_errors()\n['Please submit at most 1 form.']\nvalidate_max=True validates against max_num strictly even if\nmax_num was exceeded because the amount of initial data supplied was\nexcessive.
validate_minLink to this heading#If validate_min=True is passed to\nformset_factory(), validation will also check\nthat the number of forms in the data set, minus those marked for\ndeletion, is greater than or equal to min_num.
>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, min_num=3, validate_min=True)\n>>> data = {\n... 'form-TOTAL_FORMS': '2',\n... 'form-INITIAL_FORMS': '0',\n... 'form-0-title': 'Test',\n... 'form-0-pub_date': '1904-06-16',\n... 'form-1-title': 'Test 2',\n... 'form-1-pub_date': '1912-06-23',\n... }\n>>> formset = ArticleFormSet(data)\n>>> formset.is_valid()\nFalse\n>>> formset.errors\n[{}, {}]\n>>> formset.non_form_errors()\n['Please submit at least 3 forms.']\nformset_factory() には、フォームセット内のフォームの順序およびフォームセットからのフォームの削除に役立つ 2 つのオプション引数があります。
can_orderLink to this heading#デフォルト値: False
並び替えができるフォームセットを作成できるようにします:
\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, can_order=True)\n>>> formset = ArticleFormSet(initial=[\n... {'title': 'Article #1', 'pub_date': datetime.date(2008, 5, 10)},\n... {'title': 'Article #2', 'pub_date': datetime.date(2008, 5, 11)},\n... ])\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" value="Article #1" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" value="2008-05-10" id="id_form-0-pub_date"></td></tr>\n<tr><th><label for="id_form-0-ORDER">Order:</label></th><td><input type="number" name="form-0-ORDER" value="1" id="id_form-0-ORDER"></td></tr>\n<tr><th><label for="id_form-1-title">Title:</label></th><td><input type="text" name="form-1-title" value="Article #2" id="id_form-1-title"></td></tr>\n<tr><th><label for="id_form-1-pub_date">Pub date:</label></th><td><input type="text" name="form-1-pub_date" value="2008-05-11" id="id_form-1-pub_date"></td></tr>\n<tr><th><label for="id_form-1-ORDER">Order:</label></th><td><input type="number" name="form-1-ORDER" value="2" id="id_form-1-ORDER"></td></tr>\n<tr><th><label for="id_form-2-title">Title:</label></th><td><input type="text" name="form-2-title" id="id_form-2-title"></td></tr>\n<tr><th><label for="id_form-2-pub_date">Pub date:</label></th><td><input type="text" name="form-2-pub_date" id="id_form-2-pub_date"></td></tr>\n<tr><th><label for="id_form-2-ORDER">Order:</label></th><td><input type="number" name="form-2-ORDER" id="id_form-2-ORDER"></td></tr>\n各フィールドに追加フィールドが与えられます。この新しいフィールドは ORDER という名前の forms.IntegerField です。初期データから来たフォームに対しては、自動的に数値が与えられます。ユーザーがこれらの値を変更した際に何が起きるかを見てみましょう:
>>> data = {\n... 'form-TOTAL_FORMS': '3',\n... 'form-INITIAL_FORMS': '2',\n... 'form-0-title': 'Article #1',\n... 'form-0-pub_date': '2008-05-10',\n... 'form-0-ORDER': '2',\n... 'form-1-title': 'Article #2',\n... 'form-1-pub_date': '2008-05-11',\n... 'form-1-ORDER': '1',\n... 'form-2-title': 'Article #3',\n... 'form-2-pub_date': '2008-05-01',\n... 'form-2-ORDER': '0',\n... }\n\n>>> formset = ArticleFormSet(data, initial=[\n... {'title': 'Article #1', 'pub_date': datetime.date(2008, 5, 10)},\n... {'title': 'Article #2', 'pub_date': datetime.date(2008, 5, 11)},\n... ])\n>>> formset.is_valid()\nTrue\n>>> for form in formset.ordered_forms:\n... print(form.cleaned_data)\n{'pub_date': datetime.date(2008, 5, 1), 'ORDER': 0, 'title': 'Article #3'}\n{'pub_date': datetime.date(2008, 5, 11), 'ORDER': 1, 'title': 'Article #2'}\n{'pub_date': datetime.date(2008, 5, 10), 'ORDER': 2, 'title': 'Article #1'}\nBaseFormSet also provides an\nordering_widget attribute and\nget_ordering_widget() method that\ncontrol the widget used with\ncan_order.
ordering_widgetLink to this heading#Default: NumberInput
Set ordering_widget to specify the widget class to be used with\ncan_order:
>>> from django.forms import BaseFormSet, formset_factory\n>>> from myapp.forms import ArticleForm\n>>> class BaseArticleFormSet(BaseFormSet):\n... ordering_widget = HiddenInput\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet, can_order=True)\nget_ordering_widgetLink to this heading#Override get_ordering_widget() if you need to provide a widget instance for\nuse with can_order:
>>> from django.forms import BaseFormSet, formset_factory\n>>> from myapp.forms import ArticleForm\n>>> class BaseArticleFormSet(BaseFormSet):\n... def get_ordering_widget(self):\n... return HiddenInput(attrs={'class': 'ordering'})\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet, can_order=True)\ncan_deleteLink to this heading#デフォルト値: False
削除対象のフォームを選択できるフォームセットを作成できるようにします:
\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> ArticleFormSet = formset_factory(ArticleForm, can_delete=True)\n>>> formset = ArticleFormSet(initial=[\n... {'title': 'Article #1', 'pub_date': datetime.date(2008, 5, 10)},\n... {'title': 'Article #2', 'pub_date': datetime.date(2008, 5, 11)},\n... ])\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" value="Article #1" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" value="2008-05-10" id="id_form-0-pub_date"></td></tr>\n<tr><th><label for="id_form-0-DELETE">Delete:</label></th><td><input type="checkbox" name="form-0-DELETE" id="id_form-0-DELETE"></td></tr>\n<tr><th><label for="id_form-1-title">Title:</label></th><td><input type="text" name="form-1-title" value="Article #2" id="id_form-1-title"></td></tr>\n<tr><th><label for="id_form-1-pub_date">Pub date:</label></th><td><input type="text" name="form-1-pub_date" value="2008-05-11" id="id_form-1-pub_date"></td></tr>\n<tr><th><label for="id_form-1-DELETE">Delete:</label></th><td><input type="checkbox" name="form-1-DELETE" id="id_form-1-DELETE"></td></tr>\n<tr><th><label for="id_form-2-title">Title:</label></th><td><input type="text" name="form-2-title" id="id_form-2-title"></td></tr>\n<tr><th><label for="id_form-2-pub_date">Pub date:</label></th><td><input type="text" name="form-2-pub_date" id="id_form-2-pub_date"></td></tr>\n<tr><th><label for="id_form-2-DELETE">Delete:</label></th><td><input type="checkbox" name="form-2-DELETE" id="id_form-2-DELETE"></td></tr>\nSimilar to can_order this adds a new field to each form named DELETE\nand is a forms.BooleanField. When data comes through marking any of the\ndelete fields you can access them with deleted_forms:
>>> data = {\n... 'form-TOTAL_FORMS': '3',\n... 'form-INITIAL_FORMS': '2',\n... 'form-0-title': 'Article #1',\n... 'form-0-pub_date': '2008-05-10',\n... 'form-0-DELETE': 'on',\n... 'form-1-title': 'Article #2',\n... 'form-1-pub_date': '2008-05-11',\n... 'form-1-DELETE': '',\n... 'form-2-title': '',\n... 'form-2-pub_date': '',\n... 'form-2-DELETE': '',\n... }\n\n>>> formset = ArticleFormSet(data, initial=[\n... {'title': 'Article #1', 'pub_date': datetime.date(2008, 5, 10)},\n... {'title': 'Article #2', 'pub_date': datetime.date(2008, 5, 11)},\n... ])\n>>> [form.cleaned_data for form in formset.deleted_forms]\n[{'DELETE': True, 'pub_date': datetime.date(2008, 5, 10), 'title': 'Article #1'}]\nIf you are using a ModelFormSet,\nmodel instances for deleted forms will be deleted when you call\nformset.save().
If you call formset.save(commit=False), objects will not be deleted\nautomatically. You'll need to call delete() on each of the\nformset.deleted_objects to actually delete\nthem:
>>> instances = formset.save(commit=False)\n>>> for obj in formset.deleted_objects:\n... obj.delete()\nOn the other hand, if you are using a plain FormSet, it's up to you to\nhandle formset.deleted_forms, perhaps in your formset's save() method,\nas there's no general notion of what it means to delete a form.
BaseFormSet also provides a\ndeletion_widget attribute and\nget_deletion_widget() method that\ncontrol the widget used with\ncan_delete.
deletion_widgetLink to this heading#Default: CheckboxInput
Set deletion_widget to specify the widget class to be used with\ncan_delete:
>>> from django.forms import BaseFormSet, formset_factory\n>>> from myapp.forms import ArticleForm\n>>> class BaseArticleFormSet(BaseFormSet):\n... deletion_widget = HiddenInput\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet, can_delete=True)\nget_deletion_widgetLink to this heading#Override get_deletion_widget() if you need to provide a widget instance for\nuse with can_delete:
>>> from django.forms import BaseFormSet, formset_factory\n>>> from myapp.forms import ArticleForm\n>>> class BaseArticleFormSet(BaseFormSet):\n... def get_deletion_widget(self):\n... return HiddenInput(attrs={'class': 'deletion'})\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet, can_delete=True)\ncan_delete_extraLink to this heading#デフォルト値: True
While setting can_delete=True, specifying can_delete_extra=False will\nremove the option to delete extra forms.
If you need to add additional fields to the formset this can be easily\naccomplished. The formset base class provides an add_fields method. You\ncan override this method to add your own fields or even redefine the default\nfields/attributes of the order and deletion fields:
>>> from django.forms import BaseFormSet\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n>>> class BaseArticleFormSet(BaseFormSet):\n... def add_fields(self, form, index):\n... super().add_fields(form, index)\n... form.fields["my_field"] = forms.CharField()\n\n>>> ArticleFormSet = formset_factory(ArticleForm, formset=BaseArticleFormSet)\n>>> formset = ArticleFormSet()\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-title">Title:</label></th><td><input type="text" name="form-0-title" id="id_form-0-title"></td></tr>\n<tr><th><label for="id_form-0-pub_date">Pub date:</label></th><td><input type="text" name="form-0-pub_date" id="id_form-0-pub_date"></td></tr>\n<tr><th><label for="id_form-0-my_field">My field:</label></th><td><input type="text" name="form-0-my_field" id="id_form-0-my_field"></td></tr>\nSometimes your form class takes custom parameters, like MyArticleForm.\nYou can pass this parameter when instantiating the formset:
>>> from django.forms import BaseFormSet\n>>> from django.forms import formset_factory\n>>> from myapp.forms import ArticleForm\n\n>>> class MyArticleForm(ArticleForm):\n... def __init__(self, *args, user, **kwargs):\n... self.user = user\n... super().__init__(*args, **kwargs)\n\n>>> ArticleFormSet = formset_factory(MyArticleForm)\n>>> formset = ArticleFormSet(form_kwargs={'user': request.user})\nThe form_kwargs may also depend on the specific form instance. The formset\nbase class provides a get_form_kwargs method. The method takes a single\nargument - the index of the form in the formset. The index is None for the\nempty_form:
>>> from django.forms import BaseFormSet\n>>> from django.forms import formset_factory\n\n>>> class BaseArticleFormSet(BaseFormSet):\n... def get_form_kwargs(self, index):\n... kwargs = super().get_form_kwargs(index)\n... kwargs['custom_kwarg'] = index\n... return kwargs\nIn the rendered HTML, formsets include a prefix on each field's name. By\ndefault, the prefix is 'form', but it can be customized using the formset's\nprefix argument.
For example, in the default case, you might see:
\n<label for="id_form-0-title">Title:</label>\n<input type="text" name="form-0-title" id="id_form-0-title">\nBut with ArticleFormset(prefix='article') that becomes:
<label for="id_article-0-title">Title:</label>\n<input type="text" name="article-0-title" id="id_article-0-title">\nThis is useful if you want to use more than one formset in a view.
\nFormsets have five attributes and five methods associated with rendering.
\nSpecifies the renderer to use for the\nformset. Defaults to the renderer specified by the FORM_RENDERER\nsetting.
The name of the template used when calling __str__ or render().\nThis template renders the formset's management form and then each form in\nthe formset as per the template defined by the form's\ntemplate_name. This is a proxy of as_table\nby default.
The name of the template used when calling as_p(). By default this\nis 'django/forms/formsets/p.html'. This template renders the formset's\nmanagement form and then each form in the formset as per the form's\nas_p() method.
The name of the template used when calling as_table(). By default\nthis is 'django/forms/formsets/table.html'. This template renders the\nformset's management form and then each form in the formset as per the\nform's as_table() method.
The name of the template used when calling as_ul(). By default this\nis 'django/forms/formsets/ul.html'. This template renders the formset's\nmanagement form and then each form in the formset as per the form's\nas_ul() method.
Returns the context for rendering a formset in a template.
\nThe available context is:
\nformset : The instance of the formset.
The render method is called by __str__ as well as the as_p(),\nas_ul(), and as_table() methods. All arguments are optional\nand will default to:
template_name: template_name
context: Value returned by get_context()
renderer: Value returned by renderer
Renders the formset with the template_name_p template.
Renders the formset with the template_name_table template.
Renders the formset with the template_name_ul template.
Using a formset inside a view is not very different from using a regular\nForm class. The only thing you will want to be aware of is making sure to\nuse the management form inside the template. Let's look at a sample view:
from django.forms import formset_factory\nfrom django.shortcuts import render\nfrom myapp.forms import ArticleForm\n\ndef manage_articles(request):\n ArticleFormSet = formset_factory(ArticleForm)\n if request.method == 'POST':\n formset = ArticleFormSet(request.POST, request.FILES)\n if formset.is_valid():\n # do something with the formset.cleaned_data\n pass\n else:\n formset = ArticleFormSet()\n return render(request, 'manage_articles.html', {'formset': formset})\nThe manage_articles.html template might look like this:
<form method="post">\n {{ formset.management_form }}\n <table>\n {% for form in formset %}\n {{ form }}\n {% endfor %}\n </table>\n</form>\nHowever there's a slight shortcut for the above by letting the formset itself\ndeal with the management form:
\n<form method="post">\n <table>\n {{ formset }}\n </table>\n</form>\nThe above ends up calling the BaseFormSet.render() method on the formset\nclass. This renders the formset using the template specified by the\ntemplate_name attribute. Similar to forms, by default the\nformset will be rendered as_table, with other helper methods of as_p\nand as_ul being available. The rendering of the formset can be customized\nby specifying the template_name attribute, or more generally by\noverriding the default template.
can_delete and can_orderLink to this heading#If you manually render fields in the template, you can render\ncan_delete parameter with {{ form.DELETE }}:
<form method="post">\n {{ formset.management_form }}\n {% for form in formset %}\n <ul>\n <li>{{ form.title }}</li>\n <li>{{ form.pub_date }}</li>\n {% if formset.can_delete %}\n <li>{{ form.DELETE }}</li>\n {% endif %}\n </ul>\n {% endfor %}\n</form>\nSimilarly, if the formset has the ability to order (can_order=True), it is\npossible to render it with {{ form.ORDER }}.
You are able to use more than one formset in a view if you like. Formsets\nborrow much of its behavior from forms. With that said you are able to use\nprefix to prefix formset form field names with a given value to allow\nmore than one formset to be sent to a view without name clashing. Let's take\na look at how this might be accomplished:
from django.forms import formset_factory\nfrom django.shortcuts import render\nfrom myapp.forms import ArticleForm, BookForm\n\ndef manage_articles(request):\n ArticleFormSet = formset_factory(ArticleForm)\n BookFormSet = formset_factory(BookForm)\n if request.method == 'POST':\n article_formset = ArticleFormSet(request.POST, request.FILES, prefix='articles')\n book_formset = BookFormSet(request.POST, request.FILES, prefix='books')\n if article_formset.is_valid() and book_formset.is_valid():\n # do something with the cleaned_data on the formsets.\n pass\n else:\n article_formset = ArticleFormSet(prefix='articles')\n book_formset = BookFormSet(prefix='books')\n return render(request, 'manage_articles.html', {\n 'article_formset': article_formset,\n 'book_formset': book_formset,\n })\nYou would then render the formsets as normal. It is important to point out\nthat you need to pass prefix on both the POST and non-POST cases so that\nit is rendered and processed correctly.
Each formset's prefix replaces the default form\nprefix that's added to each field's name and id HTML attributes.