Django admin の ModelAdmin.save_formset() メソッドを徹底解説

Django admin.ModelAdmin.save_formset() 解説

django.contrib.admin の ModelAdmin クラスには、save_formset() というメソッドがあります。これは、インライン編集フォームセットの保存処理を担当します。

インライン編集フォームセットとは

Django admin では、モデルと関連するモデルをまとめて編集できる機能があります。これをインライン編集と呼びます。インライン編集で扱うフォームセットを、インライン編集フォームセットと呼びます。

save_formset() メソッドは、インライン編集フォームセットのデータを受け取り、以下の処理を行います。

1. 各フォームの検証
2. 有効なフォームのデータに基づいて、関連するモデルの保存
3. 無効なフォームのエラーメッセージ表示

save_formset() メソッドは以下の引数を受け取ります。

• request: HTTP リクエストオブジェクト
• formset: インライン編集フォームセット
• change: 編集対象のモデルインスタンス
• kwargs: 追加のキーワード引数

save_formset() メソッドは、以下の順序で処理を行います。

1. フォームセットの各フォームを検証します。
2. すべてのフォームが有効であれば、以下の処理を行います。
   • フォームデータに基づいて、関連するモデルインスタンスを作成または更新します。
   • モデルインスタンスを保存します。
3. フォームセットに無効なフォームがあれば、以下の処理を行います。
   • エラーメッセージをユーザーに表示します。
   • モデルインスタンスは保存されません。

save_formset() のオーバーライド

save_formset() メソッドは、ModelAdmin クラスでオーバーライドすることができます。オーバーライドすることで、保存処理のカスタマイズを行うことができます。

例

以下の例は、save_formset() メソッドをオーバーライドして、保存前にカスタム処理を行う例です。

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        # 保存前にカスタム処理を行う
        for form in formset.forms:
            if form.cleaned_data['my_field'] == 'foo':
                form.cleaned_data['my_field'] = 'bar'

        # 元の save_formset() メソッドを呼び出す
        super().save_formset(request, formset, change, **kwargs)

django.contrib.admin.ModelAdmin.save_formset() メソッドは、インライン編集フォームセットの保存処理を担当します。このメソッドを理解することで、インライン編集機能のカスタマイズを行うことができます。

Django admin.ModelAdmin.save_formset() サンプルコード集

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        # 保存前にカスタム処理を行う
        for form in formset.forms:
            if form.cleaned_data['my_field'] == 'foo':
                form.cleaned_data['my_field'] = 'bar'

        # 元の save_formset() メソッドを呼び出す
        super().save_formset(request, formset, change, **kwargs)

関連モデルをさらに編集する

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        # 保存処理
        super().save_formset(request, formset, change, **kwargs)

        # 関連モデルをさらに編集
        for obj in formset.saved_objects:
            obj.my_field = 'bar'
            obj.save()

特定のフォームのみ保存する

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        # 特定のフォームのみ保存
        for form in formset.forms:
            if form.cleaned_data['my_field'] == 'foo':
                form.save()

        # その他のフォームは保存しない

フォームエラー時の処理

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        try:
            # 保存処理
            super().save_formset(request, formset, change, **kwargs)
        except ValidationError as e:
            # フォームエラー時の処理
            messages.error(request, str(e))

ログ出力

class MyModelAdmin(admin.ModelAdmin):
    def save_formset(self, request, formset, change, **kwargs):
        # ログ出力
        logger.info('Saving formset: %s', formset)

        # 保存処理
        super().save_formset(request, formset, change, **kwargs)

上記のサンプルコードはあくまでも例です。実際のユースケースに合わせて、自由にカスタマイズしてください。

Django admin.ModelAdmin.save_formset() 以外の方法

• 複雑なカスタマイズが必要な場合
• 保存処理をより細かく制御したい場合

フォームセットを直接操作する

save_formset() メソッドを使用せずに、フォームセットを直接操作することで、より細かい制御が可能になります。

formset = inline_formset_factory(parent_model, child_model, ...)

# フォームの検証
for form in formset.forms:
    form.is_valid()

# 有効なフォームのデータに基づいて、関連するモデルインスタンスを作成または更新
for form in formset.cleaned_forms:
    obj = form.save()

# モデルインスタンスを保存
for obj in formset.saved_objects:
    obj.save()

# 無効なフォームのエラーメッセージ表示
for form in formset.errors:
    messages.error(request, form.errors)

カスタムビューを作成する

ModelAdmin クラスの代わりに、カスタムビューを作成することで、保存処理を完全にカスタマイズすることができます。

def my_view(request, pk):
    # 親モデルのインスタンスを取得
    parent_model = get_object_or_404(ParentModel, pk=pk)

    # フォームセットを作成
    formset = inline_formset_factory(parent_model, child_model, ...)

    # フォームの処理
    if request.method == 'POST':
        formset = inline_formset_factory(parent_model, child_model, data=request.POST)

        if formset.is_valid():
            # 保存処理
            ...

            # リダイレクト
            return HttpResponseRedirect(...)

    # テンプレートをレンダリング
    return render(request, 'my_template.html', {'formset': formset})

django.contrib.admin.ModelAdmin.save_formset() メソッドは、多くの場合、インライン編集フォームセットの保存処理を行う便利な方法です。しかし、複雑なカスタマイズが必要な場合や、保存処理をより細かく制御したい場合は、他の方法を検討する必要があります。