Django admin.InlineModelAdmin.max_num 属性詳細解説

Django admin.InlineModelAdmin.max_num 詳細解説

django.contrib.admin モジュールの admin.InlineModelAdmin.max_num は、インライン編集フォームで同時に編集できる関連オブジェクトの最大数を設定する属性です。

デフォルト値は 3 です。

設定例

class MyInlineModelAdmin(admin.InlineModelAdmin):
    max_num = 5

# これで、関連オブジェクトを最大5つまで同時に編集できます。

詳細

• max_num は、以下の条件を満たす必要があります。
  • 0 以上であること
  • 関連オブジェクトモデルの _meta.max_inline_count 以下であること
• max_num を設定すると、以下の影響があります。
  • インライン編集フォームには、最大 max_num 個の入力欄が表示されます。
  • 関連オブジェクトが max_num 個を超えている場合、フォームの下部に「追加」ボタンが表示されます。
  • 「追加」ボタンをクリックすると、新しい入力欄が表示されます。
• max_num は、readonly_fields や exclude 属性と組み合わせて使用できます。

補足

• max_num は、パフォーマンスに影響を与える可能性があります。関連オブジェクトが多い場合は、max_num の値を小さく設定することをお勧めします。
• max_num は、ユーザーインターフェースにも影響を与えます。max_num の値が大きい場合は、インライン編集フォームが長くなり、使いにくくなる可能性があります。

応用例

• 1つの記事に対して、3つまでの画像を編集できるようにする
• 1つの商品に対して、5つまでのオプションを編集できるようにする

• max_num は、ModelAdmin クラスの属性として設定するだけでなく、inline_formsets 引数で設定することもできます。

例

def my_view(request):
    # max_num を 5 に設定して、インライン編集フォームを作成します。
    inline_formsets = [
        (
            MyInlineModelAdmin(
                model=MyModel,
                extra=0,
                max_num=5,
            ),
            {'formset': MyFormSet},
        )
    ]

    return render(request, 'my_template.html', {'inline_formsets': inline_formsets})

以上、django.contrib.admin モジュールの admin.InlineModelAdmin.max_num 属性についての解説でした。

admin.InlineModelAdmin.max_num サンプルコード集

class MyInlineModelAdmin(admin.InlineModelAdmin):
    max_num = 5

# これで、関連オブジェクトを最大5つまで同時に編集できます。

readonly_fields と組み合わせて使用

class MyInlineModelAdmin(admin.InlineModelAdmin):
    max_num = 5
    readonly_fields = ('title',)

# これで、関連オブジェクトを最大5つまで編集できますが、
# タイトルフィールドは編集不可になります。

exclude と組み合わせて使用

class MyInlineModelAdmin(admin.InlineModelAdmin):
    max_num = 5
    exclude = ('description',)

# これで、関連オブジェクトを最大5つまで編集できますが、
# 説明フィールドは編集できません。

inline_formsets 引数で設定

def my_view(request):
    # max_num を 5 に設定して、インライン編集フォームを作成します。
    inline_formsets = [
        (
            MyInlineModelAdmin(
                model=MyModel,
                extra=0,
                max_num=5,
            ),
            {'formset': MyFormSet},
        )
    ]

    return render(request, 'my_template.html', {'inline_formsets': inline_formsets})

get_max_num メソッドを使って動的に設定

class MyInlineModelAdmin(admin.InlineModelAdmin):
    def get_max_num(self, request):
        # ログインユーザーによって最大編集数を制限
        if request.user.is_superuser:
            return None
        return 3

# これで、スーパーユーザーは関連オブジェクトを無制限に編集できますが、
# その他のユーザーは最大3つまでしか編集できません。

カスタマイズしたフォームセットを使用

class MyFormSet(BaseInlineFormSet):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # フォームセットの初期値を設定
        for form in self.forms:
            form.initial['extra_field'] = '初期値'

# これで、インライン編集フォームで `extra_field` フィールドに初期値を設定できます。

JavaScript を使って動的にフォームを追加

// JavaScript コード
const addFormButton = document.getElementById('add-form-button');
addFormButton.addEventListener('click', () => {
    // Ajax を使って新しいフォームを追加
    const xhr = new XMLHttpRequest();
    xhr.open('POST', '/admin/my_app/my_model/add/');
    xhr.onload = () => {
        // 新しいフォームを挿入
        const formElement = document.createElement('div');
        formElement.innerHTML = xhr.responseText;
        document.getElementById('inline-formset').appendChild(formElement);
    };
    xhr.send();
});

シグナルを使ってフォーム保存時に処理を行う

from django.db.models.signals import post_save

def my_post_save_handler(sender, instance, created, **kwargs):
    # フォーム保存時に処理を行う
    if created:
        # 関連オブジェクトを作成
        ...

# これで、インライン編集フォームで関連オブジェクトを作成できます。

admin.InlineModelAdmin.max_num 以外の方法

ModelAdmin クラスの list_max_show_all 属性を設定することで、関連オブジェクトの一覧画面で表示する最大件数を制限できます。

例

class MyModelAdmin(admin.ModelAdmin):
    list_max_show_all = 5

# これで、関連オブジェクトの一覧画面で最大5件まで表示されます。

CustomModelAdmin クラスを作成し、get_queryset() メソッドをオーバーライドすることで、関連オブジェクトのクエリセットをフィルタリングできます。

例

class MyCustomModelAdmin(admin.ModelAdmin):
    def get_queryset(self, request):
        # ログインユーザーによって表示する関連オブジェクトを制限
        if request.user.is_superuser:
            return super().get_queryset(request)
        return super().get_queryset(request).filter(author=request.user)

# これで、スーパーユーザーは全ての関連オブジェクトを表示できますが、
# その他のユーザーは自分自身が作成した関連オブジェクトのみを表示できます。

JavaScript を使って動的に表示件数を制限

// JavaScript コード
const tableBodyElement = document.getElementById('result_list');
const rows = tableBodyElement.getElementsByTagName('tr');
for (let i = rows.length - 1; i >= 5; i--) {
    // 5件以降の行を非表示
    rows[i].style.display = 'none';
}

シグナルを使って表示件数を制限

from django.db.models.signals import pre_get_results

def my_pre_get_results_handler(sender, queryset, **kwargs):
    # 関連オブジェクトのクエリセットをフィルタリング
    if queryset.model._meta.model_name == 'my_model':
        queryset.filter(author=request.user)

# これで、全てのユーザーは自分自身が作成した関連オブジェクトのみを表示できます。

別のアプリを使用する

関連オブジェクトを編集するための別のアプリを使用することもできます。

以上、admin.InlineModelAdmin.max_num 以外の方法でした。