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

223

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

С учетом сказанного в моей модели PersonAdmin я хотел бы отобразить "book.author", используя "list_display". Я пробовал все очевидные методы для этого (см. Ниже), но ничего не работает. Любые предложения?

class PersonAdmin(admin.ModelAdmin):
  list_display = ['book.author',]
Теги:
django-admin

13 ответов

358
Лучший ответ

В качестве еще одного варианта вы можете посмотреть вверх, например:

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'
  • 2
    Должно ли get_author быть get_reviews?
  • 1
    ой, хороший улов!
Показать ещё 11 комментариев
96

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

  • 2
    для поля заказа не должно быть = 'author__name'?
  • 0
    Я тоже это пытаюсь. использовать имя автора__ не работает ...
Показать ещё 2 комментария
59

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

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

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

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

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

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

После: 6 запросов в 10.81мс

  • 0
    Должно ли это быть "..., self) .get_queryset (request) .." вместо "..., self) .queryset (request) .."? Я получаю супер 'объект' AttributeError 'не имеет атрибута' queryset ', когда он просто .queryset, и не имеет ошибки, когда .get_queryset
  • 1
    Я думаю, что это действительно должен быть .get_queryset. Я могу подтвердить улучшение запроса. Благодарю.
Показать ещё 1 комментарий
19

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

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

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

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

  • 2
    book__author действительно работает. (Джанго 1.2)
  • 11
    @ Мермоз правда? Похоже, билет остается установленным как wontfix. Похоже, это не работает (Django 1.3)
Показать ещё 2 комментария
10

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


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

class PersonAdmin(admin.ModelAdmin):
  list_display = [book_author,]
  • 0
    Эта модель хороша для ситуаций, когда множество разных моделей часто вызывают один и тот же атрибут; это поддерживается в 1.3+?
  • 3
    Проблема в этом состоит в количестве запросов SQL, выполненных в конце. Для каждого объекта в списке, он сделает запрос. Вот почему 'field__attribute' был бы очень удобен, потому что, конечно, Django мог бы охватить это только одним SQL-запросом. Странно, что уже нет поддержки этому.
9

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

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

Итак, вы можете сделать:

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

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

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

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

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

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

    def __unicode__(self):
        return self.name

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

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

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

Используя это, то, что вы хотите достичь, так же просто, как:

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

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

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

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

Если у вас есть много полей атрибутов отношения для использования в 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 избегал дополнительных запросы.

3

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

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

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

    @staticmethod
    def submodel__field(obj):
        return obj.submodel.field
-2

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

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

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

Ещё вопросы

Сообщество Overcoder
Наверх
Меню