Может ли list_display в Django ModelAdmin отображать атрибуты полей ForeignKey?
У меня есть модель Person, которая имеет отношение внешнего ключа к Book. В книге есть несколько полей, но меня больше всего беспокоит "автор" (стандартный CharField).
С учетом сказанного в моей модели PersonAdmin я бы хотел отобразить "book.author" с помощью "list_display". Я испробовал все очевидные методы для этого (см. Ниже), но, похоже, ничего не работает. Какие-либо предложения?
class PersonAdmin(admin.ModelAdmin):
list_display = ['book.author',]
15 ответов
Как еще один вариант, вы можете выглядеть как:
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'
Несмотря на все замечательные ответы выше и из-за того, что я был новичком в 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 здесь
Как и все остальное, я тоже ходил с звонками. Но у них есть один недостаток: по умолчанию вы не можете заказать их. К счастью, для этого есть решение:
def author(self):
return self.book.author
author.admin_order_field = 'book__author'
Обратите внимание, что добавление 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 мс
Для Django>= 3.2
Правильный способ сделать это с Django 3.2 или выше - использовать декоратор дисплея.
class BookAdmin(admin.ModelAdmin):
model = Book
list_display = ['title', 'get_author_name']
@admin.display(description='Author Name', ordering='author__name')
def get_author_name(self, obj):
return obj.author.name
Согласно документации, вы можете отображать только __unicode__ представление ForeignKey:
http://docs.djangoproject.com/en/dev/ref/contrib/admin/
Кажется странным, что он не поддерживает 'book__author' формат стиля, который используется везде в API БД.
Оказывается, есть билет для этой функции, которая помечена как не будет исправлена.
Я только что опубликовал фрагмент, который заставляет admin.ModelAdmin поддерживать синтаксис "__":
http://djangosnippets.org/snippets/2887/
Так что вы можете сделать:
class PersonAdmin(RelatedFieldAdmin):
list_display = ['book__author',]
Это в основном просто делает то же самое, что описано в других ответах, но оно автоматически заботится о (1) установке admin_order_field (2) установке short_description и (3) изменении набора запросов, чтобы избежать попадания в базу данных для каждой строки.
В PyPI есть очень простой в использовании пакет, который обрабатывает именно это: django-related-admin. Вы также можете увидеть код в GitHub.
Используя это, вы просто хотите:
class PersonAdmin(RelatedFieldAdmin):
list_display = ['book__author',]
Обе ссылки содержат полную информацию об установке и использовании, поэтому я не буду вставлять их сюда в случае их изменения.
Просто в качестве примечания, если вы уже используете что-то другое, чем model.Admin (например, я использовал SimpleHistoryAdmin вместо этого) вы можете сделать это: class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin),
Вы можете показать все, что вы хотите в списке отображения с помощью вызываемой. Это будет выглядеть так:
def book_author (объект): вернуть объект.book.author Класс PersonAdmin(admin.ModelAdmin): list_display = [book_author,]
Этот уже принят, но если есть какие-то другие манекены (такие как я), которые не сразу получили его из принятого в настоящее время ответа, то здесь немного подробнее.
Класс модели, на который ссылается ForeignKey должен иметь __unicode__ метод внутри него, как здесь:
class Category(models.Model):
name = models.CharField(max_length=50)
def __unicode__(self):
return self.name
Это имело значение для меня, и должно относиться к вышеописанному сценарию. Это работает на Django 1.0.2.
Если у вас есть много полей атрибутов отношения для использования в 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 чтобы Джанго избегал дополнительных запросов.
Я могу опоздать, но это еще один способ сделать это. Вы можете просто определить метод в своей модели и получить к нему доступ через
list_display как показано ниже:
models.py
class Person(models.Model):
book = models.ForeignKey(Book, on_delete=models.CASCADE)
def get_book_author(self):
return self.book.author
admin.py
class PersonAdmin(admin.ModelAdmin):
list_display = ('get_book_author',)
Но этот и другие упомянутые выше подходы добавляют два дополнительных запроса на строку на странице просмотра списка. Чтобы оптимизировать это, мы можем переопределить
get_queryset чтобы аннотировать обязательное поле, затем используйте аннотированное поле в нашем методе ModelAdmin
admin.py
from django.db.models.expressions import F
@admin.register(models.Person)
class PersonAdmin(admin.ModelAdmin):
list_display = ('get_author',)
def get_queryset(self, request):
queryset = super().get_queryset(request)
queryset = queryset.annotate(
_author = F('book__author')
)
return queryset
@admin.display(ordering='_author', description='Author')
def get_author(self, obj):
return obj._author
Если вы попробуете это в 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
Ответ AlexRobbins работал для меня, за исключением того, что первые две строки должны быть в модели (возможно, это предполагалось?), И должны ссылаться на себя:
def book_author(self):
return self.book.author
Тогда админ часть работает хорошо.
Я предпочитаю это:
class CoolAdmin(admin.ModelAdmin):
list_display = ('pk', 'submodel__field')
@staticmethod
def submodel__field(obj):
return obj.submodel.field