Django "django.contrib.admin" の "admin.apps.AdminConfig" を使った管理サイトのカスタマイズ

Django の "django.contrib.admin" に関連する "admin.apps.AdminConfig" の詳細解説

"django.contrib.admin" は、Django プロジェクトに管理インターフェースを提供するモジュールです。 "admin.apps.AdminConfig" は、このモジュールの重要な部分であり、以下の機能を提供します。

• アプリケーションの自動検出
• 管理サイトのカスタマイズ
• モデル管理の動作設定

この解説では、 "admin.apps.AdminConfig" の役割と使用方法について詳しく説明します。

アプリケーションの自動検出

"AdminConfig" は、INSTALLED_APPS 設定に登録された各アプリケーションを自動的に検査し、管理インターフェースに登録します。 以下の条件を満たすモデルは自動的に登録されます。

• models.Model を継承している
• admin.ModelAdmin クラスで管理されている

管理サイトのカスタマイズ

"AdminConfig" をサブクラス化することで、管理サイトの外観と動作をカスタマイズできます。 以下の属性をオーバーライドすることで、さまざまな設定を変更できます。

• default_site: 既定の管理サイトオブジェクト
• title: 管理サイトのタイトル
• index_title: 管理サイトのインデックスページのタイトル
• site_header: 管理サイトのヘッダー
• app_list: 管理サイトに表示されるアプリのリスト
• model_admin: モデル管理クラスの辞書

モデル管理の動作設定

"AdminConfig" をサブクラス化することで、モデル管理の動作をカスタマイズできます。 以下のメソッドをオーバーライドすることで、さまざまな設定を変更できます。

• get_actions: モデル管理ページで利用可能なアクションを定義
• get_form: モデル編集ページのフォームを定義
• get_list_display: モデル一覧ページで表示する列を定義
• get_list_filter: モデル一覧ページで利用可能なフィルタを定義
• get_search_fields: モデル検索で利用可能なフィールドを定義

使用例

以下は、 "AdminConfig" をサブクラス化して管理サイトをカスタマイズする例です。

from django.contrib.admin.apps import AdminConfig

class MyAdminConfig(AdminConfig):
    default_site = 'myproject.admin.MyAdminSite'
    title = 'My Project Administration'
    index_title = 'Welcome to My Project'

    def get_app_list(self, request):
        """
        管理サイトに表示されるアプリのリストをカスタマイズ
        """
        app_list = super().get_app_list(request)
        app_list.remove('auth') # 認証アプリを非表示
        return app_list

この例では、以下のカスタマイズを行っています。

• 既定の管理サイトクラスを myproject.admin.MyAdminSite に設定
• 管理サイトのタイトルを "My Project Administration" に設定
• 管理サイトのインデックスページのタイトルを "Welcome to My Project" に設定
• 管理サイトから "auth" アプリを非表示

補足

• "admin.apps.AdminConfig" は、高度な機能を提供する強力なツールです。
• カスタマイズを行う場合は、Django ドキュメントをよく読んで理解してから行ってください。
• 間違った設定を行うと、管理インターフェースが正常に動作しなくなる可能性があります。

"django.contrib.admin" には、 "admin.apps.AdminConfig" 以外にも多くの機能が用意されています。 詳細については、Django ドキュメントを参照してください。

Django "django.contrib.admin" の "admin.apps.AdminConfig" サンプルコード集

以下のサンプルコードは、 INSTALLED_APPS 設定に登録された各アプリケーションのモデルを自動的に管理インターフェースに登録します。

# settings.py

INSTALLED_APPS = [
    # ...
    'myapp',
]

# myapp/models.py

from django.db import models

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

上記の設定で、 myapp アプリの MyModel モデルは自動的に管理インターフェースに登録されます。

管理サイトのカスタマイズ

以下のサンプルコードは、 "AdminConfig" をサブクラス化して管理サイトをカスタマイズします。

from django.contrib.admin.apps import AdminConfig

class MyAdminConfig(AdminConfig):
    default_site = 'myproject.admin.MyAdminSite'
    title = 'My Project Administration'
    index_title = 'Welcome to My Project'

    def get_app_list(self, request):
        """
        管理サイトに表示されるアプリのリストをカスタマイズ
        """
        app_list = super().get_app_list(request)
        app_list.remove('auth') # 認証アプリを非表示
        return app_list

# settings.py

ADMIN_CONFIG = 'myproject.admin.MyAdminConfig'

上記の設定で、以下のカスタマイズが行われます。

モデル管理の動作設定

以下のサンプルコードは、 "AdminConfig" をサブクラス化してモデル管理の動作をカスタマイズします。

from django.contrib.admin.apps import AdminConfig

class MyAdminConfig(AdminConfig):
    default_site = 'myproject.admin.MyAdminSite'

    def get_list_display(self, model):
        """
        モデル一覧ページで表示する列をカスタマイズ
        """
        if model == MyModel:
            return ('id', 'name', 'created_at')
        return super().get_list_display(model)

# settings.py

ADMIN_CONFIG = 'myproject.admin.MyAdminConfig'

上記の設定で、 MyModel モデルの管理一覧ページでは、id、name、created_at 列が表示されます。

その他

上記のサンプルコード以外にも、 "admin.apps.AdminConfig" を使用してさまざまなカスタマイズを行うことができます。 詳細については、Django ドキュメントを参照してください。

Django "django.contrib.admin" の "admin.apps.AdminConfig" 以外の方法

管理サイトのテンプレートをカスタマイズ

管理インターフェースのテンプレートをカスタマイズすることで、外観やレイアウトを変更できます。 テンプレートは、 django/contrib/admin/templates ディレクトリにあります。

カスタム管理アクションを作成することで、モデル管理ページに追加の機能を追加できます。 詳細については、Django ドキュメントを参照してください。

カスタムModelAdminクラスを作成することで、モデル管理ページの動作を大幅にカスタマイズできます。 詳細については、Django ドキュメントを参照してください。

サードパーティ製のライブラリを使用

Django の管理インターフェースを拡張するサードパーティ製のライブラリが多数存在します。 これらのライブラリを使用することで、さまざまな機能を追加できます。

各方法のメリットとデメリット

どの方法を選択するべきかは、カスタマイズしたい内容と開発者のスキルレベルによって異なります。

上記以外にも、Django の管理インターフェースをカスタマイズする方法があります。 詳細については、Django ドキュメントやサードパーティ製ライブラリのドキュメントを参照してください。