Django admin.ModelAdmin.exclude を使いこなす：特定のユーザーグループのみ編集可能なフィールド、機密情報を含むフィールド、使用頻度の低いフィールドを除外する方法

Django admin.ModelAdmin.exclude の詳細解説

django.contrib.admin の ModelAdmin クラスには、exclude 属性があります。これは、モデル管理画面で編集または表示できないフィールドを指定するために使用されます。

使用方法

exclude 属性は、フィールド名のリストを受け取ります。例えば、以下のコードは MyModel モデルの name フィールドと age フィールドを管理画面から除外します。

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

詳細

• exclude 属性は、モデルのすべてのフィールドに適用されます。
• 複数のフィールドを除外するには、フィールド名をカンマで区切ります。
• exclude 属性は、readonly_fields 属性と組み合わせて使用できます。
• exclude 属性は、list_display 属性、search_fields 属性、filter_fields 属性などの他の属性にも影響を与える可能性があります。

例

• 特定のユーザーグループのみが編集できるフィールドを除外する
• 機密情報を含むフィールドを除外する
• 使用頻度の低いフィールドを除外する

注意事項

• exclude 属性は、モデルのフィールドを実際に削除するわけではないことに注意してください。
• exclude 属性を使用してフィールドを除外すると、そのフィールドのデータはデータベースに保存されません。
• exclude 属性を使用してフィールドを除外すると、そのフィールドの値を変更することはできません。

補足

• 上記の例では、MyModelAdmin クラスを直接使用しています。
• 多くの場合、ModelAdmin クラスを継承してカスタム管理クラスを作成します。
• カスタム管理クラスでは、exclude 属性を使用して、モデル管理画面をニーズに合わせてカスタマイズできます。

• exclude 属性は、モデル管理画面だけでなく、他の Django コンポーネントでも使用できます。
• 例えば、ModelChoiceField フォームフィールドの exclude 属性を使用して、選択可能な選択肢を制限できます。

admin.ModelAdmin.exclude に関する質問は、Django フォーラムまたは Stack Overflow で投稿できます。

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

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドと age フィールドを管理画面から除外します。

特定のユーザーグループのみが編集できるフィールドを除外する

from django.contrib import admin
from django.contrib.auth.models import User

class MyModelAdmin(admin.ModelAdmin):
    exclude = ('is_superuser', 'is_staff')

    def has_change_permission(self, request, obj=None):
        user = request.user
        if user.is_superuser:
            return True
        else:
            return False

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの is_superuser フィールドと is_staff フィールドを管理画面から除外します。ただし、スーパーユーザーはこれらのフィールドを編集できます。

機密情報を含むフィールドを除外する

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    exclude = ('password', 'credit_card_number')

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの password フィールドと credit_card_number フィールドを管理画面から除外します。

使用頻度の低いフィールドを除外する

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    exclude = ('last_login', 'date_joined')

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの last_login フィールドと date_joined フィールドを管理画面から除外します。

readonly_fields 属性と組み合わせて使用

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    exclude = ('name', 'age')
    readonly_fields = ('created_at', 'updated_at')

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールド、age フィールド、created_at フィールド、updated_at フィールドを管理画面から除外します。created_at フィールドと updated_at フィールドは読み取り専用です。

list_display 属性、search_fields 属性、filter_fields 属性に影響を与える

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    exclude = ('name', 'age')
    list_display = ('id', 'email')
    search_fields = ('email', 'description')
    filter_fields = ('email', 'is_active')

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドと age フィールドを管理画面から除外します。

• list_display 属性は、一覧画面に表示されるフィールドを指定します。
• search_fields 属性は、検索対象となるフィールドを指定します。
• filter_fields 属性は、フィルタリング対象となるフィールドを指定します。

この例では、name フィールドと age フィールドはこれらの属性から除外されます。

カスタム管理クラス

from django.contrib import admin

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

    def get_form(self, request, obj=None):
        form = super().get_form(request, obj)
        form.fields['description'].widget = forms.Textarea()
        return form

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドと age フィールドを管理画面から除外します。さらに、description フィールドのウィジェットを Textarea ウィジェットに変更します。

Django admin.ModelAdmin.exclude の代替方法

readonly_fields 属性は、ユーザーが編集できないフィールドを指定するために使用されます。この属性を使用して、ユーザーが編集できないフィールドを指定することで、事実上、そのフィールドを管理画面から除外することができます。

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドと age フィールドをユーザーが編集できないようにします。

formfield_overrides 属性は、特定のフィールドのフォームフィールドをカスタマイズするために使用されます。この属性を使用して、特定のフィールドのフォームフィールドを HiddenField フィールドなどに変更することで、事実上、そのフィールドを管理画面から除外することができます。

from django.contrib import admin
from django.forms import HiddenField

class MyModelAdmin(admin.ModelAdmin):
    formfield_overrides = {
        'name': {'widget': HiddenField()},
    }

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドを HiddenField フィールドに変更します。

カスタムフォーム

ModelAdmin クラスの form 属性をオーバーライドして、カスタムフォームを指定することができます。カスタムフォームを使用して、特定のフィールドをフォームから除外することができます。

from django.contrib import admin
from django.forms import ModelForm

class MyModelForm(ModelForm):
    class Meta:
        model = MyModel
        exclude = ('name', 'age')

class MyModelAdmin(admin.ModelAdmin):
    form = MyModelForm

admin.site.register(MyModel, MyModelAdmin)

このコードは、MyModel モデルの name フィールドと age フィールドをフォームから除外します。

テンプレート

管理画面のテンプレートをカスタマイズすることで、特定のフィールドをテンプレートから除外することができます。

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

{% block content %}
<h1>{{ title }}</h1>

<form action="{% url 'admin:app_label_model_change' model_admin.model._meta.app_label model_admin.model._meta.model_name object_id %}" method="post">
{% csrf_token %}

<ul class="errorlist">
{% for error in form.errors %}
<li><p>{{ error }}</p></li>
{% endfor %}
</ul>

<table>
{% for field in form %}
<tr>
<th>{{ field.label }}</th>
<td>{{ field }}</td>
</tr>
{% endfor %}
</table>

<input type="submit" value="Save">
</form>
{% endblock %}

このテンプレートは、MyModel モデルの name フィールドと age フィールドをテンプレートから除外します。

JavaScriptを使用して、特定のフィールドを非表示にすることができます。

// mymodel_change_form.js

$(document).ready(function() {
    $('#id_name').hide();
    $('#id_age').hide();
});

このJavaScriptは、MyModel モデルの name フィールドと age フィールドを非表示にします。

admin.ModelAdmin.exclude 属性は、モデル管理画面からフィールドを除外する簡単な方法ですが、いくつかの代替方法もあります。これらの代替方法は、より柔軟な方法でフィールドを除外するために使用できます。