Czy „list_display” w Django ModelAdmin może wyświetlać atrybuty pól ForeignKey?

296

Mam Personmodel, który ma powiązanie z kluczem obcym Book, który ma wiele pól, ale najbardziej mnie to martwi author(standardowy CharField).

Biorąc to pod uwagę, w moim PersonAdminmodelu chciałbym wyświetlić book.authorza pomocą list_display:

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

Wypróbowałem wszystkie oczywiste metody, ale wydaje się, że nic nie działa.

Jakieś sugestie?

Huuuze
źródło

Odpowiedzi:

472

Jako kolejną opcję możesz wykonać wyszukiwania, takie jak:

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'
imjoevasquez
źródło
Nie powinno być oba get_author, ponieważ to właśnie do tego zwracany jest ciąg znaków (i krótki opis)? Lub zmień argument formatu ciągu na obj.book.reviews?
Carl G,
1
@AnatoliyArkhipov, istnieje sposób (na podstawie odpowiedzi Terr ). Zaktualizowałem kod w tej odpowiedzi.
Denilson Sá Maia,
dlaczego nie możesz po prostu mieć author = ForeignKey(Author)modelu książki list_display = ('author')?
alias51
3
Powoduje to jedno zapytanie na wiersz wyświetlane w
adminie
1
@marcelm po to select_relatedjest. get_queryset()z UserAdminbędą musiały być zastąpione.
interDist
142

Pomimo wszystkich świetnych odpowiedzi powyżej i ponieważ byłem nowy w Django, nadal utknąłem. Oto moje wyjaśnienie z bardzo początkującej perspektywy.

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 (Niepoprawny sposób) - myślisz, że to zadziałałoby, używając odniesienia do „model__field”, ale nie działa

class BookAdmin(admin.ModelAdmin):
    model = Book
    list_display = ['title', 'author__name', ]

admin.site.register(Book, BookAdmin)

admin.py (poprawny sposób) - w ten sposób odwołujesz się do nazwy klucza obcego w sposób 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)

Aby uzyskać dodatkowe informacje, zobacz link do modelu Django tutaj

Będzie
źródło
3
w polu zamówienia nie powinno być = „autor__nazwa”?
Yunti,
2
Działa to doskonale, ale nie jestem pewien, dlaczego. objjest BookAdmin?
Steven Church,
Łał. Zajęło mi godzinę w Internecie, aby to znaleźć. Należy to
wyjaśnić w
67

Podobnie jak reszta, ja też poszedłem z kalabrami. Ale mają jedną wadę: domyślnie nie można na nich zamówić. Na szczęście istnieje na to rozwiązanie:

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'
Arjen
źródło
powinien być podpis metodydef author(self, obj):
sheats
Kiedy robiłem komentarz, tak nie było, ale wydaje się, że od wersji 1.8 metoda przekazuje obiekt do niego. Zaktualizowałem swoją odpowiedź.
Arjen,
46

Pamiętaj, że dodanie get_authorfunkcji spowolniłoby wyświetlanie listy w adminie, ponieważ pokazanie każdej osobie spowodowałoby zapytanie SQL.

Aby tego uniknąć, musisz zmodyfikować get_querysetmetodę w PersonAdmin, na przykład:

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

Przed: 73 zapytań w 36,02 ms (67 zduplikowanych zapytań w panelu administratora)

Po: 6 zapytań w 10,81 ms

Głód
źródło
3
Jest to naprawdę ważne i powinno być zawsze realizowane
xleon
To jest naprawdę ważne. Alternatywnie, jeśli ktoś zejdzie __str__trasą, po prostu dodaj klucz obcy do list_displayilist_select_related
Scratch'N'Purr
22

Zgodnie z dokumentacją można wyświetlić tylko __unicode__reprezentację klucza obcego:

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

Wydaje się dziwne, że nie obsługuje 'book__author'formatu stylu, który jest używany wszędzie indziej w DB API.

Okazuje się, że jest bilet na tę funkcję , która jest oznaczona jako Nie naprawi.

Jonny Buchanan
źródło
11
@Mermoz naprawdę? Wygląda na to, że bilet pozostaje ustawiony jako wontfix. To też nie działa (Django 1.3)
Dave
1.11 nadal nie istnieje. Robiłem django od kilkunastu lat i nigdy tego nie pamiętam :(
Aaron McMillin
12

Właśnie opublikowałem fragment kodu, który sprawia, że ​​admin.ModelAdmin obsługuje składnię „__”:

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

Możesz więc zrobić:

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

Zasadniczo polega to na wykonaniu tej samej czynności opisanej w innych odpowiedziach, ale automatycznie zajmuje się (1) ustawieniem pola admin_order_field (2) ustawieniem short_description i (3) modyfikacją zestawu zapytań, aby uniknąć trafienia do bazy danych dla każdego wiersza.

Jack Cushman
źródło
Bardzo podoba mi się ten pomysł, ale wydaje się, że już nie działa z najnowszymi wersjami django:AttributeError: type object 'BaseModel' has no attribute '__metaclass__'
Vincent van Leeuwen
10

Możesz pokazać, co chcesz na ekranie listy, używając kalendarza. Wyglądałoby to tak:

def book_author (obiekt):
  zwraca object.book.author

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

źródło
Ten jest przydatny w sytuacjach, w których wiele różnych modeli często wywołuje ten sam atrybut; czy jest obsługiwany w wersji 1.3+?
kagali-san
3
Problemem jest ilość zapytań SQL wykonanych na końcu. Dla każdego obiektu na liście wykona zapytanie. Właśnie dlatego atrybut „field__attribute” byłby bardzo przydatny, ponieważ z pewnością Django rozdzieliłoby to tylko na jedno zapytanie SQL. Dziwne, że nie ma już tego wsparcia.
emyller
7

Ten jest już zaakceptowany, ale jeśli istnieją inne manekiny (takie jak ja), które nie otrzymały go natychmiast z obecnie przyjętej odpowiedzi , oto nieco więcej szczegółów.

Klasa modelu, do której odwołuje się ForeignKeypotrzeba, musi zawierać w sobie __unicode__metodę, jak tutaj:

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

    def __unicode__(self):
        return self.name

To dla mnie stanowiło różnicę i powinno mieć zastosowanie do powyższego scenariusza. Działa to w Django 1.0.2.

Społeczność
źródło
4
Na Pythonie 3 byłoby to def __str__(self):.
Martlark,
5

Jeśli masz wiele pól atrybutów relacji do użycia list_displayi nie chcesz tworzyć funkcji (i jej atrybutów) dla każdego z nich, brudne, ale proste rozwiązanie zastąpiłoby metodę ModelAdmininstace __getattr__, tworząc na żądanie kallaby:

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

Jak istota tutaj

Wywoływalne especial cechy jak booleani short_descriptionmusi być określone jako ModelAdmincechy, np book__author_verbose_name = 'Author name'i category__is_new_boolean = True.

admin_order_fieldAtrybut wywoływalny jest definiowany automatycznie.

Nie zapomnij użyć atrybutu list_select_related,ModelAdmin aby Django unikał dodatkowych zapytań.

Cauê Thenório
źródło
1
Właśnie wypróbowałem to z instalacją Django 2.2 i działało to dla mnie świetnie, podczas gdy inne podejścia nie działały, z jakiegokolwiek powodu. Zauważ, że obecnie musisz importować redukcję z funools lub gdzie indziej ...
Paul Brackin
5

W PyPI dostępny jest bardzo łatwy w użyciu pakiet, który obsługuje dokładnie to: django-related-admin . Możesz także zobaczyć kod w GitHub .

Korzystanie z tego, co chcesz osiągnąć, jest tak proste, jak:

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

Oba linki zawierają pełne dane dotyczące instalacji i użytkowania, więc nie wkleję ich tutaj na wypadek, gdyby się zmieniły.

Podobnie jak marginesie, jeśli używasz już coś innego niż model.Admin(np używałem SimpleHistoryAdminzamiast), można to zrobić: class MyAdmin(SimpleHistoryAdmin, RelatedFieldAdmin).

Vlad Schnakovszki
źródło
getter_for_related_field nie działa w 1.9, więc wydaje się, że nie jest najlepszym wyborem dla tych, którzy lubią dostosowywać.
GriMel,
4

jeśli spróbujesz w Inline, nie odniesiesz sukcesu, chyba że:

w twoim inline:

class AddInline(admin.TabularInline):
    readonly_fields = ['localname',]
    model = MyModel
    fields = ('localname',)

w twoim modelu (MyModel):

class MyModel(models.Model):
    localization = models.ForeignKey(Localizations)

    def localname(self):
        return self.localization.name
Eyal Ch
źródło
-1

Odpowiedź AlexRobbinsa działała dla mnie, z tym wyjątkiem, że pierwsze dwie linie muszą znajdować się w modelu (być może to założono?) I powinny odnosić się do siebie:

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

Następnie część administracyjna działa dobrze.


źródło
-5

Wolę to:

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

    @staticmethod
    def submodel__field(obj):
        return obj.submodel.field
wieczorek1990
źródło