モデルからフォームを作成する

ModelForm

class ModelForm[ソース]

データベース中心のアプリケーションを作成している場合、Django モデルに密接にマップするフォームを使うことになるでしょう。例えば、BlogComment モデルを持っていて、閲覧者がコメントを送信できるフォームを作成したくなったとしましょう。この場合、すでにモデル内にフィールドが定義されているので、フォーム内にフィールドタイプを改めて定義するのは冗長でしょう。

このためDjango には、Django モデルから Form クラスを生成できるようなヘルパークラスを用意してあります。

For example:

>>> from django.forms import ModelForm
>>> from myapp.models import Article

# Create the form class.
>>> class ArticleForm(ModelForm):
...     class Meta:
...         model = Article
...         fields = ['pub_date', 'headline', 'content', 'reporter']

# Creating a form to add an article.
>>> form = ArticleForm()

# Creating a form to change an existing article.
>>> article = Article.objects.get(pk=1)
>>> form = ArticleForm(instance=article)

フィールドの型

生成された Form クラスは、指定された全てのモデルフィールドに対して、fields 属性で指定された順番でフォームフィールドを有します。

各モデルフィールドは、対応するデフォルトのフォームフィールドを持ちます。例えば、モデル上の CharField はフォーム上で CharField として表現されます。モデル ManyToManyFieldMultipleChoiceField として表現されます。 以下は、各フィールドの対応表です:

モデルフィールド フォームフィールド
AutoField フォーム上では表示されません。
BigAutoField フォーム上では表示されません。
BigIntegerField IntegerFieldmin_value が -9223372036854775808 から max_value に 9223372036854775807 セットされます。
BooleanField BooleanField
CharField CharField with max_length set to the model field's max_length and empty_value set to None if null=True.
DateField DateField
DateTimeField DateTimeField
DecimalField DecimalField
EmailField EmailField
FileField FileField
FilePathField FilePathField
FloatField FloatField
ForeignKey ModelChoiceField (see below)
ImageField ImageField
IntegerField IntegerField
IPAddressField IPAddressField
GenericIPAddressField GenericIPAddressField
ManyToManyField ModelMultipleChoiceField (以下を参照)
NullBooleanField NullBooleanField
PositiveIntegerField IntegerField
PositiveSmallIntegerField IntegerField
SlugField SlugField
SmallIntegerField IntegerField
TextField CharFieldwidget=forms.Textarea です。
TimeField TimeField
URLField URLField

お気付きかもしれませんが、 ForeignKeyManyToManyField の 2 つのモデルフィールドは特殊なケースとなります:

  • ForeignKeydjango.forms.ModelChoiceField によって表現され、モデルの QuerySet を選択肢として持つ ChoiceField です。
  • ManyToManyFielddjango.forms.ModelMultipleChoiceField によって表現され、モデルの QuerySet を選択肢として持つ MultipleChoiceField です。

加えて、生成されたフォームフィールドはそれぞれ以下の通り属性がセットされます:

  • モデルフィールドに blank=True が設定されている場合、フォームフィールド上で requiredFalse にセットされます。それ以外の場合は required=True となります。
  • フォームフィールドの label はモデルフィールドの verbose_name の最初の文字を大文字にしたものがセットされます。
  • フォームフィールドの help_text はモデルフィールドの help_text がセットされます。
  • モデルフィールドに choices が設定されている場合、フォームフィールドの widgetSelect にセットされ、選択肢にはモデルフィールドの choices が使われます。通常、選択肢には空欄の選択肢が追加され、デフォルトで選択されることになります。フィールドが required の場合、ユーザは選択肢を選ぶ必要があります。モデルフィールドに blank=False および明示的な default 値が設定されている場合、空欄の選択肢は表示されません (代わりに default 値が選択された状態で表示されます) 。

与えられたモデルフィールドに対して使われるフォームフィールドをオーバーライドすることもできます。後述の Overriding the default fields を参照してください。

A full example

以下のような一連のモデルを考えていきましょう:

from django.db import models
from django.forms import ModelForm

TITLE_CHOICES = (
    ('MR', 'Mr.'),
    ('MRS', 'Mrs.'),
    ('MS', 'Ms.'),
)

class Author(models.Model):
    name = models.CharField(max_length=100)
    title = models.CharField(max_length=3, choices=TITLE_CHOICES)
    birth_date = models.DateField(blank=True, null=True)

    def __str__(self):
        return self.name

class Book(models.Model):
    name = models.CharField(max_length=100)
    authors = models.ManyToManyField(Author)

class AuthorForm(ModelForm):
    class Meta:
        model = Author
        fields = ['name', 'title', 'birth_date']

class BookForm(ModelForm):
    class Meta:
        model = Book
        fields = ['name', 'authors']

これらのモデルでは、上記の ModelForm サブクラスはおおむね以下と同等と言えます (唯一の違いは save() メソッドで、これからすぐ説明します):

from django import forms

class AuthorForm(forms.Form):
    name = forms.CharField(max_length=100)
    title = forms.CharField(
        max_length=3,
        widget=forms.Select(choices=TITLE_CHOICES),
    )
    birth_date = forms.DateField(required=False)

class BookForm(forms.Form):
    name = forms.CharField(max_length=100)
    authors = forms.ModelMultipleChoiceField(queryset=Author.objects.all())

ModelForm の検証 (バリデーション)

ModelForm のバリデーションには、以下の 2 つのステップが存在します:

  1. フォームのバリデーションを実施する
  2. モデルのインスタンスのバリデーションを実施する

通常のフォームのバリデーションと同じように、モデルフォームのバリデーションは is_valid() が呼ばれたときや errors 属性にアクセスしたとき、暗黙的に実行されます。また、実際にはあまり使うメソッドではありませんが、明示的に full_clean() を呼んだときにもバリデーションが実行されます。

Model バリデーション (Model.full_clean()) は、フォームバリデーションのステップ内でフォームの clean() メソッドが呼ばれたすぐ直後に実行されます。

警告

クリーニングのプロセスは、様々な方法で ModelForm コンストラクタに渡されたモデルのインスタンスを修正します。例えば、モデル上のあらゆる日付フィールドは、実際の date オブジェクトに変換されます。失敗したバリデーションは、一貫性のない状態でモデルインスタンスを元のままにしておくため、これを再利用するのはお勧めできません。

clean() メソッドをオーバーライドする

通常のフォームと同じ方法でモデルフォーム上の clean() メソッドをオーバーライドして、バリデーションの動作を追加することができます。

モデルのオブジェクトに付属したモデルフォームのインスタンスは、instance 属性を持ち、メソッドが特定のモデルのインスタンスにアクセスできるようにします。

警告

ModelForm.clean() メソッドは、モデルバリデーション に、uniqueunique_together または unique_for_date|month|year としてマークされたモデルフィールドの一意性を検証させます。

clean() メソッドをオーバーライドして、なおかつこのバリデーションを維持したい場合、親クラスの clean() メソッドを呼ぶ必要があります。

モデルバリデーションとのやり取り

バリデーションプロセスの一部として、ModelForm フォーム上で対応するフィールドを持つモデルのそれぞれのフィールドの clean() メソッドを呼び出します。モデルフィールドを除外した場合、これらのフィールドに対してはバリデーションが実行されません。フィールドのクリーニングとバリデーションの詳しい働き方については、フォームバリデーション ドキュメントを参照してください。

モデルの clean() メソッドは一意性のチェックがされる前に呼び出されます。モデルの clean() フックのより詳しい情報については、オブジェクトのバリデーションを行う を参照してください。

モデルの error_messages のレンダリングを考える

フォームフィールドフォーム Meta の段階で定義されるエラーメッセージは、常に モデルフィールド の段階で定義されたエラーメッセージより常に優先されます。

モデルフィールド 上で定義されたエラーメッセージは、モデルバリデーション のステップの間に ValidationError が発生したときにのみ使用され、フォームの段階では対応するエラーメッセージは定義されていません。

NON_FIELD_ERRORS キーを Meta クラス内の error_messages ディクショナリに追加することで、モデルバリデーションによって発生する NON_FIELD_ERRORS に対するエラーメッセージをオーバーライドできます。

from django.forms import ModelForm
from django.core.exceptions import NON_FIELD_ERRORS

class ArticleForm(ModelForm):
    class Meta:
        error_messages = {
            NON_FIELD_ERRORS: {
                'unique_together': "%(model_name)s's %(field_labels)s are not unique.",
            }
        }

save() メソッド

全ての ModelFormsave() メソッドも持っています。このメソッドは、フォームに結びつけられたデータからデータベースオブジェクトを生成して保存します。ModelForm のサブクラスはキーワード引数 instance として既存のモデルインスタンスを受け取ることができます; これが指定されると、save() はそのインスタンスを更新するようになります。 指定されない場合は、save() は指定されたモデルの新しいインスタンスを生成します:

>>> from myapp.models import Article
>>> from myapp.forms import ArticleForm

# Create a form instance from POST data.
>>> f = ArticleForm(request.POST)

# Save a new Article object from the form's data.
>>> new_article = f.save()

# Create a form to edit an existing Article, but use
# POST data to populate the form.
>>> a = Article.objects.get(pk=1)
>>> f = ArticleForm(request.POST, instance=a)
>>> f.save()

フォームが バリデーションされていない 場合、save() を呼び出すと、form.errors をチェックすることでこれを行います。フォーム内のデータが適正ではない場合は ValueError が発生します -- 例えば、form.errorsTrue だと評価された場合です。

If an optional field doesn't appear in the form's data, the resulting model instance uses the model field default, if there is one, for that field. This behavior doesn't apply to fields that use CheckboxInput, CheckboxSelectMultiple, or SelectMultiple (or any custom widget whose value_omitted_from_data() method always returns False) since an unchecked checkbox and unselected <select multiple> don't appear in the data of an HTML form submission. Use a custom form field or widget if you're designing an API and want the default fallback behavior for a field that uses one of these widgets.

この 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.
>>> f = AuthorForm(request.POST)

# Create, but don't save the new author instance.
>>> new_author = f.save(commit=False)

# Modify the author in some way.
>>> new_author.some_field = 'some_value'

# Save the new instance.
>>> new_author.save()

# Now, save the many-to-many data for the form.
>>> f.save_m2m()

save_m2m() の呼び出しは、save(commit=False) を使った場合にのみ必要となります。フォーム上で単に save() を使用したときは、全てのデータ -- 多対多のデータを含む -- が追加的なメソッドを呼び出す必要なく保存されます。例えば:

# Create a form instance with POST data.
>>> a = Author()
>>> f = AuthorForm(request.POST, instance=a)

# Create and save the new author instance. There's no need to do anything else.
>>> new_author = f.save()

save()save_m2m() メソッドのほかは、ModelFormforms のフォームとまったく同じ方法で動作します。例えば、is_valid() メソッドは妥当性をチェックするために使用される、is_multipart() メソッドはフォームがマルチパートのファイルアップロードを必要とするかどうかを (ゆえに request.FILES がフォームに渡される必要があるかどうかも) 決める、などです。詳しくは Binding uploaded files to a form を参照してください。

使うフィールドを選択する

fields 属性を使って、フォームで編集すべき全てのフィールドを明示的に指定することを強くお勧めします。そうしないと、フォームで予期せず特定のフィールドを設定できるようになり、セキュリティ上の問題が発生しやすくなります。特に新しいフィールドがモデルに追加されたときに起こりがちです。フォームのレンダリング方法によっては、Webページで問題が目に見えないことさえあります。

代わりの方法は、全てのフィールドを自動的に含めるか、いくつかのフィールドのみをブラックリスト化することです。この基本的なアプローチは安全性が低く、主要なウェブサイトで深刻な悪用 (例えば GitHub) を招いていることが知られています。

しかしながら、これらのセキュリティ問題が当てはまらないことが明白な場合のために、2 つのショートカットが利用可能です:

  1. fields 属性に、特殊なああ対 '__all__' をセットして、モデル内の全てのフィールドが使われるように指定します。例えば:

    from django.forms import ModelForm
    
    class AuthorForm(ModelForm):
        class Meta:
            model = Author
            fields = '__all__'
    
  2. ModelForm の中の Meta クラスの exclude 属性に、フォームから除外されるフィールドのリストをセットします。

    For example:

    class PartialAuthorForm(ModelForm):
        class Meta:
            model = Author
            exclude = ['title']
    

    Author モデルは 3 つのフィールド nametitlebirth_date を持っているため、これで``name`` と birth_date がフォームに表示されることになります。

このどちらかが使われた場合、フォーム内で表示されるフィールドの順番はモデル内でフィールドが定義された順番となり、ManyToManyField インスタンスは最後に表示されます。

加えて、Django は以下のルールも適用します: モデルフィールドで editable=False をセットした場合、ModelForm を通じて生成された 全ての フォームはそのフィールドを含みません。

注釈

上記のロジックでフォームに含まれない全てのフィールドは、フォームの save() メソッドでセットされません。また、除外したフィールドを手動でフォームに追加し直した場合、モデルインスタンスから初期化されることはありません。

Django は不完全なモデルを保存しないようにするため、モデルの設定でフィールドを空にすることを許容しておらず、かつ除外されたフィールドに対するデフォルト値を指定しなかった場合、除外されたフィールドを含む ModelFormsave() しようとすると失敗します。この失敗を避けるには、除外する必須フィールドに初期値を指定してモデルをインスタンス化する必要があります:

author = Author(title='Mr')
form = PartialAuthorForm(request.POST, instance=author)
form.save()

もしくは、save(commit=False) を使って手動で追加の必須フィールドをセットできます:

form = PartialAuthorForm(request.POST)
author = form.save(commit=False)
author.title = 'Mr'
author.save()

save(commit=False) の使用について、詳しくは section on saving forms を参照してください。

デフォルトのフィールドをオーバライドする

前述の Field types テーブルで説明したとおり、デフォルトのフィールドタイプは実用的なデフォルトです。モデルに DateField がある場合、フォーム内で DateField として表示したいことでしょう。しかし、ModelForm では、与えられたモデルに足してフォームフィールドを変更する柔軟性があります。

フィールドに対して独自のウィジェットを指定するには、内部の Meta クラスの widgets を使用してください。これは、フィールド名としジェットのクラスやインスタンスをマッピングするディクショナリです。

例えば、Authoername 属性に対する CharField を、デフォルトの <input type="text"> の代わりに <textarea> で表示したい場合、フィールドのウィジェットをオーバーライドすることができます:

from django.forms import ModelForm, Textarea
from myapp.models import Author

class AuthorForm(ModelForm):
    class Meta:
        model = Author
        fields = ('name', 'title', 'birth_date')
        widgets = {
            'name': Textarea(attrs={'cols': 80, 'rows': 20}),
        }

widgets ディクショナリは、インスタンス (例えば Textarea(...)) とクラス (例えば Textarea) のどちらを取ることもできます。

同様に、フィールドをさらにカスタマイズしたい場合、内部の Meta クラスの labelshelp_textserror_messages と言った属性を指定することができます。

例えば、name フィールドに対する文字列に直面する全てのユーザの文章をカスタマイズしたい場合:

from django.utils.translation import gettext_lazy as _

class AuthorForm(ModelForm):
    class Meta:
        model = Author
        fields = ('name', 'title', 'birth_date')
        labels = {
            'name': _('Writer'),
        }
        help_texts = {
            'name': _('Some useful help text.'),
        }
        error_messages = {
            'name': {
                'max_length': _("This writer's name is too long."),
            },
        }

field_classes を指定して、フォームによってインスタンス化されたフィールドのタイプをカスタマイズすることもできます。

例えば、slug フィールドに対して MySlugFormField を使いたい場合、以下のようにできます:

from django.forms import ModelForm
from myapp.models import Article

class ArticleForm(ModelForm):
    class Meta:
        model = Article
        fields = ['pub_date', 'headline', 'content', 'reporter', 'slug']
        field_classes = {
            'slug': MySlugFormField,
        }

最後に、フィールドを完全に -- タイプ、バリデータ、必須かどうかなどを含めて -- コントロールしたい場合、通常の Form で行うのと同じようにフィールドを宣言的に指定することで実現できます。

フィールドのバリデータを指定したい場合、フィールドを宣言的に定義して validators パラメータを設定することで実現できます:

from django.forms import ModelForm, CharField
from myapp.models import Article

class ArticleForm(ModelForm):
    slug = CharField(validators=[validate_slug])

    class Meta:
        model = Article
        fields = ['pub_date', 'headline', 'content', 'reporter', 'slug']

注釈

以下のように明示的にフォームフィールドをインスタンス化したとき、ModelForm` と 通常の Form が連動する方法を理解することが重要となります。

ModelForm は、特定のフィールドを自動的に生成できる通常の Form です。自動的に生成されるフィールドは、Meta クラスの内容とどのフィールドが宣言的に定義されているかに依存します。基本的に、ModelForm は フォームから 除外された フィールド、言い換えると宣言的に定義されなかったフィールド のみ を生成します。

宣言的に定義されたフィールドはそのままになります。したがって、Meta 属性に対するカスタマイズ、例えば widgetslabelshelp_textserror_messages は無視されます; これらは自動的に生成されたフィールドにのみ適用されます。

同様に、宣言的に定義されたフィールドは、対応するモデルから引き継がれた max_lengthrequired のような属性を描画しません。モデル内で定義された動作を引き継ぎたい場合は、フォームフィールドを宣言する際に明示的に関連する属性をセットする必要があります。

例えば、Article モデルは以下のようになります:

class Article(models.Model):
    headline = models.CharField(
        max_length=200,
        null=True,
        blank=True,
        help_text='Use puns liberally',
    )
    content = models.TextField()

そして、指定されたとおりに blankhelp_text``が維持されている一方で、``headline に対して独自のバリデーションを実施するために、ArticleForm を以下のように定義します:

class ArticleForm(ModelForm):
    headline = MyFormField(
        max_length=200,
        required=False,
        help_text='Use puns liberally',
    )

    class Meta:
        model = Article
        fields = ['headline', 'content']

フォームフィールドのタイプを使用して、対応するモデルフィールドの内容を設定できることを確認する必要があります。 互換性がない場合、暗黙的な変換が行われないので、 "ValueError" を取得します。

フィールドとその属性について、詳しくは フォームフィールドのドキュメンテーション を参照してください。

フィールドのローカル化を有効にする

デフォルトでは、ModelForm 内のフィールドはデータをローカル化しません。フィールドに対してローカル化を有効にするために、Meat クラスの localized_fields 属性を使うことができます。

>>> from django.forms import ModelForm
>>> from myapp.models import Author
>>> class AuthorForm(ModelForm):
...     class Meta:
...         model = Author
...         localized_fields = ('birth_date',)

localized_fields が特殊な値 '__all__' にセットされた場合、全てのフィールドがローカル化されます。

フォームの継承

As with basic forms, you can extend and reuse ModelForms by inheriting them. This is useful if you need to declare extra fields or extra methods on a parent class for use in a number of forms derived from models. For example, using the previous ArticleForm class:

>>> class EnhancedArticleForm(ArticleForm):
...     def clean_pub_date(self):
...         ...

This creates a form that behaves identically to ArticleForm, except there's some extra validation and cleaning for the pub_date field.

You can also subclass the parent's Meta inner class if you want to change the Meta.fields or Meta.exclude lists:

>>> class RestrictedArticleForm(EnhancedArticleForm):
...     class Meta(ArticleForm.Meta):
...         exclude = ('body',)

This adds the extra method from the EnhancedArticleForm and modifies the original ArticleForm.Meta to remove one field.

There are a couple of things to note, however.

  • Normal Python name resolution rules apply. If you have multiple base classes that declare a Meta inner class, only the first one will be used. This means the child's Meta, if it exists, otherwise the Meta of the first parent, etc.

  • It's possible to inherit from both Form and ModelForm simultaneously, however, you must ensure that ModelForm appears first in the MRO. This is because these classes rely on different metaclasses and a class can only have one metaclass.

  • It's possible to declaratively remove a Field inherited from a parent class by setting the name to be None on the subclass.

    You can only use this technique to opt out from a field defined declaratively by a parent class; it won't prevent the ModelForm metaclass from generating a default field. To opt-out from default fields, see 使うフィールドを選択する.

Providing initial values

通常のフォームと同様に、フォームをインスタンス化する際に initial パラメータを指定することで、フォームに対する初期値を指定することができます。この方法で提供された初期値は、 フォームフィールドによる初期値と結びついたモデルインスタンスからの初期値の両方をオーバーライドします。例えば:

>>> article = Article.objects.get(pk=1)
>>> article.headline
'My headline'
>>> form = ArticleForm(initial={'headline': 'Initial headline'}, instance=article)
>>> form['headline'].value()
'Initial headline'

ModelForm factory 関数

クラスの定義を使用する代わりに、スタンドアロンの関数 modelform_factory() を使って、与えられたモデルからフォームを生成することができます。作成時にカスタマイズをたくさん行わない場合に便利です:

>>> from django.forms import modelform_factory
>>> from myapp.models import Book
>>> BookForm = modelform_factory(Book, fields=("author", "title"))

これは、既存のフォームに対してシンプルな修正を加えたい場合にも使用できます。例えば、与えられたフィールドに対して使われるウィジェットを指定できます:

>>> from django.forms import Textarea
>>> Form = modelform_factory(Book, form=BookForm,
...                          widgets={"title": Textarea()})

含むフィールドは fieldsexclude のキーワード引数、もしくは ModelForm 内部の Meta クラスの対応する属性を使って指定できます。ModelForm 使うフィールドを選択する ドキュメントを参照してください。

... もしくは、特定のフィールドに対してローカル化を有効にします:

>>> Form = modelform_factory(Author, form=AuthorForm, localized_fields=("birth_date",))

モデルのフォームセット

class models.BaseModelFormSet

通常のフォームセット のように、Django には Django モデルを阿寒単に圧かつための拡張的なフォームセットのクラスが用意されています。前述の Author モデルを再利用して見ていきましょう:

>>> from django.forms import modelformset_factory
>>> from myapp.models import Author
>>> AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))

fields を使用すると、フォームセットが与えられるフィールドだけを使うようになります。 もしくは、"オプトアウト" の方法 (除外するフィールドを指定する) を取ることもできます:

>>> AuthorFormSet = modelformset_factory(Author, exclude=('birth_date',))

以下は、Author モデルと連動するデータを扱うことができるフォームセットを作成します。これは通常のフォームセットと同じように動作します:

>>> formset = AuthorFormSet()
>>> print(formset)
<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" />
<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>
<tr><th><label for="id_form-0-title">Title:</label></th><td><select name="form-0-title" id="id_form-0-title">
<option value="" selected>---------</option>
<option value="MR">Mr.</option>
<option value="MRS">Mrs.</option>
<option value="MS">Ms.</option>
</select><input type="hidden" name="form-0-id" id="id_form-0-id" /></td></tr>

注釈

modelformset_factory() はフォームセットの生成に formset_factory() を使います。これは、モデルフォームが特定のモデルとやり取りする方法を知っている基本的なフォームセットの拡張だと言うことを意味します。

クエリセットを変更する

デフォルトでは、モデルからフォームセットを作成するときには、フォームセットはモデル内の全てのオブジェクトを含むクエリセット (例えば Author.objects.all()) を使用します。 queryset 属性を使うことで、この動作をオーバーライドできます:

>>> formset = AuthorFormSet(queryset=Author.objects.filter(name__startswith='O'))

もしくは、__init__ の中で self.queryset をセットするサブクラスを作成できます:

from django.forms import BaseModelFormSet
from myapp.models import Author

class BaseAuthorFormSet(BaseModelFormSet):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.queryset = Author.objects.filter(name__startswith='O')

そして、BaseAuthorFormSet クラスを factory 関数に渡します:

>>> AuthorFormSet = modelformset_factory(
...     Author, fields=('name', 'title'), formset=BaseAuthorFormSet)

モデルの既存のインスタンスを 含まない フォームセットを返したい場合は、空の QuerySet を指定できます:

>>> AuthorFormSet(queryset=Author.objects.none())

フォームを変更する

By default, when you use modelformset_factory, a model form will be created using modelform_factory(). Often, it can be useful to specify a custom model form. For example, you can create a custom model form that has custom validation:

class AuthorForm(forms.ModelForm):
    class Meta:
        model = Author
        fields = ('name', 'title')

    def clean_name(self):
        # custom validation for the name field
        ...

Then, pass your model form to the factory function:

AuthorFormSet = modelformset_factory(Author, form=AuthorForm)

It is not always necessary to define a custom model form. The modelformset_factory function has several arguments which are passed through to modelform_factory, which are described below.

Specifying widgets to use in the form with widgets

Using the widgets parameter, you can specify a dictionary of values to customize the ModelForm’s widget class for a particular field. This works the same way as the widgets dictionary on the inner Meta class of a ModelForm works:

>>> AuthorFormSet = modelformset_factory(
...     Author, fields=('name', 'title'),
...     widgets={'name': Textarea(attrs={'cols': 80, 'rows': 20})})

Enabling localization for fields with localized_fields

Using the localized_fields parameter, you can enable localization for fields in the form.

>>> AuthorFormSet = modelformset_factory(
...     Author, fields=('name', 'title', 'birth_date'),
...     localized_fields=('birth_date',))

localized_fields が特殊な値 '__all__' にセットされた場合、全てのフィールドがローカル化されます。

Providing initial values

As with regular formsets, it's possible to specify initial data for forms in the formset by specifying an initial parameter when instantiating the model formset class returned by modelformset_factory(). However, with model formsets, the initial values only apply to extra forms, those that aren't attached to an existing model instance. If the extra forms with initial data aren't changed by the user, they won't be validated or saved.

Saving objects in the formset

As with a ModelForm, you can save the data as a model object. This is done with the formset's save() method:

# Create a formset instance with POST data.
>>> formset = AuthorFormSet(request.POST)

# Assuming all is valid, save the data.
>>> instances = formset.save()

The save() method returns the instances that have been saved to the database. If a given instance's data didn't change in the bound data, the instance won't be saved to the database and won't be included in the return value (instances, in the above example).

When fields are missing from the form (for example because they have been excluded), these fields will not be set by the save() method. You can find more information about this restriction, which also holds for regular ModelForms, in Selecting the fields to use.

Pass commit=False to return the unsaved model instances:

# don't save to the database
>>> instances = formset.save(commit=False)
>>> for instance in instances:
...     # do something with instance
...     instance.save()

This gives you the ability to attach data to the instances before saving them to the database. If your formset contains a ManyToManyField, you'll also need to call formset.save_m2m() to ensure the many-to-many relationships are saved properly.

After calling save(), your model formset will have three new attributes containing the formset's changes:

models.BaseModelFormSet.changed_objects
models.BaseModelFormSet.deleted_objects
models.BaseModelFormSet.new_objects

Limiting the number of editable objects

As with regular formsets, you can use the max_num and extra parameters to modelformset_factory() to limit the number of extra forms displayed.

max_num does not prevent existing objects from being displayed:

>>> Author.objects.order_by('name')
<QuerySet [<Author: Charles Baudelaire>, <Author: Paul Verlaine>, <Author: Walt Whitman>]>

>>> AuthorFormSet = modelformset_factory(Author, fields=('name',), max_num=1)
>>> formset = AuthorFormSet(queryset=Author.objects.order_by('name'))
>>> [x.name for x in formset.get_queryset()]
['Charles Baudelaire', 'Paul Verlaine', 'Walt Whitman']

Also, extra=0 doesn't prevent creation of new model instances as you can add additional forms with JavaScript or just send additional POST data. Formsets don't yet provide functionality for an "edit only" view that prevents creation of new instances.

If the value of max_num is greater than the number of existing related objects, up to extra additional blank forms will be added to the formset, so long as the total number of forms does not exceed max_num:

>>> AuthorFormSet = modelformset_factory(Author, fields=('name',), max_num=4, extra=2)
>>> formset = AuthorFormSet(queryset=Author.objects.order_by('name'))
>>> for form in formset:
...     print(form.as_table())
<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>
<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>
<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>
<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>

max_num の値が None (デフォルト) だった場合、表示されるフォームの上限は大きな数になります (1000)。この数は、実際には制限がないと見なせるでしょう。

Using a model formset in a view

Model formsets are very similar to formsets. Let's say we want to present a formset to edit Author model instances:

from django.forms import modelformset_factory
from django.shortcuts import render
from myapp.models import Author

def manage_authors(request):
    AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))
    if request.method == 'POST':
        formset = AuthorFormSet(request.POST, request.FILES)
        if formset.is_valid():
            formset.save()
            # do something.
    else:
        formset = AuthorFormSet()
    return render(request, 'manage_authors.html', {'formset': formset})

As you can see, the view logic of a model formset isn't drastically different than that of a "normal" formset. The only difference is that we call formset.save() to save the data into the database. (This was described above, in Saving objects in the formset.)

Overriding clean() on a ModelFormSet

Just like with ModelForms, by default the clean() method of a ModelFormSet will validate that none of the items in the formset violate the unique constraints on your model (either unique, unique_together or unique_for_date|month|year). If you want to override the clean() method on a ModelFormSet and maintain this validation, you must call the parent class's clean method:

from django.forms import BaseModelFormSet

class MyModelFormSet(BaseModelFormSet):
    def clean(self):
        super().clean()
        # example custom validation across forms in the formset
        for form in self.forms:
            # your custom formset validation
            ...

Also note that by the time you reach this step, individual model instances have already been created for each Form. Modifying a value in form.cleaned_data is not sufficient to affect the saved value. If you wish to modify a value in ModelFormSet.clean() you must modify form.instance:

from django.forms import BaseModelFormSet

class MyModelFormSet(BaseModelFormSet):
    def clean(self):
        super().clean()

        for form in self.forms:
            name = form.cleaned_data['name'].upper()
            form.cleaned_data['name'] = name
            # update the instance value.
            form.instance.name = name

Using a custom queryset

As stated earlier, you can override the default queryset used by the model formset:

from django.forms import modelformset_factory
from django.shortcuts import render
from myapp.models import Author

def manage_authors(request):
    AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))
    if request.method == "POST":
        formset = AuthorFormSet(
            request.POST, request.FILES,
            queryset=Author.objects.filter(name__startswith='O'),
        )
        if formset.is_valid():
            formset.save()
            # Do something.
    else:
        formset = AuthorFormSet(queryset=Author.objects.filter(name__startswith='O'))
    return render(request, 'manage_authors.html', {'formset': formset})

Note that we pass the queryset argument in both the POST and GET cases in this example.

Using the formset in the template

There are three ways to render a formset in a Django template.

First, you can let the formset do most of the work:

<form method="post" action="">
    {{ formset }}
</form>

Second, you can manually render the formset, but let the form deal with itself:

<form method="post" action="">
    {{ formset.management_form }}
    {% for form in formset %}
        {{ form }}
    {% endfor %}
</form>

When you manually render the forms yourself, be sure to render the management form as shown above. See the management form documentation.

Third, you can manually render each field:

<form method="post" action="">
    {{ formset.management_form }}
    {% for form in formset %}
        {% for field in form %}
            {{ field.label_tag }} {{ field }}
        {% endfor %}
    {% endfor %}
</form>

If you opt to use this third method and you don't iterate over the fields with a {% for %} loop, you'll need to render the primary key field. For example, if you were rendering the name and age fields of a model:

<form method="post" action="">
    {{ formset.management_form }}
    {% for form in formset %}
        {{ form.id }}
        <ul>
            <li>{{ form.name }}</li>
            <li>{{ form.age }}</li>
        </ul>
    {% endfor %}
</form>

Notice how we need to explicitly render {{ form.id }}. This ensures that the model formset, in the POST case, will work correctly. (This example assumes a primary key named id. If you've explicitly defined your own primary key that isn't called id, make sure it gets rendered.)

インラインフォームセット

class models.BaseInlineFormSet

インラインフォームセットは、モデルフォームセット上の小さな抽象化レイヤーです。これを使うと、外部キーで関連するオブジェクトを操作することが簡単になります。以下の 2 つのモデルがあるとします:

from django.db import models

class Author(models.Model):
    name = models.CharField(max_length=100)

class Book(models.Model):
    author = models.ForeignKey(Author, on_delete=models.CASCADE)
    title = models.CharField(max_length=100)

ある作者 (Author) に紐付いた本 (Book) を編集するフォームセットを作成するには、以下のようにします:

>>> from django.forms import inlineformset_factory
>>> BookFormSet = inlineformset_factory(Author, Book, fields=('title',))
>>> author = Author.objects.get(name='Mike Royko')
>>> formset = BookFormSet(instance=author)

BookFormSet's prefix is 'book_set' (<model name>_set ). If Book's ForeignKey to Author has a related_name, that's used instead.

注釈

inlineformset_factory() は、 modelformset_factory() を使い、can_delete=True をセットします。

InlineFormSet のメソッドをオーバーライドする

InlineFormSet のメソッドをオーバーライドするには、 BaseModelFormSet ではなく、 BaseInlineFormSet をサブクラス化します。

例えば、 clean() をオーバーライドするとします:

from django.forms import BaseInlineFormSet

class CustomInlineFormSet(BaseInlineFormSet):
    def clean(self):
        super().clean()
        # example custom validation across forms in the formset
        for form in self.forms:
            # your custom formset validation
            ...

Overriding clean() on a ModelFormSet も参照してください。

そして、インラインフォームセットを生成するとき、省略可能な引数の formset で渡します:

>>> from django.forms import inlineformset_factory
>>> BookFormSet = inlineformset_factory(Author, Book, fields=('title',),
...     formset=CustomInlineFormSet)
>>> author = Author.objects.get(name='Mike Royko')
>>> formset = BookFormSet(instance=author)

複数の外部キーをひとつのモデルが持っている場合

同じモデルが 1 つよりも多くの外部キーを持っている場合、 fk_name を使い手動で曖昧さを解消しなければなりません。例として、次のモデルについて考えます:

class Friendship(models.Model):
    from_friend = models.ForeignKey(
        Friend,
        on_delete=models.CASCADE,
        related_name='from_friends',
    )
    to_friend = models.ForeignKey(
        Friend,
        on_delete=models.CASCADE,
        related_name='friends',
    )
    length_in_months = models.IntegerField()

これを解決するには、 fk_nameinlineformset_factory() に使います:

>>> FriendshipFormSet = inlineformset_factory(Friend, Friendship, fk_name='from_friend',
...     fields=('to_friend', 'length_in_months'))

ビューでインラインフォームセットを使う

モデルに紐付いたオブジェクトを編集する機能をユーザーに提供するビューを作るには、こうします:

def manage_books(request, author_id):
    author = Author.objects.get(pk=author_id)
    BookInlineFormSet = inlineformset_factory(Author, Book, fields=('title',))
    if request.method == "POST":
        formset = BookInlineFormSet(request.POST, request.FILES, instance=author)
        if formset.is_valid():
            formset.save()
            # Do something. Should generally end with a redirect. For example:
            return HttpResponseRedirect(author.get_absolute_url())
    else:
        formset = BookInlineFormSet(instance=author)
    return render(request, 'manage_books.html', {'formset': formset})

POSTGET いずれにおいても instance を渡していることに注目してください

インラインフォームにウィジェットを指定する

inlineformset_factorymodelformset_factory を使っており、多くの引数は modelformset_factory に渡されます。これは modelformset_factory と同様に、 widgets 引数を渡すことができることを意味しています。詳細は、上記 Specifying widgets to use in the form with widgets を参照してください。

Back to Top