可以“list_display” 在 Django ModelAdmin 中显示外键字段的属性？

Question

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

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

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

我已经尝试了所有这样做的方法显而易见，但似乎没有任何效果。

有什么建议么？

Answer 1

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

#models.py
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 或更高版本，请参阅此答案

Answer 2

尽管上面有很多很好的答案，并且由于我是 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 模型链接 此处

Answer 3

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

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

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

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

之后：10.81 毫秒内 6 次查询

Answer 4

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

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'

Answer 5

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

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

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

看起来很奇怪，它不支持 ' book__author' 样式格式在 DB API 中的其他任何地方都使用。

结果是此功能的票证，被标记为“无法修复”。

Answer 7

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

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

第

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

2887每行的数据库命中。

Answer 8

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

使用此功能，您想要实现的目标非常简单：

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

两个链接都包含安装和使用的完整详细信息，因此我不会将它们粘贴到此处，以防它们发生更改。

顺便说一句，如果您已经使用了 model.Admin 以外的其他内容（例如我使用的是 SimpleHistoryAdmin），您可以执行以下操作：class MyAdmin（SimpleHistoryAdmin，RelatedFieldAdmin）。

Answer 9

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

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

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

Answer 10

如果您有很多关系属性字段要在 list_display 中使用，并且不想为每个字段创建一个函数（及其属性），那么一个肮脏但简单的解决方案将覆盖 ModelAdmin< /code> 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

如要点< /a>

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

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

不要忘记使用 ModelAdmin 中的“list_select_lated”>list_select_lated 属性使 Django 避免额外的查询。

Answer 11

这个已经被接受了，但是如果还有其他傻瓜（像我一样）没有立即从 目前接受的答案中得到它，这里有更多细节。

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

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

    def __unicode__(self):
        return self.name

这对我来说很重要，并且应该适用于上述场景。 这适用于 Django 1.0.2。

Answer 12

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

Answer 13

如果您在内联中尝试，您将不会成功，除非：

在您的内联中：

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