Может ли list_display в Django ModelAdmin отображать атрибуты полей ForeignKey? - PullRequest
250 голосов
/ 02 октября 2008

У меня есть Person модель, которая имеет отношение внешнего ключа к Book, которая имеет несколько полей, но меня больше всего беспокоит author (стандартный CharField).

Учитывая вышесказанное, в моей PersonAdmin модели я бы хотел отобразить book.author, используя list_display:

class PersonAdmin(admin.ModelAdmin):
    list_display = ['book.author',]

Я испробовал все очевидные методы для этого, но, похоже, ничего не работает.

Есть предложения?

Ответы [ 13 ]

410 голосов
/ 03 октября 2008

Как еще один вариант, вы можете выглядеть как:

class UserAdmin(admin.ModelAdmin):
    list_display = (..., 'get_author')

    def get_author(self, obj):
        return obj.book.author
    get_author.short_description = 'Author'
    get_author.admin_order_field = 'book__author'
112 голосов
/ 20 мая 2014

Несмотря на все замечательные ответы выше и из-за того, что я был новичком в Django, я все еще застрял. Вот мое объяснение с точки зрения новичка.

models.py

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

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

admin.py (Неверный путь) - вы думаете, что это будет работать с использованием 'model__field' для ссылки, но это не

class BookAdmin(admin.ModelAdmin):
    model = Book
    list_display = ['title', 'author__name', ]

admin.site.register(Book, BookAdmin)

admin.py (правильный путь) - так вы ссылаетесь на имя внешнего ключа способом Django

class BookAdmin(admin.ModelAdmin):
    model = Book
    list_display = ['title', 'get_name', ]

    def get_name(self, obj):
        return obj.author.name
    get_name.admin_order_field  = 'author'  #Allows column order sorting
    get_name.short_description = 'Author Name'  #Renames column head

    #Filtering on side - for some reason, this works
    #list_filter = ['title', 'author__name']

admin.site.register(Book, BookAdmin)

Для получения дополнительной информации см. Ссылку на модель Django здесь

60 голосов
/ 28 июля 2010

Как и все остальные, я тоже ходил с вызовами. Но у них есть один недостаток: по умолчанию вы не можете заказать их. К счастью, для этого есть решение:

def author(self):
    return self.book.author
author.admin_order_field  = 'book__author'
31 голосов
/ 28 января 2015

Обратите внимание, что добавление функции get_author замедлит list_display в администраторе, потому что показ каждого пользователя будет выполнять SQL-запрос.

Чтобы избежать этого, вам нужно изменить метод get_queryset в PersonAdmin, например:

def get_queryset(self, request):
    return super(PersonAdmin,self).get_queryset(request).select_related('book')

До: 73 запроса за 36,02 мс (67 дублированных запросов в админке)

После: 6 запросов за 10,81 мс

20 голосов
/ 02 октября 2008

Согласно документации, вы можете отображать только __unicode__ представление ForeignKey:

http://docs.djangoproject.com/en/dev/ref/contrib/admin/#list-display

Кажется странным, что он не поддерживает формат стиля 'book__author', который используется везде в API БД.

Оказывается, есть билет для этой функции , который помечен как Не исправлять.

10 голосов
/ 04 февраля 2013

Я только что опубликовал фрагмент, который заставляет admin.ModelAdmin поддерживать синтаксис '__':

http://djangosnippets.org/snippets/2887/

Так что вы можете сделать:

class PersonAdmin(RelatedFieldAdmin):
    list_display = ['book__author',]

Это в основном просто делает то же самое, что описано в других ответах, но автоматически заботится о (1) установке admin_order_field (2) установке short_description и (3) изменении набора запросов, чтобы избежать попадания в базу данных для каждой строки. 1009 *

10 голосов
/ 30 января 2009

Вы можете показать все, что вы хотите в списке отображения с помощью вызываемой Это будет выглядеть так:


def book_author(object):
  return object.book.author

class PersonAdmin(admin.ModelAdmin):
  list_display = [book_author,]
6 голосов
/ 24 января 2009

Это уже принято, но если есть какие-то другие манекены (например, я), которые не сразу получили его из принятого в настоящее время ответа , здесь немного подробнее.

Класс модели, на который ссылается ForeignKey, должен иметь метод __unicode__, например, здесь:

class Category(models.Model):
    name = models.CharField(max_length=50)

    def __unicode__(self):
        return self.name

Это имело для меня значение и должно применяться к описанному выше сценарию. Это работает на Django 1.0.2.

4 голосов
/ 12 января 2016

Если у вас есть много полей атрибутов отношения для использования в list_display и вы не хотите создавать функцию (и ее атрибуты) для каждого из них, грязное, но простое решение будет переопределять ModelAdmin instace __getattr__ Метод создания вызовов на лету:

class DynamicLookupMixin(object):
    '''
    a mixin to add dynamic callable attributes like 'book__author' which
    return a function that return the instance.book.author value
    '''

    def __getattr__(self, attr):
        if ('__' in attr
            and not attr.startswith('_')
            and not attr.endswith('_boolean')
            and not attr.endswith('_short_description')):

            def dyn_lookup(instance):
                # traverse all __ lookups
                return reduce(lambda parent, child: getattr(parent, child),
                              attr.split('__'),
                              instance)

            # get admin_order_field, boolean and short_description
            dyn_lookup.admin_order_field = attr
            dyn_lookup.boolean = getattr(self, '{}_boolean'.format(attr), False)
            dyn_lookup.short_description = getattr(
                self, '{}_short_description'.format(attr),
                attr.replace('_', ' ').capitalize())

            return dyn_lookup

        # not dynamic lookup, default behaviour
        return self.__getattribute__(attr)


# use examples    

@admin.register(models.Person)
class PersonAdmin(admin.ModelAdmin, DynamicLookupMixin):
    list_display = ['book__author', 'book__publisher__name',
                    'book__publisher__country']

    # custom short description
    book__publisher__country_short_description = 'Publisher Country'


@admin.register(models.Product)
class ProductAdmin(admin.ModelAdmin, DynamicLookupMixin):
    list_display = ('name', 'category__is_new')

    # to show as boolean field
    category__is_new_boolean = True

Как Суть здесь

Вызываемые особые атрибуты, такие как boolean и short_description, должны быть определены как ModelAdmin атрибуты, например, book__author_verbose_name = 'Author name' и category__is_new_boolean = True.

Атрибут вызываемый admin_order_field определяется автоматически.

Не забудьте использовать атрибут list_select_related в вашем ModelAdmin, чтобы Django избегал дополнительных запросов.

4 голосов
/ 30 января 2014

Если вы попробуете это в Inline, вы не добьетесь успеха, если:

в вашей строке:

class AddInline(admin.TabularInline):
    readonly_fields = ['localname',]
    model = MyModel
    fields = ('localname',)

в вашей модели (MyModel):

class MyModel(models.Model):
    localization = models.ForeignKey(Localizations)

    def localname(self):
        return self.localization.name
...