Django ModelAdmin中的"list_display"可以显示ForeignKey字段的属性吗？

Question

我有一个与Book有外键关系的Person模型.本书有很多领域,但我最关心的是"作者"(标准的CharField).

话虽如此,在我的PersonAdmin模型中,我想使用"list_display"显示"book.author".我已经尝试了所有这些明显的方法(见下文),但似乎没有任何效果.有什么建议？

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'

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

和其他人一样,我也跟着咔嚓声.但他们有一个缺点:默认情况下,你不能订购它们.幸运的是,有一个解决方案:

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

Answer 4

请注意,添加该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.02ms中的73个查询(管理员中有67个重复查询)

之后:在10.81ms内进行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 或更高版本执行此操作的正确方法是使用display 装饰器

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

您可以使用callable在列表显示中显示您想要的任何内容.它看起来像这样:

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

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

Answer 8

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

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

所以你可以这样做:

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

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

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

作为这里的要点

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

callableadmin_order_field属性是自动定义的。

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

Answer 12

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

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