Может ли list_display в Django ModelAdmin отображать атрибуты полей ForeignKey?


296

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

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

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

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

Какие-либо предложения?

Ответы:


472

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

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'

Не должно быть и того и другого get_author, поскольку именно на эту строку вы действительно ссылаетесь (и краткое описание)? Или изменить аргумент формата строки на obj.book.reviews?
Карл Дж

1
@AnatoliyArkhipov, есть способ (основанный на ответе Терра ). Я уже обновил код в этом ответе.
Денилсон Са Майя

почему ты не можешь просто иметь author = ForeignKey(Author)в книжной модели, а потом list_display = ('author')?
alias51

3
Это вызывает один запрос на строку, отображаемую в админке :(
marcelm

1
@marcelm вот для чего select_related. get_queryset()изUserAdmin должны быть перезаписаны.
interDist

142

Несмотря на все замечательные ответы выше и из-за того, что я был новичком в 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 здесь


3
для поля заказа не должно быть = 'author__name'?
Юнти

2
Это работает отлично, однако я не уверен, почему. objесть BookAdmin?
Стивен Черч

Вот это да. Мне понадобился час в Интернете, чтобы найти это. Это должно быть
прояснено в

67

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

Джанго> = 1.8

def author(self, obj):
    return obj.book.author
author.admin_order_field  = 'book__author'

Джанго <1,8

def author(self):
    return self.book.author
author.admin_order_field  = 'book__author'

подпись метода должна бытьdef author(self, obj):
sheats

Назад, когда я сделал комментарий, это не имело место, но кажется, что начиная с версии 1.8 метод получает объект, переданный ему. Я обновил свой ответ.
Арьен

46

Пожалуйста, обратите внимание, что добавление 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 мс


3
Это действительно важно и всегда должно быть реализовано
xleon

Это действительно важно. В качестве альтернативы, если нужно идти по __str__маршруту, просто добавьте иностранный ключ к list_displayиlist_select_related
Scratch'N'Purr

22

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

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

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

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


11
@ Правда, Мермоз? Похоже, билет остается установленным как wontfix. Похоже, это не работает (Django 1.3)
Дэйв

1.11 до сих пор не существует.
Аарон Макмиллин

12

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

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

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

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

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


Мне очень нравится эта идея, но, похоже, она больше не работает с недавними версиями django:AttributeError: type object 'BaseModel' has no attribute '__metaclass__'
Vincent van Leeuwen

10

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

def book_author (объект):
  возвращаемое object.book.author

Класс PersonAdmin (admin.ModelAdmin):
  list_display = [book_author,]

Это хорошо для ситуаций, когда множество разных моделей часто вызывают один и тот же атрибут; это поддерживается в 1.3+?
Кагали-сан

3
Проблема в этом состоит в количестве запросов SQL, выполненных в конце. Для каждого объекта в списке он сделает запрос. Вот почему 'field__attribute' был бы очень удобен, потому что, конечно, Django охватил бы это только одним запросом SQL. Странно, что уже нет поддержки этому.
emyller

7

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

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

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

    def __unicode__(self):
        return self.name

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


4
На питоне 3 это будет def __str__(self):.
Martlark

5

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

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Атрибут callable определяется автоматически.

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


1
Просто попробовал это с установкой Django 2.2, и он отлично работал для меня, в то время как другие подходы не помогли, по любой причине. Обратите внимание, что в настоящее время вам нужно импортировать сокращение из functools или из другого места ...
Пол Брэкин

5

В PyPI есть очень простой в использовании пакет, который обрабатывает именно это: django-related-admin . Вы также можете увидеть код в GitHub .

Используя это, вы просто хотите:

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

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

Так же , как примечание стороны, если вы уже используете что - то другое , чем model.Admin(например , я использую SimpleHistoryAdminвместо этого), вы можете сделать это: class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin).


getter_for_related_field не работает в 1.9, так что, похоже, это не лучший выбор для тех, кто любит настраивать.
GriMel

4

если вы попробуете это в 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

-1

Ответ AlexRobbins работал для меня, за исключением того, что первые две строки должны быть в модели (возможно, это предполагалось?), И должны ссылаться на себя:

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

Тогда админ часть работает хорошо.


-5

Я предпочитаю это:

class CoolAdmin(admin.ModelAdmin):
    list_display = ('pk', 'submodel__field')

    @staticmethod
    def submodel__field(obj):
        return obj.submodel.field
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.