Django admin の達人になる: prepopulated_fields をマスターしよう

Django admin.ModelAdmin.prepopulated_fields 解説

django.contrib.admin の admin.ModelAdmin.prepopulated_fields は、Django管理画面でモデル編集時に特定のフィールドを自動的に設定するための機能です。これは、他のフィールド値に基づいてフィールド値を自動的に生成したい場合に役立ちます。

仕組み

prepopulated_fields は、モデルフィールド名のリストを受け取り、各フィールドに対して、その値を生成するために呼び出される関数を指定します。この関数は、モデルインスタンスと関連するフィールドを受け取り、フィールド値を返す必要があります。

例

以下の例では、slug フィールドを title フィールドに基づいて自動的に生成します。

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': ('title',)}

    def get_prepopulated_fields(self, request, obj=None):
        if obj is None:
            return self.prepopulated_fields
        else:
            return {}

この例では、get_prepopulated_fields メソッドがオーバーライドされており、obj が None の場合のみ prepopulated_fields を返しています。これは、slug フィールドを新規作成時にのみ自動生成するためです。

その他の機能

• 複数のフィールドを生成したい場合は、カンマ区切りのフィールド名リストを渡すことができます。
• 関数ではなく、文字列を渡すこともできます。この場合、文字列はフィールド名として評価されます。
• callable オブジェクトを渡すこともできます。

注意点

• prepopulated_fields は、空のフォームに対してのみ機能します。
• 生成された値は、モデルのバリデーションの前に設定されます。
• 生成された値は、モデルの保存前に変更することができます。

Django admin.ModelAdmin.prepopulated_fields サンプルコード

title フィールドに基づいて slug フィールドを生成する

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': ('title',)}

title と author フィールドに基づいて slug フィールドを生成する

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': ('title', 'author',)}

カスタム関数を使用して slug フィールドを生成する

def generate_slug(model_instance, field_name):
    return '-'.join(model_instance.title.split())

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': (generate_slug,)}

get_prepopulated_fields メソッドを使用して動的に prepopulated_fields を設定する

class MyModelAdmin(admin.ModelAdmin):
    def get_prepopulated_fields(self, request, obj=None):
        if obj is None:
            return {'slug': ('title',)}
        else:
            return {}

prepopulated_fields を使用して readonly_fields を設定する

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': ('title',)}
    readonly_fields = ('slug',)

prepopulated_fields を使用して list_display を設定する

class MyModelAdmin(admin.ModelAdmin):
    prepopulated_fields = {'slug': ('title',)}
    list_display = ('title', 'slug',)

Django admin.ModelAdmin.prepopulated_fields 以外の方法

シグナルを使用する

prepopulated_fields の代わりに、post_save シグナルを使用して、モデル保存後にフィールドを自動的に設定することができます。

from django.db.models.signals import post_save

def generate_slug(sender, instance, **kwargs):
    instance.slug = '-'.join(instance.title.split())
    instance.save()

post_save.connect(generate_slug, sender=MyModel)

モデルメソッドを使用する

prepopulated_fields の代わりに、モデルにカスタムメソッドを追加して、フィールド値を生成することができます。

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    slug = models.SlugField(max_length=255)

    def generate_slug(self):
        self.slug = '-'.join(self.title.split())
        self.save()

JavaScriptを使用する

prepopulated_fields の代わりに、JavaScript を使用して、クライアント側でフィールド値を自動的に設定することができます。

$(document).ready(function() {
    $('#title').on('change', function() {
        var slug = $('#title').val().replace(/\s+/g, '-');
        $('#slug').val(slug);
    });
});

• prepopulated_fields は、シンプルで使いやすい方法です。
• シグナルは、より柔軟な方法です。
• モデルメソッドは、よりコードが読みやすい方法です。
• JavaScript は、より高度なカスタマイズが可能な方法です。

admin.ModelAdmin.prepopulated_fields は、Django 管理画面でモデル編集時に特定のフィールドを自動的に設定するための便利な機能です。

prepopulated_fields 以外にも、いくつかの方法がありますので、要件と開発者の好みによって最適な方法を選択してください。