ChatGPT解决这个技术问题 Extra ChatGPT

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

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

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

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

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

有什么建议么?


s
serghei

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

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

@AnatoliyArkhipov,有一种方法(基于 Terr answer)。我已经更新了这个答案中的代码。
这会导致在管理员中显示每行一个查询:(
@marcelm 这就是 select_related 的用途。 UserAdminget_queryset() 必须被覆盖。
对于 Django 版本 > 3.2,请参考这个答案:stackoverflow.com/a/67746847/11605100
显示装饰器定义为 @admin.display(....)
s
shuboy2014

尽管上面有所有很好的答案,而且由于我是 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 模型链接 here


订单字段不应该是 = 'author__name' 吗?
这完美地工作,但我不确定为什么。 objBookAdmin
哇。我在网上花了一个小时才找到这个。这应该在 Django 文档中更清楚地说明
谢谢@威尔。您是否意识到对于 list_display,必须分配 [..., 'get_name', ] 但对于 search_field,它不起作用,而是必须分配 [..., 'author__name', ]?这对我来说似乎违反直觉,不是吗?
A
Arjen

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

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

方法签名应该是 def author(self, obj):
当我发表评论时,情况并非如此,但似乎从 1.8 版开始,该方法将对象传递给它。我已经更新了我的答案。
H
Hunger

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

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

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

之前:73 次查询在 36.02 毫秒(67 次重复查询在管理员)之后:6 次查询在 10.81 毫秒


这非常重要,应该始终实施
这确实很重要。或者,如果要走 __str__ 路线,只需将外键添加到 list_displaylist_select_related
“list_select_related”是标题问题的最佳解决方案
C
Cesar Canassa

对于 Django >= 3.2

使用 Django 3.2 或更高版本的正确方法是使用 display decorator

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

M
Mechanical snail

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

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

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

原来有 a ticket for this feature,它被标记为不会修复。


@Mermoz 真的吗?看来票仍然设置为 wontfix。它似乎也不起作用(Django 1.3)
1.11 仍然不存在。做 django 十几年了,我从来不记得这个 :(
J
Jack Cushman

我刚刚发布了一个片段,使 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__'
佚名

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

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

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

这适用于许多不同模型经常调用相同属性的情况; 1.3+ 支持吗?
问题在于最终完成的 SQL 查询量。对于列表中的每个对象,它都会进行查询。这就是为什么 'field__attribute' 会非常方便的原因,因为 Django 肯定会将其扩展到一个 SQL 查询。奇怪的是已经没有支持了。
V
Vlad Schnakovszki

PyPI 中提供了一个非常易于使用的包来处理这个问题:django-related-admin。您也可以see the code in GitHub

使用它,您想要实现的目标很简单:

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

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

顺便说一句,如果您已经在使用 model.Admin 以外的东西(例如,我使用的是 SimpleHistoryAdmin),您可以这样做:class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin)


getter_for_related_field 在 1.9 中不起作用,因此对于喜欢自定义的人来说,这似乎不是最佳选择。
这个库是最新的,在 Django 3.2 上非常适合我们
C
Community

这个已经被接受了,但是如果还有其他没有立即从 presently accepted answer 得到它的假人(比如我),这里有更多细节。

ForeignKey 引用的模型类需要在其中包含一个 __unicode__ 方法,如下所示:

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

    def __unicode__(self):
        return self.name

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


在 python 3 上,这将是 def __str__(self):
C
Cauê Thenório

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

作为gist here

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

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

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


刚刚使用 Django 2.2 安装进行了尝试,它对我来说效果很好,而其他方法却没有,无论出于何种原因。请注意,现在您需要从 functools 或其他地方导入 reduce ......
E
Eyal Ch

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

E
Eyong Kevin Enowanyo

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

佚名

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

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

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


w
wieczorek1990

我更喜欢这个:

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

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