ModelFormLink to this heading#データベース中心のアプリケーションを作成している場合、Django モデルに密接にマップするフォームを使うことになるでしょう。例えば、BlogComment モデルを持っていて、閲覧者がコメントを送信できるフォームを作成したくなったとしましょう。この場合、すでにモデル内にフィールドが定義されているので、フォーム内にフィールドタイプを改めて定義するのは冗長でしょう。
このためDjango には、Django モデルから Form クラスを生成できるようなヘルパークラスを用意してあります。
例:
\n>>> from django.forms import ModelForm\n>>> from myapp.models import Article\n\n# Create the form class.\n>>> class ArticleForm(ModelForm):\n... class Meta:\n... model = Article\n... fields = ['pub_date', 'headline', 'content', 'reporter']\n\n# Creating a form to add an article.\n>>> form = ArticleForm()\n\n# Creating a form to change an existing article.\n>>> article = Article.objects.get(pk=1)\n>>> form = ArticleForm(instance=article)\n生成された Form クラスは、指定された全てのモデルフィールドに対して、fields 属性で指定された順番でフォームフィールドを有します。
各モデルフィールドは、対応するデフォルトのフォームフィールドを持ちます。例えば、モデル上の CharField はフォーム上で CharField として表現されます。モデル ManyToManyField は MultipleChoiceField として表現されます。 以下は、各フィールドの対応表です:
モデルフィールド | \nフォームフィールド | \n
|---|---|
| \n | フォーム上では表示されません。 | \n
| \n | フォーム上では表示されません。 | \n
| \n |
| \n
| \n |
| \n
| \n |
| \n
| \n |
| \n
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n |
| \n
| \n | \n |
| \n | \n |
| \n
| \n
| \n | \n |
| \n |
| \n
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n | \n |
| \n |
| \n
| \n | \n |
| \n | \n |
| \n | \n |
お気付きかもしれませんが、 ForeignKey と ManyToManyField の 2 つのモデルフィールドは特殊なケースとなります:
ForeignKey は django.forms.ModelChoiceField によって表現され、モデルの QuerySet を選択肢として持つ ChoiceField です。
ManyToManyField は django.forms.ModelMultipleChoiceField によって表現され、モデルの QuerySet を選択肢として持つ MultipleChoiceField です。
加えて、生成されたフォームフィールドはそれぞれ以下の通り属性がセットされます:
\nモデルフィールドに blank=True が設定されている場合、フォームフィールド上で required が False にセットされます。それ以外の場合は required=True となります。
フォームフィールドの label はモデルフィールドの verbose_name の最初の文字を大文字にしたものがセットされます。
フォームフィールドの help_text はモデルフィールドの help_text がセットされます。
モデルフィールドに choices が設定されている場合、フォームフィールドの widget は Select にセットされ、選択肢にはモデルフィールドの choices が使われます。通常、選択肢には空欄の選択肢が追加され、デフォルトで選択されることになります。フィールドが required の場合、ユーザは選択肢を選ぶ必要があります。モデルフィールドに blank=False および明示的な default 値が設定されている場合、空欄の選択肢は表示されません (代わりに default 値が選択された状態で表示されます) 。
与えられたモデルフィールドに対して使われるフォームフィールドをオーバーライドすることもできます。後述の Overriding the default fields を参照してください。
\n以下のような一連のモデルを考えていきましょう:
\nfrom django.db import models\nfrom django.forms import ModelForm\n\nTITLE_CHOICES = [\n ('MR', 'Mr.'),\n ('MRS', 'Mrs.'),\n ('MS', 'Ms.'),\n]\n\nclass Author(models.Model):\n name = models.CharField(max_length=100)\n title = models.CharField(max_length=3, choices=TITLE_CHOICES)\n birth_date = models.DateField(blank=True, null=True)\n\n def __str__(self):\n return self.name\n\nclass Book(models.Model):\n name = models.CharField(max_length=100)\n authors = models.ManyToManyField(Author)\n\nclass AuthorForm(ModelForm):\n class Meta:\n model = Author\n fields = ['name', 'title', 'birth_date']\n\nclass BookForm(ModelForm):\n class Meta:\n model = Book\n fields = ['name', 'authors']\nこれらのモデルでは、上記の ModelForm サブクラスはおおむね以下と同等と言えます (唯一の違いは save() メソッドで、これからすぐ説明します):
from django import forms\n\nclass AuthorForm(forms.Form):\n name = forms.CharField(max_length=100)\n title = forms.CharField(\n max_length=3,\n widget=forms.Select(choices=TITLE_CHOICES),\n )\n birth_date = forms.DateField(required=False)\n\nclass BookForm(forms.Form):\n name = forms.CharField(max_length=100)\n authors = forms.ModelMultipleChoiceField(queryset=Author.objects.all())\nModelForm の検証 (バリデーション)Link to this heading#ModelForm のバリデーションには、以下の 2 つのステップが存在します:
通常のフォームのバリデーションと同じように、モデルフォームのバリデーションは is_valid() が呼ばれたときや errors 属性にアクセスしたとき、暗黙的に実行されます。また、実際にはあまり使うメソッドではありませんが、明示的に full_clean() を呼んだときにもバリデーションが実行されます。
Model バリデーション (Model.full_clean()) は、フォームバリデーションのステップ内でフォームの clean() メソッドが呼ばれたすぐ直後に実行されます。
通常のフォームと同じ方法でモデルフォーム上の clean() メソッドをオーバーライドして、バリデーションの動作を追加することができます。
モデルのオブジェクトに付属したモデルフォームのインスタンスは、instance 属性を持ち、メソッドが特定のモデルのインスタンスにアクセスできるようにします。
バリデーションプロセスの一部として、ModelForm フォーム上で対応するフィールドを持つモデルのそれぞれのフィールドの clean() メソッドを呼び出します。モデルフィールドを除外した場合、これらのフィールドに対してはバリデーションが実行されません。フィールドのクリーニングとバリデーションの詳しい働き方については、フォームバリデーション ドキュメントを参照してください。
モデルの clean() メソッドは一意性のチェックがされる前に呼び出されます。モデルの clean() フックのより詳しい情報については、オブジェクトのバリデーションを行う を参照してください。
error_messages のレンダリングを考えるLink to this heading#フォームフィールド や フォーム Meta のレベルで定義されたエラーメッセージは、常に モデルフィールド のレベルで定義されたエラーメッセージより優先されます。
モデルフィールド で定義されたエラーメッセージは、モデルバリデーション のステップの間に ValidationError が発生したときに、対応するエラーメッセージがフォームのレベルで定義されていない場合にのみ使用されます。
NON_FIELD_ERRORS キーを Meta クラス内の error_messages ディクショナリに追加することで、モデルバリデーションによって発生する NON_FIELD_ERRORS に対するエラーメッセージをオーバーライドできます。
from django.core.exceptions import NON_FIELD_ERRORS\nfrom django.forms import ModelForm\n\nclass ArticleForm(ModelForm):\n class Meta:\n error_messages = {\n NON_FIELD_ERRORS: {\n 'unique_together': "%(model_name)s's %(field_labels)s are not unique.",\n }\n }\nsave() メソッドLink to this heading#全ての ModelForm は save() メソッドも持っています。このメソッドは、フォームに結びつけられたデータからデータベースオブジェクトを生成して保存します。ModelForm のサブクラスはキーワード引数 instance として既存のモデルインスタンスを受け取ることができます; これが指定されると、save() はそのインスタンスを更新するようになります。 指定されない場合は、save() は指定されたモデルの新しいインスタンスを生成します:
>>> from myapp.models import Article\n>>> from myapp.forms import ArticleForm\n\n# Create a form instance from POST data.\n>>> f = ArticleForm(request.POST)\n\n# Save a new Article object from the form's data.\n>>> new_article = f.save()\n\n# Create a form to edit an existing Article, but use\n# POST data to populate the form.\n>>> a = Article.objects.get(pk=1)\n>>> f = ArticleForm(request.POST, instance=a)\n>>> f.save()\nフォームが バリデーションされていない 場合、save() を呼び出すと、form.errors をチェックすることでこれを行います。フォーム内のデータが適正ではない場合は ValueError が発生します -- 例えば、form.errors が True だと評価された場合です。
オプションのフィールドがフォームのデータに表示されない場合、結果のモデルインスタンスはモデルフィールドの default を使用します。この動作は、 CheckboxInput, CheckboxSelectMultiple, または SelectMultiple (または value_omitted_from_data() メソッドが常に False を返すカスタムウィジェット) を使用するフィールドには適用されません。チェックされていないチェックボックスと、選択されていない <select multiple> は HTML フォーム送信のデータには表示されないからです。 API を設計していて、これらのウィジェットを使用するフィールドのデフォルトのフォールバック動作が必要な場合は、カスタムフォームフィールドまたはウィジェットを使用します。
この save() には、省略可能な commit キーワード引数があり、True ないし False を取ります。save() を commit=False で呼び出した場合、データベースにまだ保存されていないオブジェクトを返します。この場合、結果のモデルインスタンスで save() を呼び出すかどうかはあなた次第です。これは、保存前にオブジェクトで独自のプロセスを実行したい場合、もしくは特別な モデル保存オプション を使いたい場合に有用です。 commit はデフォルトでは True です。
commit=False を使う際のもう 1 つの副作用は、モデルに他のモデルとの多対多の関係がある場合に見られます。フォームを save するときにモデルに多対多の関係があり commit=False を指定した場合、Django は多対多の関係に対してフォームのデータを即座に保存することができません。これは、インスタンスがデータベース上に存在するようになるまで、インスタンスに対して多対多のデータを保存することが不可能だからです。
この問題を扱うために、commit=False を使ったフォームを save するたびに、Django は save_m2m() メソッドをあなたの ModelForm サブクラスに追加します。フォームによって生成されたインスタンスを手動で save した後に、多対多のフォームデータを保存するために save_m2m() を実行することができます。例えば:
# Create a form instance with POST data.\n>>> f = AuthorForm(request.POST)\n\n# Create, but don't save the new author instance.\n>>> new_author = f.save(commit=False)\n\n# Modify the author in some way.\n>>> new_author.some_field = 'some_value'\n\n# Save the new instance.\n>>> new_author.save()\n\n# Now, save the many-to-many data for the form.\n>>> f.save_m2m()\nsave_m2m() の呼び出しは、save(commit=False) を使った場合にのみ必要となります。フォーム上で単に save() を使用したときは、全てのデータ -- 多対多のデータを含む -- が追加的なメソッドを呼び出す必要なく保存されます。例えば:
# Create a form instance with POST data.\n>>> a = Author()\n>>> f = AuthorForm(request.POST, instance=a)\n\n# Create and save the new author instance. There's no need to do anything else.\n>>> new_author = f.save()\nsave() と save_m2m() メソッドのほかは、ModelForm は forms のフォームとまったく同じ方法で動作します。例えば、is_valid() メソッドは妥当性をチェックするために使用される、is_multipart() メソッドはフォームがマルチパートのファイルアップロードを必要とするかどうかを (ゆえに request.FILES がフォームに渡される必要があるかどうかも) 決める、などです。詳しくは Binding uploaded files to a form を参照してください。
fields 属性を使って、フォームで編集すべき全てのフィールドを明示的に指定することを強くお勧めします。そうしないと、フォームで予期せず特定のフィールドを設定できるようになり、セキュリティ上の問題が発生しやすくなります。特に新しいフィールドがモデルに追加されたときに起こりがちです。フォームのレンダリング方法によっては、Webページで問題が目に見えないことさえあります。
代わりの方法は、全てのフィールドを自動的に含めるか、いくつかのフィールドのみをブラックリスト化することです。この基本的なアプローチは安全性が低く、主要なウェブサイトで深刻な悪用 (例えば GitHub) を招いていることが知られています。
\nしかしながら、これらのセキュリティ問題が当てはまらないことが明白な場合のために、2 つのショートカットが利用可能です:
\nfields 属性に、特殊な値 '__all__' をセットして、モデル内の全てのフィールドが使われるように指定します。例えば:
from django.forms import ModelForm\n\nclass AuthorForm(ModelForm):\n class Meta:\n model = Author\n fields = '__all__'\nModelForm の中の Meta クラスの exclude 属性に、フォームから除外されるフィールドのリストをセットします。
例:
\nclass PartialAuthorForm(ModelForm):\n class Meta:\n model = Author\n exclude = ['title']\nAuthor モデルは 3 つのフィールド name、title、birth_date を持っているため、これで name と birth_date がフォームに表示されることになります。
このどちらかが使われた場合、フォーム内で表示されるフィールドの順番はモデル内でフィールドが定義された順番となり、ManyToManyField インスタンスは最後に表示されます。
加えて、Django は以下のルールも適用します: モデルフィールドで editable=False をセットした場合、ModelForm を通じて生成された 全ての フォームはそのフィールドを含みません。
前述の Field types テーブルで説明したとおり、デフォルトのフィールドタイプは実用的なデフォルトです。モデルに DateField がある場合、フォーム内で DateField として表示したいことでしょう。しかし、ModelForm では、与えられたモデルに足してフォームフィールドを変更する柔軟性があります。
フィールドに対して独自のウィジェットを指定するには、内部の Meta クラスの widgets を使用してください。これは、フィールド名としジェットのクラスやインスタンスをマッピングするディクショナリです。
例えば、Authoer の name 属性に対する CharField を、デフォルトの <input type="text"> の代わりに <textarea> で表示したい場合、フィールドのウィジェットをオーバーライドすることができます:
from django.forms import ModelForm, Textarea\nfrom myapp.models import Author\n\nclass AuthorForm(ModelForm):\n class Meta:\n model = Author\n fields = ('name', 'title', 'birth_date')\n widgets = {\n 'name': Textarea(attrs={'cols': 80, 'rows': 20}),\n }\nThe widgets dictionary accepts either widget instances (e.g.,\nTextarea(...)) or classes (e.g., Textarea). Note that the widgets\ndictionary is ignored for a model field with a non-empty choices attribute.\nIn this case, you must override the form field to use a different widget.
同様に、フィールドをさらにカスタマイズしたい場合、内部の Meta クラスの labels、help_texts、error_messages と言った属性を指定することができます。
例えば、name フィールドに対する文字列に直面する全てのユーザの文章をカスタマイズしたい場合:
from django.utils.translation import gettext_lazy as _\n\nclass AuthorForm(ModelForm):\n class Meta:\n model = Author\n fields = ('name', 'title', 'birth_date')\n labels = {\n 'name': _('Writer'),\n }\n help_texts = {\n 'name': _('Some useful help text.'),\n }\n error_messages = {\n 'name': {\n 'max_length': _("This writer's name is too long."),\n },\n }\nfield_classes を指定して、フォームによってインスタンス化されたフィールドのタイプをカスタマイズすることもできます。
例えば、slug フィールドに対して MySlugFormField を使いたい場合、以下のようにできます:
from django.forms import ModelForm\nfrom myapp.models import Article\n\nclass ArticleForm(ModelForm):\n class Meta:\n model = Article\n fields = ['pub_date', 'headline', 'content', 'reporter', 'slug']\n field_classes = {\n 'slug': MySlugFormField,\n }\n最後に、フィールドを完全に -- タイプ、バリデータ、必須かどうかなどを含めて -- コントロールしたい場合、通常の Form で行うのと同じようにフィールドを宣言的に指定することで実現できます。
フィールドのバリデータを指定したい場合、フィールドを宣言的に定義して validators パラメータを設定することで実現できます:
from django.forms import CharField, ModelForm\nfrom myapp.models import Article\n\nclass ArticleForm(ModelForm):\n slug = CharField(validators=[validate_slug])\n\n class Meta:\n model = Article\n fields = ['pub_date', 'headline', 'content', 'reporter', 'slug']\nデフォルトでは、ModelForm 内のフィールドはデータをローカル化しません。フィールドに対してローカル化を有効にするために、Meat クラスの localized_fields 属性を使うことができます。
>>> from django.forms import ModelForm\n>>> from myapp.models import Author\n>>> class AuthorForm(ModelForm):\n... class Meta:\n... model = Author\n... localized_fields = ('birth_date',)\nlocalized_fields が特殊な値 '__all__' にセットされた場合、全てのフィールドがローカル化されます。
As with basic forms, you can extend and reuse ModelForms by inheriting\nthem. This is useful if you need to declare extra fields or extra methods on a\nparent class for use in a number of forms derived from models. For example,\nusing the previous ArticleForm class:
>>> class EnhancedArticleForm(ArticleForm):\n... def clean_pub_date(self):\n... ...\nThis creates a form that behaves identically to ArticleForm, except there's\nsome extra validation and cleaning for the pub_date field.
You can also subclass the parent's Meta inner class if you want to change\nthe Meta.fields or Meta.exclude lists:
>>> class RestrictedArticleForm(EnhancedArticleForm):\n... class Meta(ArticleForm.Meta):\n... exclude = ('body',)\nThis adds the extra method from the EnhancedArticleForm and modifies\nthe original ArticleForm.Meta to remove one field.
There are a couple of things to note, however.
\nNormal Python name resolution rules apply. If you have multiple base\nclasses that declare a Meta inner class, only the first one will be\nused. This means the child's Meta, if it exists, otherwise the\nMeta of the first parent, etc.
It's possible to inherit from both Form and ModelForm simultaneously,\nhowever, you must ensure that ModelForm appears first in the MRO. This is\nbecause these classes rely on different metaclasses and a class can only have\none metaclass.
It's possible to declaratively remove a Field inherited from a parent class by\nsetting the name to be None on the subclass.
You can only use this technique to opt out from a field defined declaratively\nby a parent class; it won't prevent the ModelForm metaclass from generating\na default field. To opt-out from default fields, see\n使うフィールドを選択する.
通常のフォームと同様に、フォームをインスタンス化する際に initial パラメータを指定することで、フォームに対する初期値を指定することができます。この方法で提供された初期値は、 フォームフィールドによる初期値と結びついたモデルインスタンスからの初期値の両方をオーバーライドします。例えば:
>>> article = Article.objects.get(pk=1)\n>>> article.headline\n'My headline'\n>>> form = ArticleForm(initial={'headline': 'Initial headline'}, instance=article)\n>>> form['headline'].value()\n'Initial headline'\nクラスの定義を使用する代わりに、スタンドアロンの関数 modelform_factory() を使って、与えられたモデルからフォームを生成することができます。作成時にカスタマイズをたくさん行わない場合に便利です:
>>> from django.forms import modelform_factory\n>>> from myapp.models import Book\n>>> BookForm = modelform_factory(Book, fields=("author", "title"))\nこれは、既存のフォームに対してシンプルな修正を加えたい場合にも使用できます。例えば、与えられたフィールドに対して使われるウィジェットを指定できます:
\n>>> from django.forms import Textarea\n>>> Form = modelform_factory(Book, form=BookForm,\n... widgets={"title": Textarea()})\n含むフィールドは fields や exclude のキーワード引数、もしくは ModelForm 内部の Meta クラスの対応する属性を使って指定できます。ModelForm 使うフィールドを選択する ドキュメントを参照してください。
... もしくは、特定のフィールドに対してローカル化を有効にします:
\n>>> Form = modelform_factory(Author, form=AuthorForm, localized_fields=("birth_date",))\n通常のフォームセット のように、Django には Django モデルを簡単に扱うための拡張的なフォームセットのクラスが用意されています。前述の Author モデルを再利用して見ていきましょう:
>>> from django.forms import modelformset_factory\n>>> from myapp.models import Author\n>>> AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))\nfields を使用すると、フォームセットが与えられるフィールドだけを使うようになります。 もしくは、"オプトアウト" の方法 (除外するフィールドを指定する) を取ることもできます:
>>> AuthorFormSet = modelformset_factory(Author, exclude=('birth_date',))\n以下は、Author モデルと連動するデータを扱うことができるフォームセットを作成します。これは通常のフォームセットと同じように動作します:
>>> formset = AuthorFormSet()\n>>> print(formset)\n<input type="hidden" name="form-TOTAL_FORMS" value="1" id="id_form-TOTAL_FORMS"><input type="hidden" name="form-INITIAL_FORMS" value="0" id="id_form-INITIAL_FORMS"><input type="hidden" name="form-MAX_NUM_FORMS" id="id_form-MAX_NUM_FORMS">\n<tr><th><label for="id_form-0-name">Name:</label></th><td><input id="id_form-0-name" type="text" name="form-0-name" maxlength="100"></td></tr>\n<tr><th><label for="id_form-0-title">Title:</label></th><td><select name="form-0-title" id="id_form-0-title">\n<option value="" selected>---------</option>\n<option value="MR">Mr.</option>\n<option value="MRS">Mrs.</option>\n<option value="MS">Ms.</option>\n</select><input type="hidden" name="form-0-id" id="id_form-0-id"></td></tr>\nデフォルトでは、モデルからフォームセットを作成するときには、フォームセットはモデル内の全てのオブジェクトを含むクエリセット (例えば Author.objects.all()) を使用します。 queryset 属性を使うことで、この動作をオーバーライドできます:
>>> formset = AuthorFormSet(queryset=Author.objects.filter(name__startswith='O'))\nもしくは、__init__ の中で self.queryset をセットするサブクラスを作成できます:
from django.forms import BaseModelFormSet\nfrom myapp.models import Author\n\nclass BaseAuthorFormSet(BaseModelFormSet):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.queryset = Author.objects.filter(name__startswith='O')\nそして、BaseAuthorFormSet クラスを factory 関数に渡します:
>>> AuthorFormSet = modelformset_factory(\n... Author, fields=('name', 'title'), formset=BaseAuthorFormSet)\nモデルの既存のインスタンスを 含まない フォームセットを返したい場合は、空の QuerySet を指定できます:
\n>>> AuthorFormSet(queryset=Author.objects.none())\nBy default, when you use modelformset_factory, a model form will\nbe created using modelform_factory().\nOften, it can be useful to specify a custom model form. For example,\nyou can create a custom model form that has custom validation:
class AuthorForm(forms.ModelForm):\n class Meta:\n model = Author\n fields = ('name', 'title')\n\n def clean_name(self):\n # custom validation for the name field\n ...\nThen, pass your model form to the factory function:
\nAuthorFormSet = modelformset_factory(Author, form=AuthorForm)\nIt is not always necessary to define a custom model form. The\nmodelformset_factory function has several arguments which are\npassed through to modelform_factory, which are described below.
widgetsLink to this heading#Using the widgets parameter, you can specify a dictionary of values to\ncustomize the ModelForm’s widget class for a particular field. This\nworks the same way as the widgets dictionary on the inner Meta\nclass of a ModelForm works:
>>> AuthorFormSet = modelformset_factory(\n... Author, fields=('name', 'title'),\n... widgets={'name': Textarea(attrs={'cols': 80, 'rows': 20})})\nlocalized_fieldsLink to this heading#Using the localized_fields parameter, you can enable localization for\nfields in the form.
>>> AuthorFormSet = modelformset_factory(\n... Author, fields=('name', 'title', 'birth_date'),\n... localized_fields=('birth_date',))\nlocalized_fields が特殊な値 '__all__' にセットされた場合、全てのフィールドがローカル化されます。
As with regular formsets, it's possible to specify initial data for forms in the formset by specifying an initial\nparameter when instantiating the model formset class returned by\nmodelformset_factory(). However, with model\nformsets, the initial values only apply to extra forms, those that aren't\nattached to an existing model instance. If the length of initial exceeds\nthe number of extra forms, the excess initial data is ignored. If the extra\nforms with initial data aren't changed by the user, they won't be validated or\nsaved.
As with a ModelForm, you can save the data as a model object. This is done\nwith the formset's save() method:
# Create a formset instance with POST data.\n>>> formset = AuthorFormSet(request.POST)\n\n# Assuming all is valid, save the data.\n>>> instances = formset.save()\nThe save() method returns the instances that have been saved to the\ndatabase. If a given instance's data didn't change in the bound data, the\ninstance won't be saved to the database and won't be included in the return\nvalue (instances, in the above example).
When fields are missing from the form (for example because they have been\nexcluded), these fields will not be set by the save() method. You can find\nmore information about this restriction, which also holds for regular\nModelForms, in Selecting the fields to use.
Pass commit=False to return the unsaved model instances:
# don't save to the database\n>>> instances = formset.save(commit=False)\n>>> for instance in instances:\n... # do something with instance\n... instance.save()\nThis gives you the ability to attach data to the instances before saving them\nto the database. If your formset contains a ManyToManyField, you'll also\nneed to call formset.save_m2m() to ensure the many-to-many relationships\nare saved properly.
After calling save(), your model formset will have three new attributes\ncontaining the formset's changes:
As with regular formsets, you can use the max_num and extra parameters\nto modelformset_factory() to limit the number of\nextra forms displayed.
max_num does not prevent existing objects from being displayed:
>>> Author.objects.order_by('name')\n<QuerySet [<Author: Charles Baudelaire>, <Author: Paul Verlaine>, <Author: Walt Whitman>]>\n\n>>> AuthorFormSet = modelformset_factory(Author, fields=('name',), max_num=1)\n>>> formset = AuthorFormSet(queryset=Author.objects.order_by('name'))\n>>> [x.name for x in formset.get_queryset()]\n['Charles Baudelaire', 'Paul Verlaine', 'Walt Whitman']\nAlso, extra=0 doesn't prevent creation of new model instances as you can\nadd additional forms with JavaScript\nor just send additional POST data. Formsets don't yet provide\nfunctionality for an "edit only" view that prevents creation of new\ninstances.
If the value of max_num is greater than the number of existing related\nobjects, up to extra additional blank forms will be added to the formset,\nso long as the total number of forms does not exceed max_num:
>>> AuthorFormSet = modelformset_factory(Author, fields=('name',), max_num=4, extra=2)\n>>> formset = AuthorFormSet(queryset=Author.objects.order_by('name'))\n>>> for form in formset:\n... print(form.as_table())\n<tr><th><label for="id_form-0-name">Name:</label></th><td><input id="id_form-0-name" type="text" name="form-0-name" value="Charles Baudelaire" maxlength="100"><input type="hidden" name="form-0-id" value="1" id="id_form-0-id"></td></tr>\n<tr><th><label for="id_form-1-name">Name:</label></th><td><input id="id_form-1-name" type="text" name="form-1-name" value="Paul Verlaine" maxlength="100"><input type="hidden" name="form-1-id" value="3" id="id_form-1-id"></td></tr>\n<tr><th><label for="id_form-2-name">Name:</label></th><td><input id="id_form-2-name" type="text" name="form-2-name" value="Walt Whitman" maxlength="100"><input type="hidden" name="form-2-id" value="2" id="id_form-2-id"></td></tr>\n<tr><th><label for="id_form-3-name">Name:</label></th><td><input id="id_form-3-name" type="text" name="form-3-name" maxlength="100"><input type="hidden" name="form-3-id" id="id_form-3-id"></td></tr>\nmax_num の値が None (デフォルト) だった場合、表示されるフォームの上限は大きな数になります (1000)。この数は、実際には制限がないと見なせるでしょう。
Model formsets are very similar to formsets. Let's say we want to present a\nformset to edit Author model instances:
from django.forms import modelformset_factory\nfrom django.shortcuts import render\nfrom myapp.models import Author\n\ndef manage_authors(request):\n AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))\n if request.method == 'POST':\n formset = AuthorFormSet(request.POST, request.FILES)\n if formset.is_valid():\n formset.save()\n # do something.\n else:\n formset = AuthorFormSet()\n return render(request, 'manage_authors.html', {'formset': formset})\nAs you can see, the view logic of a model formset isn't drastically different\nthan that of a "normal" formset. The only difference is that we call\nformset.save() to save the data into the database. (This was described\nabove, in Saving objects in the formset.)
clean() on a ModelFormSetLink to this heading#Just like with ModelForms, by default the clean() method of a\nModelFormSet will validate that none of the items in the formset violate\nthe unique constraints on your model (either unique, unique_together or\nunique_for_date|month|year). If you want to override the clean() method\non a ModelFormSet and maintain this validation, you must call the parent\nclass's clean method:
from django.forms import BaseModelFormSet\n\nclass MyModelFormSet(BaseModelFormSet):\n def clean(self):\n super().clean()\n # example custom validation across forms in the formset\n for form in self.forms:\n # your custom formset validation\n ...\nAlso note that by the time you reach this step, individual model instances\nhave already been created for each Form. Modifying a value in\nform.cleaned_data is not sufficient to affect the saved value. If you wish\nto modify a value in ModelFormSet.clean() you must modify\nform.instance:
from django.forms import BaseModelFormSet\n\nclass MyModelFormSet(BaseModelFormSet):\n def clean(self):\n super().clean()\n\n for form in self.forms:\n name = form.cleaned_data['name'].upper()\n form.cleaned_data['name'] = name\n # update the instance value.\n form.instance.name = name\nAs stated earlier, you can override the default queryset used by the model\nformset:
\nfrom django.forms import modelformset_factory\nfrom django.shortcuts import render\nfrom myapp.models import Author\n\ndef manage_authors(request):\n AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))\n if request.method == "POST":\n formset = AuthorFormSet(\n request.POST, request.FILES,\n queryset=Author.objects.filter(name__startswith='O'),\n )\n if formset.is_valid():\n formset.save()\n # Do something.\n else:\n formset = AuthorFormSet(queryset=Author.objects.filter(name__startswith='O'))\n return render(request, 'manage_authors.html', {'formset': formset})\nNote that we pass the queryset argument in both the POST and GET\ncases in this example.
There are three ways to render a formset in a Django template.
\nFirst, you can let the formset do most of the work:
\n<form method="post">\n {{ formset }}\n</form>\nSecond, you can manually render the formset, but let the form deal with\nitself:
\n<form method="post">\n {{ formset.management_form }}\n {% for form in formset %}\n {{ form }}\n {% endfor %}\n</form>\nWhen you manually render the forms yourself, be sure to render the management\nform as shown above. See the management form documentation.
\nThird, you can manually render each field:
\n<form method="post">\n {{ formset.management_form }}\n {% for form in formset %}\n {% for field in form %}\n {{ field.label_tag }} {{ field }}\n {% endfor %}\n {% endfor %}\n</form>\nIf you opt to use this third method and you don't iterate over the fields with\na {% for %} loop, you'll need to render the primary key field. For example,\nif you were rendering the name and age fields of a model:
<form method="post">\n {{ formset.management_form }}\n {% for form in formset %}\n {{ form.id }}\n <ul>\n <li>{{ form.name }}</li>\n <li>{{ form.age }}</li>\n </ul>\n {% endfor %}\n</form>\nNotice how we need to explicitly render {{ form.id }}. This ensures that\nthe model formset, in the POST case, will work correctly. (This example\nassumes a primary key named id. If you've explicitly defined your own\nprimary key that isn't called id, make sure it gets rendered.)
インラインフォームセットは、モデルフォームセット上の小さな抽象化レイヤーです。これを使うと、外部キーで関連するオブジェクトを操作することが簡単になります。以下の 2 つのモデルがあるとします:
\nfrom django.db import models\n\nclass Author(models.Model):\n name = models.CharField(max_length=100)\n\nclass Book(models.Model):\n author = models.ForeignKey(Author, on_delete=models.CASCADE)\n title = models.CharField(max_length=100)\nある作者 (Author) に紐付いた本 (Book) を編集するフォームセットを作成するには、以下のようにします:
\n>>> from django.forms import inlineformset_factory\n>>> BookFormSet = inlineformset_factory(Author, Book, fields=('title',))\n>>> author = Author.objects.get(name='Mike Royko')\n>>> formset = BookFormSet(instance=author)\nBookFormSet's prefix is 'book_set'\n(<model name>_set ). If Book's ForeignKey to Author has a\nrelated_name, that's used instead.
InlineFormSet のメソッドをオーバーライドするLink to this heading#InlineFormSet のメソッドをオーバーライドするには、 BaseModelFormSet ではなく、 BaseInlineFormSet をサブクラス化します。
例えば、 clean() をオーバーライドするとします:
from django.forms import BaseInlineFormSet\n\nclass CustomInlineFormSet(BaseInlineFormSet):\n def clean(self):\n super().clean()\n # example custom validation across forms in the formset\n for form in self.forms:\n # your custom formset validation\n ...\nOverriding clean() on a ModelFormSet も参照してください。
\nそして、インラインフォームセットを生成するとき、省略可能な引数の formset で渡します:
>>> from django.forms import inlineformset_factory\n>>> BookFormSet = inlineformset_factory(Author, Book, fields=('title',),\n... formset=CustomInlineFormSet)\n>>> author = Author.objects.get(name='Mike Royko')\n>>> formset = BookFormSet(instance=author)\n同じモデルが 1 つよりも多くの外部キーを持っている場合、 fk_name を使い手動で曖昧さを解消しなければなりません。例として、次のモデルについて考えます:
class Friendship(models.Model):\n from_friend = models.ForeignKey(\n Friend,\n on_delete=models.CASCADE,\n related_name='from_friends',\n )\n to_friend = models.ForeignKey(\n Friend,\n on_delete=models.CASCADE,\n related_name='friends',\n )\n length_in_months = models.IntegerField()\nこれを解決するには、 fk_name を inlineformset_factory() に使います:
>>> FriendshipFormSet = inlineformset_factory(Friend, Friendship, fk_name='from_friend',\n... fields=('to_friend', 'length_in_months'))\nモデルに紐付いたオブジェクトを編集する機能をユーザーに提供するビューを作るには、こうします:
\ndef manage_books(request, author_id):\n author = Author.objects.get(pk=author_id)\n BookInlineFormSet = inlineformset_factory(Author, Book, fields=('title',))\n if request.method == "POST":\n formset = BookInlineFormSet(request.POST, request.FILES, instance=author)\n if formset.is_valid():\n formset.save()\n # Do something. Should generally end with a redirect. For example:\n return HttpResponseRedirect(author.get_absolute_url())\n else:\n formset = BookInlineFormSet(instance=author)\n return render(request, 'manage_books.html', {'formset': formset})\nPOST と GET いずれにおいても instance を渡していることに注目してください
inlineformset_factory は modelformset_factory を使っており、多くの引数は modelformset_factory に渡されます。これは modelformset_factory と同様に、 widgets 引数を渡すことができることを意味しています。詳細は、上記 Specifying widgets to use in the form with widgets を参照してください。