在 Django admin 中将外键列显示为详细对象的链接

Question

如link-in-django-admin-to-foreign-key-object 中所述，可以将 ForeignKey 字段显示为指向管理员详细信息页面的链接。

总结一下，

class Foo(Model):
    bar = models.ForeignKey(Bar)

class FooAdmin(ModelAdmin):
    list_display = ('link_to_bar',)
    def link_to_bar(self, obj):
        link = urlresolvers.reverse('admin:app_bar_change', args=[obj.bar_id])
        return u'<a href="%s">%s</a>' % (link, obj.bar) if obj.bar else None
    link_to_bar.allow_tags = True

问题是：我们可以更自动地做到这一点吗？例如，向FooAdmin 定义提供一个外键列表，以显示为详细页面的链接：

class FooAdmin(ModelAdmin):
    ...
    list_foreign_key_links = ('bar',)
    ...

我知道这些ModelAdmin 类是通过元类编程生成的。那么，应该是可以的。这样做是一个好的开始？

Answer 1

下面的解决方案使用this answer 但使其可被所有模型重用，避免了向每个管理类添加方法的需要。

示例模型

# models.py
from django.db import models

class Country(models.Model):
    name = models.CharField(max_length=200)
    population = models.IntegerField()

class Career(models.Model):
    name = models.CharField(max_length=200)
    average_salary = models.IntegerField()

class Person(models.Model):
    name = models.CharField(max_length=200)
    age = models.IntegerField()
    country = models.ForeignKey(Country, on_delete=models.CASCADE)
    career = models.ForeignKey(Career, on_delete=models.CASCADE)

示例管理员

# admin.py
from django.utils.html import format_html
from django.urls import reverse

from .models import Person


def linkify(field_name):
    """
    Converts a foreign key value into clickable links.
    
    If field_name is 'parent', link text will be str(obj.parent)
    Link will be admin url for the admin url for obj.parent.id:change
    """
    def _linkify(obj):
        linked_obj = getattr(obj, field_name)
        if linked_obj is None:
            return '-'
        app_label = linked_obj._meta.app_label
        model_name = linked_obj._meta.model_name
        view_name = f'admin:{app_label}_{model_name}_change'
        link_url = reverse(view_name, args=[linked_obj.pk])
        return format_html('<a href="{}">{}</a>', link_url, linked_obj)

    _linkify.short_description = field_name  # Sets column name
    return _linkify



@admin.register(Person)
class PersonAdmin(admin.ModelAdmin):
    list_display = [
        "name",
        "age",
        linkify(field_name="country"),
        linkify(field_name="career"),
    ]

---

结果

给定一个名为 app 的应用程序和一个 Person 实例 Person(name='Adam' age=20)，其国家和职业外键值的 ID 为 123 和 456， 列表结果将是：

| Name | Age |                          Country                          |...|
|------|-----|-----------------------------------------------------------|...|
| Adam |  20 | <a href="/admin/app/country/123">Country object(123)</a>  |...|

（继续）

|...|                          Career                         |
|---|---------------------------------------------------------|
|...| <a href="/admin/app/career/456">Career object(456)</a>  |

Answer 2

一个好的开始是查看BaseModelAdmin 和ModelAdmin 的来源。尝试找出 ModelAdmin 如何生成默认链接。 扩展ModelAdmin，添加生成任意外键链接的方法，看看ChangeList是如何生成变更列表的。

我还建议您使用format_html 来呈现链接，这使得link_to_bar.allow_tags = True 变得不必要：

from django.utils.html import format_html

class FooAdmin(ModelAdmin):
    list_display = ('link_to_bar', )
    def link_to_bar(self, obj):
        link = urlresolvers.reverse('admin:app_bar_change', args=[obj.bar_id])
        return format_html('<a href="{}">{}</a>', link, obj.bar) if obj.bar else None

Answer 3

对已接受的答案稍作修改。不一定更好，但实现了cmets中的一些建议：

from django.contrib.contenttypes.models import ContentType
from django.urls import reverse
from django.utils.html import format_html


def linkify(field_name):
    def _linkify(obj):
        content_type = ContentType.objects.get_for_model(obj)
        app_label = content_type.app_label
        linked_obj = getattr(obj, field_name)
        linked_content_type = ContentType.objects.get_for_model(linked_obj)
        model_name = linked_content_type.model
        view_name = f"admin:{app_label}_{model_name}_change"
        link_url = reverse(view_name, args=[linked_obj.pk])
        return format_html('<a href="{}">{}</a>', link_url, linked_obj)

    _linkify.short_description = field_name.replace("_", " ").capitalize()
    return _linkify