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

Question

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

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

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

我已经尝试了所有明显的方法，但似乎没有任何效果。

有什么建议么？

Answer 1

作为另一种选择，您可以进行如下查找：

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')
    
    @display(ordering='book__author', description='Author')
    def get_author(self, obj):
        return obj.book.author

Answer 2

尽管上面有所有很好的答案，而且由于我是 Django 的新手，我仍然被困住了。这是我从一个非常新手的角度进行的解释。

模型.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 模型链接

Answer 3

和其他人一样，我也使用了可调用对象。但是它们有一个缺点：默认情况下，您不能订购它们。幸运的是，有一个解决方案：

姜戈 >= 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'

Answer 4

请注意，添加该get_author函数会减慢管理员中的 list_display，因为显示每个人都会进行 SQL 查询。

为避免这种情况，您需要修改get_querysetPersonAdmin 中的方法，例如：

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

之前：73 个查询在 36.02 毫秒内（管理员中有 67 个重复查询）

之后：10.81 毫秒内 6 次查询

Answer 5

根据文档，您只能显示__unicode__ForeignKey 的表示：

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

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

原来这个功能有一张票，标记为不会修复。

Answer 6

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

Answer 7

我刚刚发布了一个片段，使 admin.ModelAdmin 支持 '__' 语法：

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

所以你可以这样做：

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

这基本上只是在做与其他答案中描述的相同的事情，但它会自动处理（1）设置 admin_order_field （2）设置 short_description 和（3）修改查询集以避免每行的数据库命中。

Answer 8

您可以使用可调用对象在列表显示中显示您想要的任何内容。它看起来像这样：

def book_author（对象）：
  返回 object.book.author

类 PersonAdmin（admin.ModelAdmin）：
  list_display = [书名作者，]

Answer 9

PyPI 中有一个非常易于使用的包可以处理这个问题：django-related-admin。您还可以在 GitHub 中查看代码。

使用它，您想要实现的目标很简单：

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

两个链接都包含安装和使用的完整详细信息，因此我不会将它们粘贴在这里以防它们发生变化。

顺便说一句，如果您已经在使用其他东西model.Admin（例如，我正在使用SimpleHistoryAdmin），您可以这样做：class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin).

Answer 10

这个已经被接受了，但是如果那里有任何其他的假人（比如我）没有立即从目前接受的答案中得到它，这里有一些更详细的信息。

ForeignKey需要引用的模型类在其中有一个__unicode__方法，如下所示：

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

    def __unicode__(self):
        return self.name

这对我来说很重要，应该适用于上述情况。这适用于 Django 1.0.2。

Answer 11

如果您有很多要使用的关系属性字段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

作为这里的要点

可调用的特殊属性，例如booleanand ，short_description必须定义为ModelAdmin属性，例如book__author_verbose_name = 'Author name'and category__is_new_boolean = True。

callableadmin_order_field属性是自动定义的。

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

Answer 12

如果你在 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

Answer 13

我可能会迟到，但这是另一种方法。您可以简单地在模型中定义一个方法并通过list_display以下方式访问它：

模型.py

class Person(models.Model):
    book = models.ForeignKey(Book, on_delete=models.CASCADE)

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

管理员.py

class PersonAdmin(admin.ModelAdmin):
    list_display = ('get_book_author',)

但是上面提到的这种方法和其他方法会在您的列表视图页面中的每行添加两个额外的查询。为了优化这一点，我们可以覆盖get_queryset注释必填字段，然后在我们的 ModelAdmin 方法中使用注释字段

管理员.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

Answer 14

AlexRobbins 的回答对我有用，除了前两行需要在模型中（也许这是假设的？），并且应该引用 self：

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

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

Answer 15

我更喜欢这个：

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

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