可以“list_display"在Django ModelAdmin中显示ForeignKey字段的属性?

我有一个与Book有外键关系的Person模型,它有许多字段,但我最关心的是author(一个标准CharField)。

话虽如此,在我的PersonAdmin模型中,我希望使用list_display显示book.author:

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

我已经尝试了所有显而易见的方法,但似乎都不起作用。

有什么建议吗?

223068 次浏览

根据文档,你只能显示ForeignKey的__unicode__表示:

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

奇怪的是,它不支持DB API中其他地方都使用的'book__author'样式格式。

结果是有此功能的门票,它被标记为Won't Fix。

还有一种选择,你可以这样查找:

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 3.2开始,你可以使用display()装饰器:

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

@admin.display(ordering='book__author', description='Author')
def get_author(self, obj):
return obj.book.author

这个已经被接受了,但如果有任何其他傻瓜(像我)没有立即从目前接受的回答中得到它,这里有更多的细节。

ForeignKey引用的模型类需要有一个__unicode__方法,如下所示:

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


def __unicode__(self):
return self.name

这对我来说很重要,也适用于上述情况。这适用于Django 1.0.2。

你可以使用可调用对象在列表显示中显示你想要的任何东西。它看起来是这样的:



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


class PersonAdmin(admin.ModelAdmin):
list_display = [book_author,]

AlexRobbins的回答对我来说很有用,除了前两行需要在模型中(也许这是假设的?),并且应该引用self:

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

然后管理部分工作得很好。

和其他人一样,我也选择了可调用对象。但它们有一个缺点:默认情况下,你不能在上面点餐。幸运的是,有一个解决方案:

Django >= 1.8

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

Django & lt;1.8

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

我刚刚发布了一个片段,使管理。ModelAdmin支持'__'语法:

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

所以你可以这样做:

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

这基本上只是做与其他回答中描述的相同的事情,但它自动负责(1)设置admin_order_field(2)设置short_description和(3)修改queryset以避免对每一行进行数据库命中。

如果你尝试在内联,你不会成功,除非:

在内联中:

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

尽管上面有很多很棒的答案,但由于我是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模型链接在这里

请注意,添加get_author函数会减慢管理中的list_display,因为显示每个人会产生SQL查询。

为了避免这种情况,你需要修改PersonAdmin中的get_queryset方法,例如:

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

之前:36.02ms内73个查询(管理中67个重复查询)

之后:10.81ms内查询6次

如果你在list_display中有很多关系属性字段要使用,并且不想为每个字段创建一个函数(及其属性),一个肮脏但简单的解决方案是覆盖ModelAdmin实例__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

作为这里的要点

可调用的特殊属性如booleanshort_description必须定义为ModelAdmin属性,例如book__author_verbose_name = 'Author name'category__is_new_boolean = True

可调用的admin_order_field属性被自动定义。

不要忘记在你的ModelAdmin中使用list_select_related属性来让Django避免额外的查询。

在PyPI中有一个非常容易使用的包可以处理这个问题:django-related-admin。你也可以参见GitHub中的代码

使用它,你想要达到的效果很简单:

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

这两个链接都包含了安装和使用的全部细节,所以我不会把它们粘贴在这里,以防它们发生变化。

作为旁注,如果你已经在使用model.Admin以外的东西(例如,我正在使用SimpleHistoryAdmin代替),你可以这样做:class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin)

我更喜欢这个:

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


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

对于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

我可能会迟到,但这是另一种方法。你可以简单地在你的模型中定义一个方法,并通过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