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


296

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

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

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

我已经尝试了所有显而易见的方法来执行此操作,但是似乎没有任何效果。

有什么建议么?

Answers:


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
卡尔·G

1
@AnatoliyArkhipov,有一种方法(基于Terr的回答)。我已经更新了此答案中的代码。
DenilsonSáMaia 2014年

为什么您不能只拥有author = ForeignKey(Author)书本模型,然后list_display = ('author')呢?
alias51

3
这会导致在admin中显示的每一行一个查询:(
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'吗?
云蒂2015年

2
这很完美,但是我不确定为什么。objBookAdmin
史蒂文·丘奇

哇。花了我一个小时在网络上找到它。这应该Django文档中做了很多更清晰
Sevenearths

67

和其余的一样,我也使用可调用对象。但是它们有一个缺点:默认情况下,您无法订购它们。幸运的是,有一个解决方案:

的Django> = 1.8

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

Django <1.8

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

方法签名应该是def author(self, obj):
sheats

回到我发表评论时,情况并非如此,但似乎从1.8版开始,该方法将对象传递给它。我已经更新了答案。
Arjen

46

请注意,添加该get_author功能会减慢admin中的list_display速度,因为显示每个人都会进行SQL查询。

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

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

之前:36.02毫秒内有73个查询(管理员中有67个重复查询)

之后:10.81毫秒内进行6次查询


3
这真的很重要,应该始终执行
xleon

这确实很重要。或者,如果要沿着__str__路线行驶,只需将外键添加到list_displaylist_select_related
Scratch'N'Purr,

22

根据文档,您只能显示外键的__unicode__表示形式:

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

似乎很奇怪,它不支持'book__author'DB API其他地方使用的样式格式。

原来有一张用于此功能的票证,标记为“无法修复”。


11
@Mermoz真的吗?票证似乎仍设置为“不会修正”。它也似乎不起作用(Django 1.3)
Dave 2012年

1.11仍然不存在。做了django十多年了,我从不记得这件事了:(
Aaron McMillin

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):
  返回object.book.author

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

这对于在许多不同模型经常调用同一属性的情况下非常有用。在1.3+中受支持吗?
kagali-san 2011年

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
在python 3上将是def __str__(self):
Martlark '16

5

如果您有很多关联属性字段供使用,list_display并且不想为每个函数创建一个函数(及其属性),那么一个肮脏而简单的解决方案将覆盖ModelAdmininstace __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

callable admin_order_field属性是自动定义的。

不要忘记在您的列表中使用list_select_related属性,ModelAdmin以使Django避免常规查询。


1
刚刚尝试使用Django 2.2安装进行了测试,无论出于何种原因,它对我都非常有用,而其他方法却没有。请注意,如今您需要从功能工具或其他地方导入reduce ...
Paul Brackin

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的答案对我有用,除了前两行需要在模型中(也许这是假设的?),并且应该引用self:

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
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.