Django admin.ModelAdmin.history_view() でできること

Django admin.ModelAdmin.history_view() 解説

django.contrib.admin.ModelAdmin.history_view() は、Django 管理サイトでモデルの変更履歴を表示するためのビュー関数です。

機能

このビューは、以下の機能を提供します。

• モデルの変更履歴の一覧表示
• 特定の変更履歴の詳細表示
• 変更履歴の比較
• 変更履歴の復元

使い方

history_view() を使用するには、以下の手順が必要です。

1. モデル管理クラス (ModelAdmin) で history_view() メソッドをオーバーライドします。
2. メソッド内で、変更履歴を表示するテンプレートを指定します。
3. テンプレートで、history_list 変数を使用して変更履歴の一覧を表示します。

テンプレート

history_view() で指定したテンプレートには、以下の変数が渡されます。

• history_list: 変更履歴のリスト
• model_admin: モデル管理クラス
• admin_form: 変更履歴のフォーム

変更履歴の復元

history_view() では、変更履歴を復元することもできます。

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def history_view(self, request, object_id, extra_context=None):
        return super().history_view(
            request,
            object_id,
            extra_context={
                'template_name': 'admin/my_model_history.html',
            },
        )

# admin.site.register(MyModel, MyModelAdmin)

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

{% block title %}変更履歴{% endblock %}

{% block content %}
<h1>変更履歴</h1>

<ul>
{% for history in history_list %}
<li>
    {% if history.user %}
    変更者: {{ history.user.username }}
    {% else %}
    変更者: システム
    {% endif %}
    <br>
    変更日時: {{ history.change_date }}
    <br>
    変更内容:
    <ul>
    {% for field in history.changed_fields %}
    <li>{{ field }}: {{ history.old_value_dict.get(field) }} → {{ history.new_value_dict.get(field) }}</li>
    {% endfor %}
    </ul>
</li>
{% endfor %}
</ul>
{% endblock %}

補足

• history_view() は、モデルに django.contrib.contenttypes.models.ContentType フィールドが追加されている必要があります。
• history_view() は、django.contrib.admin.sites アプリケーションがインストールされている必要があります。

django.contrib.admin.ModelAdmin.history_view() は、モデルの変更履歴を表示するための便利なビュー関数です。

Django admin.ModelAdmin.history_view() サンプルコード集

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def history_view(self, request, object_id, extra_context=None):
        return super().history_view(
            request,
            object_id,
            extra_context={
                'template_name': 'admin/my_model_history.html',
            },
        )

# admin.site.register(MyModel, MyModelAdmin)

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

{% block title %}変更履歴{% endblock %}

{% block content %}
<h1>変更履歴</h1>

<ul>
{% for history in history_list %}
<li>
    {% if history.user %}
    変更者: {{ history.user.username }}
    {% else %}
    変更者: システム
    {% endif %}
    <br>
    変更日時: {{ history.change_date }}
    <br>
    <a href="{% url 'admin:history_view' app_label=history.app_label model_name=history.model_name object_id=history.object_id history_id=history.id %}">詳細</a>
</li>
{% endfor %}
</ul>
{% endblock %}

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

{% block title %}変更履歴詳細{% endblock %}

{% block content %}
<h1>変更履歴詳細</h1>

<ul>
{% for field in history.changed_fields %}
<li>{{ field }}: {{ history.old_value_dict.get(field) }} → {{ history.new_value_dict.get(field) }}</li>
{% endfor %}
</ul>
{% endblock %}

変更履歴の比較

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def history_view(self, request, object_id, extra_context=None):
        return super().history_view(
            request,
            object_id,
            extra_context={
                'template_name': 'admin/my_model_history_compare.html',
            },
        )

# admin.site.register(MyModel, MyModelAdmin)

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

{% block title %}変更履歴比較{% endblock %}

{% block content %}
<h1>変更履歴比較</h1>

<form action="{% url 'admin:history_view' app_label=history.app_label model_name=history.model_name object_id=history.object_id %}" method="post">
{% csrf_token %}
<input type="hidden" name="history_id" value="{{ history.id }}">

<p>比較対象となる変更履歴を選択してください:</p>

<select name="compare_history_id">
{% for other_history in history_list %}
{% if other_history.id != history.id %}
<option value="{{ other_history.id }}">{{ other_history.change_date }}</option>
{% endif %}
{% endfor %}
</select>

<input type="submit" value="比較">
</form>

{% if compare_history %}
<h2>変更履歴比較</h2>

<ul>
{% for field in history.changed_fields %}
{% if field in compare_history.changed_fields %}
<li>{{ field }}:
    <ul>
        <li>{{ history.old_value_dict.get(field) }}</li>
        <li>{{ compare_history.old_value_dict.get(field) }}</li>
    </ul>
    →
    <ul>
        <li>{{ history.new_value_dict.get(field) }}</li>
        <li>{{ compare_history.new_value_dict.get(field) }}</li>
    </ul>
</li>
{% endif %}
{% endfor %}
</ul>
{% endif %}
{% endblock %}

変更履歴の復元

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def history_view(self, request, object_id, extra_context=None):
        return super().history_view(
            request,
            object_id,
            extra_context={
                'template_name': 'admin/my_model_history_revert

Django モデルの変更履歴を表示するその他の方法

django.contrib.admin.ModelAdmin.history_view() を使用せずに、自作ビューを作成して変更履歴を表示することもできます。

メリット

• より柔軟な表示形式を実現できる
• 他の機能と統合できる

デメリット

• 開発コストが高くなる
• Django 管理サイトの機能を利用できない

第三者ライブラリ

変更履歴を表示するための第三者ライブラリも存在します。

メリット

• 開発コストを抑えられる
• 豊富な機能を利用できる

デメリット

• ライブラリのメンテナンス状況によっては、使い続けるのが難しい場合がある

コマンドラインツール

./manage.py dumpdata コマンドを使用して、モデルのデータをダンプし、変更履歴を確認することもできます。

メリット

• 特別な準備が不要

デメリット

• 見づらい
• 操作が複雑

Django モデルの変更履歴を表示するには、いくつかの方法があります。 それぞれの方法にはメリットとデメリットがあるので、要件に合わせて最適な方法を選択する必要があります。