Django admin.ModelAdmin.readonly_fields 詳細解説

Django admin.ModelAdmin.readonly_fields 詳細解説

django.contrib.admin の admin.ModelAdmin.readonly_fields は、Django 管理サイトで特定のフィールドを 読み取り専用 に設定するための強力なツールです。この属性を使用すると、ユーザーが編集できないフィールドを指定できます。

利点

• データの整合性を保ちます。
• 誤操作を防ぎます。
• 機密情報やシステム生成された情報を保護します。
• ユーザーインターフェースをシンプルにします。

使い方

1. readonly_fields 属性を ModelAdmin クラスに追加します。
2. 読み取り専用にしたいフィールド名をリストとして指定します。

例

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

この例では、created_at と updated_at フィールドは、Django 管理サイトで編集できなくなります。

詳細

• readonly_fields は、モデルフィールド名だけでなく、 callable も受け付けます。
• callable は、モデルインスタンスを受け取り、読み取り専用にするフィールド名のリストを返す必要があります。
• readonly_fields は、list_display や list_filter などの他の ModelAdmin 属性と組み合わせて使用できます。

補足

• readonly_fields は、スーパーユーザーを含むすべてのユーザーに適用されます。
• 特定のユーザーグループにのみ読み取り専用フィールドを適用するには、ModelAdmin の get_readonly_fields メソッドをオーバーライドする必要があります。

応用例

• 作成日時や更新日時などのシステム生成されたフィールド
• 機密情報、パスワード、API キーなど
• 外部キーによって参照されるフィールド
• 計算によって生成されるフィールド

admin.ModelAdmin.readonly_fields は、Django 管理サイトで特定のフィールドを 読み取り専用 に設定するための強力なツールです。データの整合性を保ち、誤操作を防ぐために、ぜひ活用しましょう。

Django admin.ModelAdmin.readonly_fields サンプルコード集

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

callable を使用して動的に読み取り専用フィールドを設定

from django.contrib import admin

class MyModelAdmin(admin.ModelAdmin):
    def get_readonly_fields(self, request, obj=None):
        if request.user.is_superuser:
            return ()
        else:
            return ('created_at', 'updated_at')

admin.site.register(MyModel, MyModelAdmin)

外部キーによって参照されるフィールドをreadonlyに設定

from django.contrib import admin

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

admin.site.register(MyModel, MyModelAdmin)

計算によって生成されるフィールドをreadonlyに設定

from django.contrib import admin

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

    def calculated_field(self, obj):
        return obj.field1 + obj.field2

admin.site.register(MyModel, MyModelAdmin)

読み取り専用フィールドにカスタムフォーマットを適用

from django.contrib import admin
from django.utils.html import format_html

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

    def formatted_field(self, obj):
        return format_html('<span style="color: red;">{}</span>', obj.field)

admin.site.register(MyModel, MyModelAdmin)

読み取り専用フィールドにリンクを追加

from django.contrib import admin
from django.utils.html import format_html

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

    def linked_field(self, obj):
        return format_html('<a href="{}">{}</a>', obj.url, obj.field)

admin.site.register(MyModel, MyModelAdmin)

特定のユーザーグループにのみreadonlyフィールドを適用

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

class MyModelAdmin(admin.ModelAdmin):
    def get_readonly_fields(self, request, obj=None):
        user_groups = request.user.groups.all()
        if Group.objects.get(name='readonly_users') in user_groups:
            return ('created_at', 'updated_at')
        else:
            return ()

admin.site.register(MyModel, MyModelAdmin)

これらのサンプルコードは、admin.ModelAdmin.readonly_fields 属性の使い方を理解するのに役立ちます。

admin.ModelAdmin.readonly_fields は、Django 管理サイトで特定のフィールドを 読み取り専用 に設定するための強力なツールです。データの整合性を保ち、誤操作を防ぐために、ぜひ活用しましょう。

Django admin でフィールドをreadonlyにする他の方法

モデルフィールドの editable 属性を False に設定すると、そのフィールドは Django 管理サイトで編集できなくなります。

class MyModel(models.Model):
    name = models.CharField(max_length=255)
    age = models.IntegerField(editable=False)

フォームウィジェットを使用して、フィールドを readonly に設定できます。

from django.contrib import admin
from django.forms import widgets

class MyModelAdmin(admin.ModelAdmin):
    formfield_overrides = {
        models.IntegerField: {'widget': widgets.TextInput(attrs={'readonly': 'readonly'})},
    }

admin.site.register(MyModel, MyModelAdmin)

カスタムフォームを作成して、フィールドを readonly に設定できます。

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

class MyModelForm(ModelForm):
    class Meta:
        model = MyModel
        fields = ('name', 'age')
        widgets = {
            'age': widgets.TextInput(attrs={'readonly': 'readonly'})
        }

class MyModelAdmin(admin.ModelAdmin):
    form = MyModelForm

admin.site.register(MyModel, MyModelAdmin)

JavaScript を使用して、フィールドを readonly に設定できます。

<script>
document.getElementById('id_age').readOnly = true;
</script>

• すべてのユーザーに対してフィールドを readonly にしたい場合は、editable 属性を使用するのが最も簡単です。
• 特定のユーザーグループに対してのみフィールドを readonly にしたい場合は、ModelAdmin の get_readonly_fields メソッドをオーバーライドする必要があります。
• フィールドの表示形式をカスタマイズしたい場合は、カスタムフォームを使用する必要があります。

Django admin でフィールドを readonly に設定するには、いくつかの方法があります。どの方法を使用するべきかは、状況によって異なります。