Django admin.AdminSite クラス：モデル登録、ユーザー管理、ログ記録など

Django admin.AdminSite クラスの詳細解説

django.contrib.admin.AdminSite クラスは、Django の管理サイトの核となるクラスです。このクラスは、Django モデルの管理インターフェースを自動的に生成し、ユーザー管理、ログイン、ログアウトなどの機能を提供します。

主な機能

• モデルの登録と管理インターフェースの自動生成
• ユーザー管理機能 (ログイン、ログアウト、パスワード変更など)
• ログ記録と監査
• カスタマイズ可能なテンプレートとインターフェース

使い方

AdminSite クラスは、以下のコードのように直接インスタンス化できます。

from django.contrib.admin import AdminSite

site = AdminSite()

しかし、通常は django.contrib.admin モジュールからインポートされた site オブジェクトを使用します。

from django.contrib.admin import site

site オブジェクトは、以下のメソッドを提供しています。

• register(model, admin_class=None): モデルを管理インターフェースに登録
• unregister(model): モデルを管理インターフェースから削除
• get_model_admin(model): モデルの管理クラスを取得
• has_permission(request): 現在のユーザーが管理サイトにアクセスできるかどうかをチェック
• login(request): ユーザーをログイン
• logout(request): ユーザーをログアウト

カスタマイズ

AdminSite クラスは、以下の属性を介してカスタマイズできます。

• name: 管理サイトの名前
• index_title: 管理サイトのインデックスページのタイトル
• site_header: 管理サイトのヘッダー
• site_title: 管理サイトのタイトル
• login_form: ログインフォーム
• logout_template: ログアウトテンプレート
• password_change_form: パスワード変更フォーム
• password_change_template: パスワード変更テンプレート

AdminSite クラスの詳細については、以下の公式ドキュメントを参照してください。

補足

• 上記の情報は Django 3.2 を基にしています。他のバージョンでは、一部の機能や属性が異なる場合があります。
• AdminSite クラスは高度な機能を提供するため、初心者には難易度が高い場合があります。

AdminSite クラスについて何か質問があれば、遠慮なく聞いてください。

Django admin.AdminSite クラスのサンプルコード

モデルの登録

from django.contrib import admin
from .models import MyModel

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

admin.site.register(MyModel, MyModelAdmin)

カスタマイズ

from django.contrib import admin

class MyAdminSite(admin.AdminSite):
    site_header = 'My Custom Admin Site'

admin_site = MyAdminSite()

admin_site.register(MyModel, MyModelAdmin)

ユーザー管理

from django.contrib.auth import authenticate, login

def my_login_view(request):
    username = request.POST['username']
    password = request.POST['password']

    user = authenticate(username=username, password=password)

    if user is not None:
        login(request, user)
        return HttpResponseRedirect('/')
    else:
        return render(request, 'login.html', {'error': 'Invalid credentials'})

ログ記録

from django.contrib.admin.models import LogEntry

def log_entry_created(sender, instance, created, **kwargs):
    if created:
        LogEntry.objects.create(
            user=request.user,
            content_type=instance._meta.content_type,
            object_id=instance.pk,
            object_repr=str(instance),
            action_flag=LogEntry.ADDITION,
        )

post_save.connect(log_entry_created, sender=MyModel)

テンプレート

{% extends "admin/base.html" %}

{% block title %}My Admin Site{% endblock %}

{% block branding %}
<h1 id="site-name"><a href="{% url 'admin:index' %}">My Admin Site</a></h1>
{% endblock %}

{% block content %}
<div id="content-main">
    <h1>My Model</h1>
    <ul>
        {% for object in object_list %}
        <li>{{ object.name }}</li>
        {% endfor %}
    </ul>
</div>
{% endblock %}

• 上記のコードはほんの一例です。AdminSite クラスは非常に多機能なため、さまざまな方法でカスタマイズできます。
• 詳細については、公式ドキュメントを参照してください。

Django admin.AdminSite クラスのカスタマイズ方法

サブクラス化

AdminSite クラスをサブクラス化し、属性やメソッドをオーバーライドすることで、管理サイトの動作を変更できます。

from django.contrib import admin

class MyAdminSite(admin.AdminSite):
    site_header = 'My Custom Admin Site'

    def has_permission(self, request):
        # 独自のパーミッションチェックロジック
        return True

admin_site = MyAdminSite()

admin_site.register(MyModel, MyModelAdmin)

デコレータ

admin_site デコレータを使用して、AdminSite クラスのインスタンスに属性やメソッドをバインドできます。

from django.contrib import admin

@admin_site.register(MyModel)
class MyModelAdmin:
    list_display = ('name', 'email', 'created_at')

@admin_site.login_form
def my_login_form(request):
    # 独自のログインフォーム
    pass

シグナル

admin_site シグナルを使用して、AdminSite クラスのインスタンスが作成された後に処理を実行できます。

from django.contrib import admin
from django.dispatch import receiver

@receiver(admin_site.ready)
def on_admin_site_ready(sender, **kwargs):
    # 独自の初期化処理
    pass

テンプレート

admin/base.html テンプレートをオーバーライドすることで、管理サイトの外観を変更できます。

{% extends "admin/base.html" %}

{% block title %}My Admin Site{% endblock %}

{% block branding %}
<h1 id="site-name"><a href="{% url 'admin:index' %}">My Admin Site</a></h1>
{% endblock %}

{% block content %}
<div id="content-main">
    <h1>My Model</h1>
    <ul>
        {% for object in object_list %}
        <li>{{ object.name }}</li>
        {% endfor %}
    </ul>
</div>
{% endblock %}

AdminSite クラスについて何か質問があれば、遠慮なく聞いてください。