Django admin で関連モデルを自在に操る！ get_list_select_related() の魔法

Django admin.ModelAdmin.get_list_select_related() 解説

django.contrib.admin の ModelAdmin.get_list_select_related() は、管理画面の一覧表示で関連モデルを事前取得するためのメソッドです。関連モデルを事前に取得することで、一覧表示のパフォーマンスを向上させることができます。

詳細

get_list_select_related() は、以下の引数を持ちます。

• model_admin: ModelAdmin クラスのインスタンス
• opts: モデルオプション (Model._meta)

このメソッドは、以下の処理を行います。

1. モデルオプションから、select_related_fields 属性を取得します。
2. select_related_fields 属性に指定された関連モデルをリストとして返します。

例

class MyModelAdmin(admin.ModelAdmin):
    list_select_related = ('author', 'book')

@property
def get_list_select_related(self):
    return super().get_list_select_related() + ('publisher',)

上記の例では、MyModelAdmin クラスは、author と book 関連モデルを一覧表示で事前取得します。さらに、get_list_select_related() メソッドをオーバーライドすることで、publisher 関連モデルも事前取得するようにしています。

注意事項

• get_list_select_related() メソッドは、ModelAdmin クラスのメソッドです。
• このメソッドは、一覧表示でのみ使用できます。
• 関連モデルを事前取得することで、パフォーマンスが向上しますが、メモリ使用量が増加する可能性があります。

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

シンプルな例

class MyModelAdmin(admin.ModelAdmin):
    list_select_related = ('author', 'book')

メソッドオーバーライドによる動的な設定

class MyModelAdmin(admin.ModelAdmin):
    def get_list_select_related(self):
        if request.user.is_superuser:
            return ('author', 'book', 'publisher')
        else:
            return ('author', 'book')

この例では、get_list_select_related() メソッドをオーバーライドすることで、ユーザーの権限に応じて事前取得する関連モデルを動的に設定しています。

関連モデルの属性をフィルター条件に含める

class MyModelAdmin(admin.ModelAdmin):
    list_select_related = ('author__username',)

    def get_list_queryset(self, request):
        qs = super().get_list_queryset(request)
        return qs.filter(author__username='johndoe')

この例では、author 関連モデルの username 属性をフィルター条件に含めています。

複数階層の関連モデルを事前取得

class MyModelAdmin(admin.ModelAdmin):
    list_select_related = ('author__profile',)

この例では、author 関連モデルの profile 関連モデルを事前取得します。

prefetch_related との併用

class MyModelAdmin(admin.ModelAdmin):
    list_select_related = ('author',)
    list_prefetch_related = ('book',)

この例では、author 関連モデルは select_related で事前取得し、book 関連モデルは prefetch_related で事前取得します。

• get_list_select_related() メソッドは、ModelAdmin クラスのメソッドであるため、サブクラスでオーバーライドすることができます。

Django で関連モデルを事前取得する他の方法

select_related() は、モデルクエリに関連モデルを含めるためのクエリセットメソッドです。

qs = MyModel.objects.select_related('author', 'book')

上記の例では、MyModel モデルの author と book 関連モデルをクエリ結果に含めます。

prefetch_related() は、モデルクエリに関連モデルを含めるためのクエリセットメソッドです。select_related() と異なり、prefetch_related() は別途クエリを実行して関連モデルを取得します。

qs = MyModel.objects.prefetch_related('author', 'book')

上記の例では、MyModel モデルの author と book 関連モデルを別途クエリで取得します。

django-extensions ライブラリには、select_related_recursive() という便利なヘルパー関数があります。

from django_extensions.db.models import select_related_recursive

qs = MyModel.objects.select_related_recursive('author', 'book')

上記の例では、MyModel モデルの author と book 関連モデルおよびその関連モデルを再帰的に事前取得します。

方法の比較

使用例

• 一覧表示でパフォーマンスを向上させたい場合は、get_list_select_related() または prefetch_related() を使用します。
• 複雑なクエリを避けたい場合は、select_related() を使用します。
• 再帰的に関連モデルを取得したい場合は、django-extensions.select_related_recursive() を使用します。