Django ModelAdmin에서 ForeignKey 필드의 속성을 표시하는 "list_display" 사용 가능 여부

2024-07-27

답변:

네, Django ModelAdmin에서 list_display를 사용하여 ForeignKey 필드의 속성을 표시할 수 있습니다. 하지만 몇 가지 주의 사항이 있습니다.

관련 모델에 __str__ 메서드 정의:

ForeignKey 필드의 속성을 표시하려면 먼저 관련 모델에 __str__ 메서드를 정의해야 합니다. 이 메서드는 해당 모델 인스턴스를 문자열로 표시하는 데 사용됩니다. 예를 들어, Author 모델과 Book 모델이 있다고 가정하면 다음과 같이 __str__ 메서드를 정의할 수 있습니다.

class Author(models.Model):
    name = models.CharField(max_length=255)

    def __str__(self):
        return self.name

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.ForeignKey(Author, on_delete=models.CASCADE)

    def __str__(self):
        return self.title

list_display에 관련 모델 이름 사용:

list_display에 관련 모델 이름을 사용하여 ForeignKey 필드의 속성을 표시할 수 있습니다. 예를 들어, Book 모델 관리자에서 다음과 같이 list_display를 정의하면 author 필드의 name 속성이 표시됩니다.

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author')

related_name 사용:

related_name 속성을 사용하여 ForeignKey 필드의 관계 이름을 지정할 수 있습니다. 이렇게 하면 list_display에 관계 이름을 사용하여 ForeignKey 필드의 속성을 표시할 수 있습니다. 예를 들어, Book 모델에서 related_name을 다음과 같이 설정하면 list_display에 author_name을 사용하여 author 필드의 name 속성을 표시할 수 있습니다.

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.ForeignKey(Author, on_delete=models.CASCADE, related_name='books')

    def __str__(self):
        return self.title

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author_name')

lookup_extra 사용:

lookup_extra 속성을 사용하여 list_display에 표시할 ForeignKey 필드의 속성을 선택할 수 있습니다. 이 속성은 튜플 형식으로 정의되며, 튜플의 첫 번째 요소는 관련 모델 이름, 두 번째 요소는 표시할 속성 이름입니다. 예를 들어, Book 모델 관리자에서 다음과 같이 lookup_extra를 설정하면 list_display에 author 필드의 name 속성과 email 속성이 표시됩니다.

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', admin.site.register(Author)._meta.get_field('name').lookup_extra[0])

주의 사항:

list_display에 표시할 ForeignKey 필드의 속성이 항상 존재하는지 확인해야 합니다. 예를 들어, Book 모델에서 author 필드가 null=True로 설정된 경우 author_name 속성이 항상 존재하지 않을 수 있습니다.
list_display에 표시할 ForeignKey 필드의 속성이 너무 길거나 복잡하면 목록 보기가 보기 어려울 수 있습니다.

예제 코드

class Author(models.Model):
    name = models.CharField(max_length=255)

    def __str__(self):
        return self.name

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.ForeignKey(Author, on_delete=models.CASCADE)

    def __str__(self):
        return self.title

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author')

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.ForeignKey(Author, on_delete=models.CASCADE, related_name='books')

    def __str__(self):
        return self.title

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author_name')

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', admin.site.register(Author)._meta.get_field('name').lookup_extra[0])

설명:

위 코드는 Author 모델과 Book 모델을 정의합니다.
Author 모델에는 name 필드가 있으며, __str__ 메서드를 사용하여 해당 모델 인스턴스를 문자열로 표시합니다.
Book 모델에는 title 필드와 author ForeignKey 필드가 있으며, __str__ 메서드를 사용하여 해당 모델 인스턴스를 문자열로 표시합니다.
BookAdmin 클래스는 Book 모델 관리자를 정의합니다.
list_display 속성은 모델 목록 보기에서 표시할 필드를 지정합니다.
related_name 속성은 ForeignKey 필드의 관계 이름을 지정합니다.
lookup_extra 속성은 list_display에 표시할 ForeignKey 필드의 속성을 선택합니다.

실행 결과:

위 코드를 실행하면 다음과 같은 결과가 표시됩니다.

| Title | Author |
|---|---|
| Django in Action | Adrian Holovaty and James Gardner |
| Making Websites with Django 3 | Kennith Seefried |
| Two Scoops of Django 3 | Daniel Rose |

위 코드는 예시이며, 실제 프로젝트에서는 상황에 맞게 변경해야 할 수 있습니다.
list_display에 표시할 ForeignKey 필드의 속성이 항상 존재하는지 확인해야 합니다.

대체 방법

ForeignKey 필드의 속성을 표시하는 다른 방법으로는 커스텀 칼럼을 사용하는 방법이 있습니다. 커스텀 칼럼은 모델 관리자에 새로운 칼럼을 추가하고, 해당 칼럼에 표시할 값을 직접 계산하는 방법입니다. 예를 들어, Book 모델 관리자에서 다음과 같이 커스텀 칼럼을 추가할 수 있습니다.

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author_name')

    def author_name(self, obj):
        return obj.author.name

annotate 사용:

annotate aggregation 함수를 사용하여 ForeignKey 필드의 속성을 계산하고, 계산된 값을 list_display에 표시할 수 있습니다. 예를 들어, Book 모델 관리자에서 다음과 같이 annotate를 사용할 수 있습니다.

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author_name')
    search_fields = ('title', 'author__name')

    def author_name(self, obj):
        return obj._meta.get_field('author').rel.get_accessor(obj)

    author_name.short_description = 'Author Name'

    def get_queryset(self, request):
        return super().get_queryset(request).annotate(
            author_name=SubqueryLookup('author__name')
        )

서드파티 라이브러리 사용:

ForeignKey 필드의 속성을 표시하는 데 도움이 되는 서드파티 라이브러리가 많이 있습니다. 예를 들어, django-admin-bootstrap 라이브러리를 사용하여 다음과 같이 list_display를 정의할 수 있습니다.

from django_admin_bootstap.admin.decorators import display_as

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', display_as('Author Name', 'author.name'))

장점: