[Django]管理者サイトの一覧のカラムをカスタマイズする

Djangoの管理サイトの開発してる時に、例えばアカウント管理の一覧などはこんな感じになると思います。

まぁ、これでも悪くはないんですが、一覧として表示するのであれば、「苗字」と「名前」は一つのカラムにしたかったり、郵便番号〜番地も「住所」として一つのカラムにしたいことがあると思います。

イメージとしてはこんな感じです。

今回はこういった複数のフィールドを一つのカラムとして表示する方法を説明していきたいと思います。

メインの処理以外は下記のサイトのソースを参考にしてもらえればと思います。

https://github.com/koichi-ezato/sample

一覧のカラムのカスタマイズ

accountsアプリケーションのadmin.pyのファイルに以下を実装します。

    list_display = ['username', 'name', 'email', 'merge_address']

「name」はUserモデルのlast_nameとfirst_nameを結合したフィールド（Virtual Field）。「merge_address」はzip、prefecture、city、addressを結合したフィールド（Virtual Field）になります。

    def name(self, obj):
        return obj.last_name + ' ' + obj.first_name

    name.short_description = '氏名'

    def merge_address(self, obj):
        address = ''
        if obj.zip:
            address += obj.zip + '<br>'
        if obj.prefecture:
            address += obj.prefecture + '<br>'
        if obj.city:
            address += obj.city + '<br>'
        if obj.address:
            address += obj.address

        return mark_safe(address)

    merge_address.short_description = '住所'

Virtual Fieldの処理を実装します。

admin.pyファイル全体としては下記のようになります。

# admin.py
from django.contrib import admin
from django.contrib.auth.hashers import make_password
from django.utils.safestring import mark_safe

from .models import User


@admin.register(User)
class UserAdmin(admin.ModelAdmin):
    def save_model(self, request, obj, form, change):
        """
        モデルの保存
        :param request:
        :param obj:
        :param form:
        :param change:
        :return:
        """
        if change:
            user = User.objects.get(pk=obj.pk)
            if not user.password == obj.password:
                obj.password = make_password(obj.password)
        else:
            obj.password = make_password(obj.password)
        obj.save()

    list_display = ['username', 'name', 'email', 'merge_address']
    ordering = ['username']

    def name(self, obj):
        return obj.last_name + ' ' + obj.first_name

    name.short_description = '氏名'

    def merge_address(self, obj):
        address = ''
        if obj.zip:
            address += obj.zip + '<br>'
        if obj.prefecture:
            address += obj.prefecture + '<br>'
        if obj.city:
            address += obj.city + '<br>'
        if obj.address:
            address += obj.address

        return mark_safe(address)

    merge_address.short_description = '住所'

最後に

システムによってはDjangoの管理サイトをメインで利用することもあるかもしれませんが、一覧に１フィールドずつ表示しているとどうしても表示領域の関係上見づらくなることもあると思います。その際は今回の様にフィールドを上手に結合することで、ユーザの視認性を向上させることも可能になります。

ちなみにDjango2以降allow_tagsは利用できませんので、HTMLタグを利用する場合は、mark_safeメソッドを利用するようにしましょう。