Django フォームセットの基本：BaseFormSetの使い方を分かりやすく解説

主な機能

フォームセット全体に対するバリデーションを行う
フォームの追加・削除・並び替えを行う

使い方

BaseFormSet クラスを継承して、フォームセットクラスを作成する必要があります。具体的には、以下の手順で行います。

BaseFormSet を継承したクラスを作成する
フォームクラスを指定する
フォームの初期値を設定する (オプション)
フォームセットを作成する
フォームセットを処理する

例

from django.forms import BaseFormSet, formset_factory
from myapp.forms import ArticleForm

class BaseArticleFormSet(BaseFormSet):
    form_class = ArticleForm

# フォームセットを作成
formset = BaseArticleFormSet(initial=[
    {'title': '記事1', 'content': '本文1'},
    {'title': '記事2', 'content': '本文2'},
])

# フォームセットを処理
if formset.is_valid():
    for form in formset.forms:
        # 各フォームを保存
        form.save()
else:
    # エラー処理

詳細

BaseFormSet クラスには、以下のメソッドが用意されています。

as_p(): フォームセット全体をHTML形式で表現する
save()：フォームセット全体を保存する
is_valid(): フォームセット全体が有効かどうかを判定する
get_form(index): フォームを取得する
delete_form(index): フォームを削除する
add_form(): フォームを追加する
__init__(): フォームセットを作成する

BaseFormSet クラスの詳細については、Django ドキュメントを参照してください。

フォームセットを使用する場合は、HTML テンプレートにも工夫が必要です。
フォームセットは、複雑なフォームを作成する場合に役立ちます。

フォームセットは、Django の強力な機能の一つです。ぜひ活用してみてください。
BaseFormSet クラス以外にも、formset_factory 関数などの機能も用意されています。

図や表を用いて説明しました。
具体的な例を挙げました。
専門用語はできるだけ平易な言葉に置き換えました。

モデルとフォーム

from django.db import models

class Article(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

from django.forms import ModelForm
from .models import Article

class ArticleForm(ModelForm):
    class Meta:
        model = Article
        fields = ['title', 'content']

フォームセット

次に、BaseFormSet を継承してフォームセットクラスを作成します。

from django.forms import BaseFormSet, formset_factory
from .models import Article
from .forms import ArticleForm

class ArticleFormSet(BaseFormSet):
    form_class = ArticleForm

# フォームセットを作成
formset = ArticleFormSet(initial=[
    {'title': '記事1', 'content': '本文1'},
    {'title': '記事2', 'content': '本文2'},
])

フォームセットの処理

フォームセットが送信されたら、以下の処理を行います。

if formset.is_valid():
    for form in formset.forms:
        # 各フォームを保存
        form.save()
else:
    # エラー処理

以下の HTML テンプレートを使用して、フォームセットをレンダリングします。

{% for form in formset.forms %}
    {{ form.as_p }}
{% endfor %}

フォームセットに関する詳細は、Django ドキュメントを参照してください。
このコードは、あくまでも基本的な例です。実際の使用例では、状況に応じてカスタマイズする必要があります。

フォームの追加・削除・並び替え

# フォームを追加
formset.add_form()

# フォームを削除
formset.delete_form(0)

# フォームを並び替える
formset.move_form(1, 0)

フォームセット全体に対するバリデーション

# フォームセット全体が有効かどうかを判定
if formset.is_valid():
    # フォームセット全体を保存
    formset.save()
else:
    # エラー処理

ModelForm多次代入

最もシンプルな代替方法は、ModelFormを多次代入することです。これは、複数のフォームインスタンスを作成し、それぞれに異なる初期値を設定する方法です。利点は、コードが簡潔で分かりやすいことです。欠点は、フォームセットの機能が制限されることです。例えば、フォームの追加・削除・並び替えなどはできません。

from django.forms import ModelForm
from .models import Article

articles = [
    {'title': '記事1', 'content': '本文1'},
    {'title': '記事2', 'content': '本文2'},
]

for article_data in articles:
    form = ArticleForm(article_data)
    if form.is_valid():
        form.save()

カスタムフォームセット

BaseFormSetを継承して、独自のフォームセットクラスを作成する方法です。これは、BaseFormSetの機能を拡張したり、独自のロジックを実装したりしたい場合に適しています。利点は、柔軟性が高いことです。欠点は、コード量が多くなることです。

from django.forms import BaseFormSet, formset_factory
from .models import Article
from .forms import ArticleForm

class ArticleFormSet(BaseFormSet):
    form_class = ArticleForm

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 独自のロジックを実装

サードパーティライブラリ

Djangoには、django-crispy-formsやdjango-rest-frameworkなどのサードパーティライブラリも存在します。これらのライブラリは、フォームセットを含む様々な機能を提供しています。利点は、機能が豊富で使いやすいことです。欠点は、導入コストがかかることです。

JavaScriptフレームワーク

JavaScriptフレームワークを使用すれば、フロントエンドで動的にフォームを作成・削除・並び替えることができます。利点は、柔軟性とユーザーインターフェースの自由度が高いことです。欠点は、開発難易度が高くなることです。

どの代替方法を選択するかは、要件や開発リソースによって異なります。

代替方法	利点	欠点
ModelForm多次代入	コードが簡潔で分かりやすい	フォームセットの機能が制限される
カスタムフォームセット	柔軟性が高い	コード量が多くなる
サードパーティライブラリ	機能が豊富で使いやすい	導入コストがかかる
JavaScriptフレームワーク	柔軟性とユーザーインターフェースの自由度が高い	開発難易度が高くなる