Django-Tutorial Teil 4: Django-Admin-Seite

Die Django-Admin-Anwendung kann Ihre Modelle verwenden, um automatisch einen Website-Bereich zu erstellen, den Sie zum Erstellen, Anzeigen, Aktualisieren und Löschen von Datensätzen verwenden können. Dies kann während der Entwicklung viel Zeit sparen, da es sehr einfach ist, Ihre Modelle zu testen und ein Gefühl dafür zu bekommen, ob Sie die richtigen Daten haben. Die Admin-Anwendung kann auch für die Datenverwaltung in der Produktion nützlich sein, je nach Art der Website. Das Django-Projekt empfiehlt jedoch, sie nur für die interne Datenverwaltung zu verwenden (d.h. nur für die Nutzung durch Administratoren oder Personen innerhalb Ihrer Organisation), da der modellzentrierte Ansatz nicht unbedingt die bestmögliche Benutzeroberfläche für alle Benutzer darstellt und viele unnötige Details über die Modelle preisgibt.

Die gesamte Konfiguration, die zum Einbinden der Admin-Anwendung in Ihre Website erforderlich war, wurde automatisch erstellt, als Sie das Gerüstprojekt erstellt haben (für Informationen über die tatsächlichen Abhängigkeiten siehe die Django-Dokumentation hier). Daher müssen Sie lediglich Ihre Modelle registrieren, um sie zur Admin-Anwendung hinzuzufügen. Am Ende dieses Artikels geben wir eine kurze Demonstration, wie Sie den Admin-Bereich weiter konfigurieren können, um unsere Modelldaten besser darzustellen.

Nachdem wir die Modelle registriert haben, zeigen wir, wie Sie einen neuen "Superuser" erstellen, sich auf der Seite anmelden und einige Bücher, Autoren, Buchinstanzen und Genres erstellen können. Diese werden nützlich sein, um die Ansichten und Templates zu testen, die wir im nächsten Tutorial erstellen werden.

Öffnen Sie zuerst admin.py in der Katalog-Anwendung (/django-locallibrary-tutorial/catalog/admin.py). Derzeit sieht es so aus – beachten Sie, dass es bereits django.contrib.admin importiert:

from django.contrib import admin

# Register your models here.

Registrieren Sie die Modelle, indem Sie den folgenden Text ans Ende der Datei kopieren. Dieser Code importiert die Modelle und ruft dann admin.site.register auf, um jedes von ihnen zu registrieren.

from .models import Author, Genre, Book, BookInstance, Language

admin.site.register(Book)
admin.site.register(Author)
admin.site.register(Genre)
admin.site.register(BookInstance)
admin.site.register(Language)

Dies ist der einfachste Weg, um ein Modell oder mehrere Modelle auf der Seite zu registrieren. Die Admin-Seite ist stark anpassbar, und wir werden später im Artikel mehr über die anderen Möglichkeiten der Registrierung Ihrer Modelle sprechen.

Um sich auf der Admin-Seite anzumelden, benötigen wir ein Benutzerkonto mit aktiviertem Mitarbeiter-Status. Um Datensätze anzuzeigen und zu erstellen, benötigen wir außerdem, dass dieser Benutzer Berechtigungen hat, um alle unsere Objekte zu verwalten. Sie können ein "Superuser"-Konto erstellen, das vollen Zugriff auf die Seite und alle erforderlichen Berechtigungen hat, indem Sie manage.py verwenden.

Führen Sie den folgenden Befehl im selben Verzeichnis wie manage.py aus, um den Superuser zu erstellen. Sie werden aufgefordert, einen Benutzernamen, eine E-Mail-Adresse und ein starkes Passwort einzugeben.

python3 manage.py createsuperuser

Sobald dieser Befehl abgeschlossen ist, wurde ein neuer Superuser zur Datenbank hinzugefügt. Starten Sie nun den Entwicklungsserver neu, damit wir die Anmeldung testen können:

python3 manage.py runserver

Um sich auf der Seite anzumelden, öffnen Sie die /admin-URL (z.B. http://127.0.0.1:8000/admin) und geben Sie Ihre neuen Superuser-Benutzer- und Passwort-Zugangsdaten ein (Sie werden auf die Login-Seite weitergeleitet und dann nach Eingabe Ihrer Daten zurück zur /admin-URL).

Dieser Teil der Seite zeigt alle unsere Modelle, gruppiert nach installierter Anwendung. Sie können auf einen Modellnamen klicken, um zu einem Bildschirm zu gelangen, der alle zugehörigen Datensätze auflistet, und Sie können auf diese Datensätze klicken, um sie zu bearbeiten. Sie können auch direkt auf den Link Hinzufügen neben jedem Modell klicken, um einen Datensatz dieses Typs zu erstellen.

Klicken Sie auf den Hinzufügen-Link rechts von Bücher, um ein neues Buch zu erstellen (dies zeigt einen Dialog wie den unten). Beachten Sie, wie die Titel jedes Feldes, der verwendete Widget-Typ und der help_text (falls vorhanden) den Werten entsprechen, die Sie im Modell angegeben haben.

Geben Sie Werte für die Felder ein. Sie können neue Autoren oder Genres erstellen, indem Sie auf die +-Schaltfläche neben den jeweiligen Feldern drücken (oder bestehende Werte aus den Listen auswählen, wenn Sie sie bereits erstellt haben). Wenn Sie fertig sind, können Sie SPEICHERN, Speichern und ein weiteres hinzufügen oder Speichern und weiter bearbeiten drücken, um den Datensatz zu speichern.

Wenn Sie fertig sind, Bücher hinzuzufügen, klicken Sie auf den Home-Link im oberen Lesezeichen, um zurück zur Haupt-Admin-Seite zu gelangen. Klicken Sie dann auf den Bücher-Link, um die aktuelle Liste der Bücher anzuzeigen (oder auf einen der anderen Links, um andere Modelllisten anzuzeigen). Wenn Sie nun einige Bücher hinzugefügt haben, sieht die Liste vielleicht ähnlich aus wie der untenstehende Screenshot. Der Titel jedes Buches wird angezeigt; dies ist der Wert, der in der __str__()-Methode des Buchmodells zurückgegeben wird, die wir im letzten Artikel spezifiziert haben.

Aus dieser Liste können Sie Bücher löschen, indem Sie das Kontrollkästchen neben dem Buch auswählen, das Sie nicht möchten, die löschen...-Aktion aus der Aktion-Dropdownliste auswählen und dann die Los-Schaltfläche drücken. Sie können auch neue Bücher hinzufügen, indem Sie die BUCH HINZUFÜGEN-Schaltfläche drücken.

Sie können ein Buch bearbeiten, indem Sie auf dessen Namen im Link klicken. Die Bearbeitungsseite für ein Buch, die unten gezeigt wird, ist fast identisch mit der "Hinzufügen"-Seite. Die Hauptunterschiede sind der Seitentitel (Buch ändern) und die Hinzufügung von Löschen, VERLAUF und AUF WEBSITE ANZEIGEN-Schaltflächen (diese letzte Schaltfläche erscheint, weil wir die get_absolute_url()-Methode in unserem Modell definiert haben).

Navigieren Sie nun zurück zur Startseite (mit dem Link Home im Breadcrumb-Trail) und betrachten Sie dann die Autoren- und Genre-Listen — Sie sollten bereits eine ganze Menge erstellt haben, als Sie die neuen Bücher hinzugefügt haben, aber fühlen Sie sich frei, einige weitere hinzuzufügen.

Was Sie nicht haben werden, sind Buchexemplare, weil diese nicht von Büchern erstellt werden (obwohl Sie ein Book von einem BookInstance erstellen können — das ist die Natur des ForeignKey-Feldes). Navigieren Sie zurück zur Startseite und drücken Sie den zugehörigen Hinzufügen-Button, um das Bildschirm Buchinstanz hinzufügen unten anzuzeigen. Beachten Sie die große, weltweit eindeutige ID, die verwendet werden kann, um ein einzelnes Exemplar eines Buches in der Bibliothek zu identifizieren.

Erstellen Sie eine Reihe dieser Datensätze für jedes Ihrer Bücher. Setzen Sie den Status als Verfügbar für mindestens einige Datensätze und Ausgeliehen für andere. Wenn der Status nicht Verfügbar ist, dann setzen Sie auch ein zukünftiges Fälligkeitsdatum.

Das war's! Sie haben nun gelernt, wie man die Admin-Seite einrichtet und verwendet. Sie haben auch Datensätze für Book, BookInstance, Genre, Language und Author erstellt, die wir verwenden können, sobald wir unsere eigenen Ansichten und Vorlagen erstellen.

Django leistet gute Arbeit bei der Erstellung einer grundlegenden Admin-Seite unter Verwendung der Informationen aus den registrierten Modellen:

• Jedes Modell hat eine Liste von einzelnen Datensätzen, die durch den mit der __str__()-Methode des Modells erstellten String identifiziert sind und in einem Detailansichtsformular zum Bearbeiten verknüpft sind. Standardmäßig hat diese Ansicht oben ein Aktionsmenü, mit dem Sie Massenlöschvorgänge an Datensätzen durchführen können.
• Die Modellausschnittformulare zum Bearbeiten und Hinzufügen von Datensätzen enthalten alle im Modell enthaltenen Felder, die vertikal in deren Deklarationsreihenfolge angeordnet sind.

Sie können die Oberfläche weiter anpassen, um sie noch benutzerfreundlicher zu machen. Einige Dinge, die Sie tun können, sind:

• Listenansichten:

  • Zusätzliche Felder/Informationen zu jedem Datensatz hinzufügen.
  • Filter hinzufügen, um auszuwählen, welche Datensätze aufgelistet werden, basierend auf Datum oder einem anderen Auswahlwert (z.B. Buchausleihstatus).
  • Zusätzliche Optionen zum Aktionsmenü in Listenansichten hinzufügen und wählen, wo dieses Menü im Formular angezeigt wird.

• Detailansichten

  • Wählen, welche Felder angezeigt (oder ausgeschlossen), in welcher Reihenfolge, gruppiert, bearbeitet werden können, welches Widget verwendet wird, Ausrichtung usw.
  • Verwandte Felder zu einem Datensatz hinzufügen, um eine Inline-Bearbeitung zu ermöglichen (z.B. die Möglichkeit hinzufügen, Buchdatensätze hinzuzufügen und zu bearbeiten, während Sie deren Autorendatensatz erstellen).

In diesem Abschnitt werden wir uns einige Änderungen ansehen, die die Oberfläche für unsere LocalLibrary verbessern, einschließlich der Hinzufügung weiterer Informationen zu Book- und Author-Modelllisten und der Verbesserung des Layouts ihrer Bearbeitungsansichten. Wir werden die Präsentation des Language- und Genre-Modells nicht ändern, da sie jeweils nur ein Feld haben, sodass kein wirklicher Nutzen besteht!

Sie finden eine vollständige Referenz aller Anpassungsmöglichkeiten der Admin-Seite in Die Django Admin-Seite (Django-Dokumentation).

Um zu ändern, wie ein Modell in der Admin-Oberfläche angezeigt wird, definieren Sie eine ModelAdmin-Klasse (die das Layout beschreibt) und registrieren es mit dem Modell.

Beginnen wir mit dem Author-Modell. Öffnen Sie admin.py in der Kataloganwendung (/django-locallibrary-tutorial/catalog/admin.py). Kommentieren Sie Ihre ursprüngliche Registrierung für das Author-Modell aus (prefixieren Sie sie mit einem #):

# admin.site.register(Author)

Fügen Sie nun wie unten gezeigt eine neue AuthorAdmin und Registrierung hinzu.

# Define the admin class
class AuthorAdmin(admin.ModelAdmin):
    pass

# Register the admin class with the associated model
admin.site.register(Author, AuthorAdmin)

Nun fügen wir ModelAdmin-Klassen für Book und BookInstance hinzu. Wir müssen erneut die ursprünglichen Registrierungen kommentieren:

# admin.site.register(Book)
# admin.site.register(BookInstance)

Nun, um die neuen Modelle zu erstellen und zu registrieren; zu Vorführzwecken werden wir stattdessen den @register-Dekorator verwenden, um die Modelle zu registrieren (das macht genau dasselbe wie die admin.site.register()-Syntax):

# Register the Admin classes for Book using the decorator
@admin.register(Book)
class BookAdmin(admin.ModelAdmin):
    pass

# Register the Admin classes for BookInstance using the decorator
@admin.register(BookInstance)
class BookInstanceAdmin(admin.ModelAdmin):
    pass

Derzeit sind alle unsere Admin-Klassen leer (siehe pass), sodass sich das Admin-Verhalten nicht geändert hat! Wir können diese nun erweitern, um unser modellspezifisches Admin-Verhalten zu definieren.

Die LocalLibrary listet derzeit alle Autoren mithilfe des Objektnamens auf, der aus der Modell-__str__()-Methode generiert wird. Dies ist in Ordnung, wenn Sie nur wenige Autoren haben, aber sobald Sie viele haben, können Sie möglicherweise Duplikate haben. Um diese zu unterscheiden oder einfach, weil Sie interessantere Informationen zu jedem Autor anzeigen möchten, können Sie list_display verwenden, um der Ansicht weitere Felder hinzuzufügen.

Ersetzen Sie Ihre AuthorAdmin-Klasse durch den unten stehenden Code. Die anzuzeigenden Feldnamen in der Liste werden in einem Tupel in der angegebenen Reihenfolge deklariert (diese sind dieselben Namen, die Sie in Ihrem ursprünglichen Modell angegeben haben).

class AuthorAdmin(admin.ModelAdmin):
    list_display = ('last_name', 'first_name', 'date_of_birth', 'date_of_death')

Navigieren Sie jetzt zur Autorenliste auf Ihrer Website. Die oben genannten Felder sollten jetzt angezeigt werden, wie hier:

Für unser Book-Modell werden wir zusätzlich den author und genre anzeigen. Der author ist ein ForeignKey-Feld (eins-zu-viele-Beziehung) und wird daher durch den __str__()-Wert für den zugehörigen Datensatz dargestellt. Ersetzen Sie die BookAdmin-Klasse durch die unten stehende Version.

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'display_genre')

Leider können wir das genre-Feld nicht direkt in list_display angeben, da es sich um ein ManyToManyField handelt (Django verhindert dies, da dies hohe Datenbankzugriffskosten bedeuten würde). Stattdessen definieren wir eine display_genre-Funktion, um die Informationen als String zu erhalten (das ist die Funktion, die wir oben aufgerufen haben; wir werden sie unten definieren).

Fügen Sie den folgenden Code in Ihr Book-Modell (models.py) ein. Dies erstellt einen String aus den ersten drei Werten des genre-Feldes (falls vorhanden) und erstellt eine short_description, die im Admin-Bereich für diese Methode verwendet werden kann.

def display_genre(self):
    """Create a string for the Genre. This is required to display genre in Admin."""
    return ', '.join(genre.name for genre in self.genre.all()[:3])

display_genre.short_description = 'Genre'

Nachdem Sie das Modell und den aktualisierten Admin gespeichert haben, öffnen Sie Ihre Website und gehen Sie zur Bücher-Liste; Sie sollten eine Bücherliste wie die untenstehende sehen:

Das Genre-Modell (und das Language-Modell, falls Sie eines definiert haben) haben beide ein einzelnes Feld, sodass es keinen Grund gibt, ein zusätzliches Modell zu erstellen, um weitere Felder anzuzeigen.

Sobald Sie viele Elemente in einer Liste haben, kann es nützlich sein, die Möglichkeit zu haben, die anzuzeigenden Elemente zu filtern. Dies wird erreicht, indem Felder im list_filter-Attribut aufgelistet werden. Ersetzen Sie Ihre aktuelle BookInstanceAdmin-Klasse durch den unten stehenden Codeausschnitt.

class BookInstanceAdmin(admin.ModelAdmin):
    list_filter = ('status', 'due_back')

Die Listenansicht wird nun ein Filterfeld rechts enthalten. Beachten Sie, wie Sie Daten und Status auswählen können, um die Werte zu filtern:

Standardmäßig legen die Detailansichten alle Felder vertikal in der Reihenfolge ihrer Deklaration im Modell aus. Sie können die Deklarationsreihenfolge, welche Felder angezeigt (oder ausgeschlossen) werden, ob Abschnitte verwendet werden, um die Informationen zu organisieren, ob Felder horizontal oder vertikal angezeigt werden und sogar, welche Bearbeitungs-Widgets in den Admin-Formularen verwendet werden, ändern.

Welche Felder angezeigt werden und wie sie angeordnet sind steuern

Aktualisieren Sie Ihre AuthorAdmin-Klasse, um die fields-Zeile hinzuzufügen, wie unten gezeigt:

class AuthorAdmin(admin.ModelAdmin):
    list_display = ('last_name', 'first_name', 'date_of_birth', 'date_of_death')

    fields = ['first_name', 'last_name', ('date_of_birth', 'date_of_death')]

Das fields-Attribut listet nur jene Felder auf, die im Formular angezeigt werden sollen, in der Reihenfolge. Felder werden standardmäßig vertikal angezeigt, aber horizontal angezeigt, wenn Sie sie in einem Tupel gruppieren (wie die "date"-Felder oben gezeigt).

Auf Ihrer Website gehen Sie zur Detailansicht des Autors – sie sollte jetzt wie unten gezeigt erscheinen:

Die Detailansicht unterteilen

Sie können "Abschnitte" hinzufügen, um verwandte Modellinformationen innerhalb des Detailformulars zu gruppieren, indem Sie das fieldsets-Attribut verwenden.

Im BookInstance-Modell haben wir Informationen darüber, was das Buch ist (d.h. name, imprint und id) und wann es verfügbar sein wird (status, due_back). Wir können diese unserem BookInstanceAdmin hinzufügen, wie unten gezeigt, indem Sie das fieldsets-Attribut verwenden.

@admin.register(BookInstance)
class BookInstanceAdmin(admin.ModelAdmin):
    list_filter = ('status', 'due_back')

    fieldsets = (
        (None, {
            'fields': ('book', 'imprint', 'id')
        }),
        ('Availability', {
            'fields': ('status', 'due_back')
        }),
    )

Jeder Abschnitt hat einen eigenen Titel (oder None, wenn Sie keinen Titel möchten) und ein zugehöriges Tupel von Feldern in einem Wörterbuch – das Format ist kompliziert zu beschreiben, aber ziemlich einfach zu verstehen, wenn Sie sich den Codeausschnitt unmittelbar oben ansehen.

Gehen Sie jetzt zu einer Buchinstanzansicht auf Ihrer Website; das Formular sollte wie unten gezeigt erscheinen:

Manchmal kann es sinnvoll sein, zugehörige Datensätze gleichzeitig hinzufügen zu können. Zum Beispiel kann es sinnvoll sein, sowohl die Buchinformationen als auch Informationen über die spezifische Exemplare, die Sie haben, auf derselben Detailseite zu haben.

Sie können dies tun, indem Sie Inlines von Typ TabularInline (horizontales Layout) oder StackedInline (vertikales Layout, genau wie das Standardmodell-Layout) deklarieren. Sie können die BookInstance-Informationen inline zu unserem Book-Detail hinzufügen, indem Sie inlines in Ihrem BookAdmin angeben:

class BooksInstanceInline(admin.TabularInline):
    model = BookInstance

@admin.register(Book)
class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'display_genre')

    inlines = [BooksInstanceInline]

Navigieren Sie jetzt zu einer Ansicht für ein Book auf Ihrer Website – unten sollten Sie nun die Buchexemplare sehen, die sich auf dieses Buch beziehen (unmittelbar unter den Feldern des Buch-Genres):

In diesem Fall haben wir nur unsere tabellarische Inline-Klasse deklariert, die einfach alle Felder vom inline Modell hinzufügt. Sie können alle Arten von zusätzlichen Informationen für das Layout angeben, einschließlich der anzuzeigenden Felder, ihrer Reihenfolge, ob sie schreibgeschützt sind oder nicht usw. (siehe TabularInline für weitere Informationen).

Wir haben in diesem Abschnitt viel gelernt, also ist es jetzt an der Zeit, dass Sie ein paar Dinge ausprobieren.

1. Fügen Sie für die BookInstance-Listenansicht Code hinzu, um das Buch, den Status, das Fälligkeitsdatum und die ID (anstelle des Standard-__str__()-Texts) anzuzeigen.
2. Fügen Sie eine Inline-Auflistung von Book-Elementen zur Author-Detailansicht mit dem gleichen Ansatz hinzu, den wir für Book/BookInstance verwendet haben.

Das war's! Sie haben nun gelernt, wie man die Admin-Seite sowohl in ihrer einfachsten als auch in verbesserter Form einrichtet, wie man einen Superuser erstellt und wie man die Admin-Seite navigiert und Datensätze anzeigt, löscht und aktualisiert. Unterwegs haben Sie eine Menge Bücher, Buchinstanzen, Genres und Autoren erstellt, die wir auflisten und anzeigen können, sobald wir unsere eigene Sicht und Templates erstellen.

• Writing your first Django app, Teil 2: Einführung in das Django Admin (Django-Dokumentation)
• Die Django Admin-Seite (Django-Dokumentation)

• Zurück
• Übersicht: Django-Webframework (Python)
• Weiter