Django ModelAdminの「list_display」は、ForeignKeyフィールドの属性を表示できますか?


296

私が持っているPersonに外部キー関係があるモデルBookフィールドの数を持っている、が、私はほとんどが心配ですauthor(標準CharFieldです)。

そうは言っても、私のPersonAdminモデルでは、次をbook.author使用して表示したいと思いますlist_display

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

私はそうするための明白な方法をすべて試しましたが、何もうまくいかないようです。

助言がありますか?

回答:


472

別のオプションとして、次のようなルックアップを行うことができます。

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'

get_author返す文字列(および簡単な説明)が実際に参照しているので、両方がであってはなりませんか?または、文字列フォーマット引数をobj.book.reviews?に変更します。
Carl G

1
@AnatoliyArkhipov、方法があります(Terrの回答に基づく)。この回答のコードはすでに更新しています。
DenilsonSáMaia 14

なぜauthor = ForeignKey(Author)本のモデルに入れられないのですlist_display = ('author')か?
alias51

3
これにより、admin :(
marcelm

1
@marcelmはそのためのものselect_relatedです。のget_queryset()UserAdmin上書きする必要があります。
interDist 2017

142

上記のすべてのすばらしい答えにもかかわらず、私は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モデルリンクを参照してください。


3
注文フィールドは= 'author__name'であってはなりませんか?
ユンティ2015年

2
これは完全に機能しますが、理由はわかりません。objありますかBookAdmin
スティーブン教会

ワオ。これを見つけるためにウェブ上で1時間かかった。これはDjangoのドキュメントでもっと明確にすべきです
セブンアース

67

残りのように、私もcallablesで行きました。ただし、欠点が1つあります。デフォルトでは、それらを注文することはできません。幸い、そのための解決策があります。

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'

メソッドのシグネチャは次のようになりますdef author(self, obj):
Sheats

私がコメントしたときはそうではありませんでしたが、バージョン1.8以降、メソッドはオブジェクトを渡されるようです。回答を更新しました。
Arjen

46

get_author各ユーザーを表示するとSQLクエリが実行されるため、関数を追加すると管理者のlist_displayが遅くなることに注意してください。

これを回避するにget_querysetは、PersonAdminでメソッドを変更する必要があります。次に例を示します。

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

以前:36.02msで73クエリ(管理で67の重複クエリ)

後:10.81ミリ秒で6つのクエリ


3
これは本当に重要であり、常に実装する必要があります
xleon 2017

これは確かに重要です。または、__str__ルートを下る場合は、外部キーをlist_displayandに追加するだけlist_select_related
Scratch'N'Purr

22

ドキュメントによると、__unicode__ForeignKeyの表現のみを表示できます。

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

'book__author'DB APIの他の場所で使用されているスタイル形式をサポートしていないのは奇妙に思われます。

この機能のチケットがあることがわかりました。これは修正されていません。


11
@Mermozは本当に?チケットはwontfixとして設定されたままのようです。動作していないようです(Django 1.3)
Dave

1.11はまだ存在しません。12年間ジャンゴをやっていて、これを覚えたことはありません:(
Aaron McMillin

12

admin.ModelAdminが '__'構文をサポートするスニペットを投稿しました:

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

だからあなたはできる:

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

これは基本的に他の回答で説明されているのと同じことを行うだけですが、(1)admin_order_fieldの設定(2)short_descriptionの設定と(3)各行のデータベースヒットを回避するためのクエリセットの変更を自動的に処理します。


このアイデアたくさんのように私が、それは、最近のDjangoのverionsでもう動作していないよう:AttributeError: type object 'BaseModel' has no attribute '__metaclass__'
ヴィンセント・ヴァン・Leeuwenの

10

呼び出し可能オブジェクトを使用して、リスト表示で必要なものをすべて表示できます。次のようになります。

def book_author(object):
  object.book.authorを返す

クラスPersonAdmin(admin.ModelAdmin):
  list_display = [book_author、]

これは、多くの異なるモデルが同じ属性を呼び出すことが多い状況に適しています。1.3以降でサポートされていますか?
カガリさん2011

3
これに関する問題は、最後に行われるSQLクエリの量です。リスト内のオブジェクトごとに、クエリが作成されます。確かにDjangoはそれを1つのSQLクエリだけに広げるため、 'field__attribute'が非常に便利なのはこのためです。これはすでにサポートされていません。
emyller 2012

7

これは既に受け入れられていますが、現在受け入れられている回答からすぐに得られなかったダミーが他にもいる場合(私のように)、ここにもう少し詳しく説明します。

以下のように、ForeignKeyニーズによって参照されるモデルクラスには、__unicode__メソッドが含まれている必要があります。

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

    def __unicode__(self):
        return self.name

それは私にとって違いをもたらし、そして上記のシナリオに当てはまるはずです。これはDjango 1.0.2で動作します。


4
Python 3では、これはになりますdef __str__(self):
Martlark、2016

5

使用するリレーション属性フィールドがたくさんありlist_display、それぞれに関数(およびその属性)を作成したくない場合は、単純な解決策としてModelAdminインスタンス__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として定義する必要があります。ModelAdminbook__author_verbose_name = 'Author name'category__is_new_boolean = True

呼び出し可能admin_order_field属性は自動的に定義されます。

Djangoに追加のクエリを回避させるために、でlist_select_related属性を使用することを忘れないでくださいModelAdmin


1
Django 2.2のインストールでこれを試してみてください。理由は何であれ、他のアプローチではうまくいかなかったのに、私にとってはうまくいきました。最近ではfunctoolsまたは他の場所からreduceをインポートする必要があることに注意してください...
Paul Brackin

5

それを正確に処理する非常に使いやすいパッケージがPyPIで利用可能です:django-related-adminGitHubでコードを確認することもできます

これを使用すると、達成したいことは次のように簡単です。

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

どちらのリンクにもインストールと使用法の詳細が含まれているため、変更された場合にここに貼り付けません。

余談ですが、もしあなたが既に他のものを使っているならmodel.Admin(例えばSimpleHistoryAdmin、代わりに使っていました)、これを行うことができます:class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin)


getter_for_related_fieldは1.9では機能しないため、カスタマイズを好む人には最適ではないようです。
GriMel

4

インラインで試しても、以下の場合を除いて成功しません。

あなたのインラインで:

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

-1

AlexRobbinsの答えは私にとってはうまくいきましたが、最初の2行がモデル内にある必要があることを除けば(おそらくこれは想定されているのでしょうか?)、自分自身を参照する必要があります。

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

その後、管理部分はうまく機能します。


-5

私はこれが好きです:

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

    @staticmethod
    def submodel__field(obj):
        return obj.submodel.field
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.