Django admin.autodiscover() を使って管理画面をカスタマイズしよう

Django の admin.autodiscover() の解説

仕組み

admin.autodiscover() は、以下の手順で動作します。

1. INSTALLED_APPS 設定に登録されているアプリを全て走査します。
2. 各アプリの admin.py ファイルが存在するかどうかを確認します。
3. 存在する場合は、そのファイルを読み込み、admin.site.register() で登録されているモデルを全て管理サイトに登録します。

利点

admin.autodiscover() を使用すると、以下の利点があります。

• 個別にモデルを登録する必要がないため、コード量が少なくなります。
• アプリを追加・削除した際に、管理サイトの登録も自動的に更新されます。

注意点

admin.autodiscover() を使用する場合、以下の点に注意する必要があります。

• admin.py ファイル名は、admin である必要があります。
• admin.py ファイルは、アプリのルートディレクトリに配置する必要があります。
• モデルを管理サイトに登録する場合は、admin.site.register() を使用する必要があります。

例

以下は、admin.autodiscover() を使用してモデルを管理サイトに登録する例です。

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

admin.site.register(MyModel)

上記の場合、admin.autodiscover() は myapp/admin.py ファイルを自動的に検出し、MyModel モデルを管理サイトに登録します。

補足

• admin.autodiscover() は、開発環境でのみ使用することを推奨します。
• 本番環境では、セキュリティ上の理由から、個別にモデルを登録することを推奨します。
• admin.autodiscover() の動作をカスタマイズしたい場合は、ModelAdmin クラスの autodiscover() メソッドをオーバーライドすることができます。

Django admin.autodiscover() のサンプルコード

基本的なサンプル

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

admin.site.register(MyModel)

ModelAdmin クラスの利用

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

class MyModelAdmin(admin.ModelAdmin):
    list_display = ('name',)

admin.site.register(MyModel, MyModelAdmin)

上記は、ModelAdmin クラスを使用して、MyModel モデルの管理画面をカスタマイズする例です。

インラインモデルの利用

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

class RelatedModel(models.Model):
    name = models.CharField(max_length=255)
    my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel, RelatedModel

class MyModelAdmin(admin.ModelAdmin):
    inlines = [
        RelatedModelAdmin,
    ]

admin.site.register(MyModel, MyModelAdmin)

class RelatedModelAdmin(admin.ModelAdmin):
    list_display = ('name',)

上記は、インラインモデルを使用して、MyModel モデルと RelatedModel モデルを関連付ける例です。

カスタムフィルターの利用

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

class MyModelFilter(admin.SimpleListFilter):
    title = 'My filter'
    parameter_name = 'my_filter'

    def lookups(self, request, model_admin):
        return (
            ('active', 'Active'),
            ('inactive', 'Inactive'),
        )

    def queryset(self, request, queryset):
        if self.value() == 'active':
            return queryset.filter(is_active=True)
        elif self.value() == 'inactive':
            return queryset.filter(is_active=False)
        return queryset

admin.site.register(MyModel, MyModelAdmin)

class MyModelAdmin(admin.ModelAdmin):
    list_display = ('name',)
    list_filter = (MyModelFilter,)

上記は、カスタムフィルターを使用して、MyModel モデルのリストをフィルタリングする例です。

Django でモデルを管理サイトに登録する他の方法

個別にモデルを登録する

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

admin.site.register(MyModel)

上記のように、admin.site.register() 関数を使用して、個別にモデルを登録することができます。

ModelAdmin クラスを使用する

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

class MyModelAdmin(admin.ModelAdmin):
    list_display = ('name',)

admin.site.register(MyModel, MyModelAdmin)

上記のように、ModelAdmin クラスを作成して、そのクラスを admin.site.register() 関数の 2 番目の引数に渡すことで、モデルの管理画面をカスタマイズすることができます。

インラインモデルを使用する

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

class RelatedModel(models.Model):
    name = models.CharField(max_length=255)
    my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel, RelatedModel

class MyModelAdmin(admin.ModelAdmin):
    inlines = [
        RelatedModelAdmin,
    ]

admin.site.register(MyModel, MyModelAdmin)

class RelatedModelAdmin(admin.ModelAdmin):
    list_display = ('name',)

上記のように、インラインモデルを使用して、関連するモデルをまとめて編集することができます。

カスタムアクションを使用する

# myapp/models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

# myapp/admin.py
from django.contrib import admin

from .models import MyModel

def my_action(modeladmin, request, queryset):
    # 何か処理を行う

class MyModelAdmin(admin.ModelAdmin):
    actions = [my_action]

admin.site.register(MyModel, MyModelAdmin)

上記のように、カスタムアクションを作成して、管理画面に追加することができます。

• モデルのจำนวน
• モデルの複雑さ
• 管理画面のカスタマイズレベル

モデル数が少なく、複雑なカスタマイズを行わない場合は、admin.autodiscover() を使用するのが簡単です。

モデル数が多い場合や、複雑なカスタマイズを行う場合は、個別にモデルを登録したり、ModelAdmin クラスを使用したりするのがおすすめです。