Von Flask-Admin kommend

starlette-admin entstand als Portierung der Konzepte von Flask-Admin ins ASGI-Ökosystem, daher ist die Migration unkompliziert. Sie leiten weiterhin eine Klasse von ModelView ab, konfigurieren sie über Klassenattribute und registrieren sie auf einer Admin-Instanz. Der Großteil der Arbeit besteht darin, Attribute umzubenennen und vom impliziten Request-Kontext von Flask zum expliziten request-Objekt von Starlette zu wechseln.

Dieser Leitfaden ordnet die Flask-Admin-API Attribut für Attribut ihrem starlette-admin-Pendant zu.

Mentales Modell

Einrichtung

from flask import Flask
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView

app = Flask(__name__)
admin = Admin(app, name="My Admin", template_mode="bootstrap4")
admin.add_view(ModelView(Post, db.session))

from starlette.applications import Starlette
from starlette_admin.contrib.sqla import Admin, ModelView

app = Starlette()  # or FastAPI()
admin = Admin(engine, title="My Admin", secret_key="change-me")
admin.add_view(ModelView(Post))
admin.mount_to(app)

Einen template_mode-Schalter gibt es nicht. Die Benutzeroberfläche verwendet Tabler (Bootstrap 5) und bietet einen Dark Mode. Um das Erscheinungsbild anzupassen, schreiben Sie ein eigenes BaseTheme oder überschreiben Sie die Templates.

Attribute der Listenseite

Formularattribute

Export und Import

class PostView(ModelView):
    can_export = True
    export_types = ["csv", "xlsx"]
    export_max_rows = 10000

class PostView(ModelView):
    exporters = ["csv", "xlsx", "pdf"]
    importers = ["csv", "xlsx"]
    exclude_fields_from_export = ["internal_notes"]

Der Export als CSV und JSON ist standardmäßig aktiviert. Zeilenbegrenzungen greifen automatisch, und das Escaping von Tabellenkalkulationsformeln ist eine optionale Exporter-Einstellung. Der Import, den Flask-Admin nicht bietet, umfasst einen Vorschauschritt mit Validierung jeder einzelnen Zeile sowie optionalen Aktualisierungen bestehender Datensätze über den Primärschlüssel. Siehe Export und Import.

Aktionen

from flask_admin.actions import action


class PostView(ModelView):
    @action("publish", "Publish", "Publish selected posts?")
    def action_publish(self, ids):
        query = Post.query.filter(Post.id.in_(ids))
        for post in query.all():
            post.published = True

from starlette_admin import ActionSelection, action, flash


class PostView(ModelView):
    actions = ["publish", "delete"]

    @action(
        name="publish",
        text="Publish",
        confirmation="Publish selected posts?",
    )
    async def publish(self, request: Request, selection: ActionSelection) -> None:
        for post in await selection.rows():
            post.published = True
        flash(request, "Posts published")

Der Handler erhält ein ActionSelection-Objekt statt roher IDs. Es löst die Zeilen lazy auf, stellt die aktiven Filter bereit und funktioniert gleichermaßen, wenn ein Benutzer alle passenden Datensätze seitenübergreifend auswählt. Aktionen können zudem ein eigenes HTML-Formular im Bestätigungsdialog rendern. Für Operationen pro Zeile ersetzen @row_action und @link_row_action benutzerdefinierte Spalten-Formatter.

Berechtigungen und Zugriffskontrolle

Die can_*-Klassenflags von Flask-Admin werden in starlette-admin zu Methoden pro Request, sodass Autorisierungsentscheidungen vom angemeldeten Benutzer abhängen können.

Bei Flask-Admin integrieren Sie Flask-Login selbst. starlette-admin liefert einen AuthProvider mit fertiger Anmeldeseite mit; die Methoden login, logout und authenticate implementieren Sie gegen Ihren Benutzerspeicher. Ein OAuthProvider deckt OIDC-Redirect-Flows ab. Der angemeldete Benutzer ist überall als request.state.admin_user verfügbar.

Lifecycle-Hooks für Modelle

Über die Hooks pro View hinaus ermöglicht das Event-System einem einzigen Handler, jeden View zu beobachten. Dafür gibt es in Flask-Admin kein Äquivalent.

from starlette_admin.events import AdminEvent, AfterCreateContext


async def audit(ctx: AfterCreateContext) -> None: ...


admin.events.on(AdminEvent.AFTER_CREATE, audit)

Eigene Views und die Indexseite

Inline-Modelle

class ArticleView(ModelView):
    inline_models = [Comment]

from starlette_admin.contrib.sqla import InlineModelView, ModelView


class CommentInline(InlineModelView):
    model = Comment
    fields = ["author", "body"]


class ArticleView(ModelView):
    inlines = [CommentInline]

Eine explizite Klasse stellt jedem Inline-Modell die gesamte Konfigurationsoberfläche von ModelView zur Verfügung: Feldauswahl, Validierung und Unterstützung zusammengesetzter Fremdschlüssel. Siehe Inline-Formulare.

Internationalisierung

Flask-Admin hängt von Flask-Babel und der umgebenden Flask-Umgebung ab. starlette-admin verwendet stattdessen ein Konfigurationsobjekt:

from starlette_admin import I18nConfig

admin = Admin(engine, i18n_config=I18nConfig(default_locale="fr"))

Zeitzonenbewusstes Rendern von Datum und Uhrzeit funktioniert auf dieselbe Weise über TimezoneConfig. Siehe Internationalisierung und Zeitzonen.

Was Sie durch den Wechsel gewinnen

• Ein asynchroner Stack. Läuft nativ unter FastAPI und Starlette, mit Unterstützung für async SQLAlchemy, Beanie und Tortoise ORM. Flask-Admin ist synchron.
• Integrierte Sicherheitsfunktionen. CSRF-Schutz, Bereinigung von Upload-Dateinamen, Prüfung des Bildinhalts und Export-Zeilenbegrenzungen sind aktiv, sobald Sie Admin instanziieren; das Escaping von Tabellenkalkulationsformeln lässt sich an den Exportern einschalten. Siehe Sicherheit.
• Datenimport. Ein Vorschauschritt validiert jede Zeile, bevor etwas geschrieben wird. Flask-Admin bietet keine Importfunktion.
• Ein Widget-System für Dashboards. Erstellen Sie Indexseiten und eigene Views in Python, statt Templates von Hand zu schreiben.
• Modernes Design. Eine aktiv gepflegte Codebasis mit ausgereifter Benutzeroberfläche, integriertem Dark Mode und erstklassigen Type Hints.

Woran Sie sich anpassen müssen

• Explizite Request-Objekte. Einen ambienten Request-Kontext gibt es nicht. Jeder Hook und jede Berechtigungsmethode erhält den request als Parameter.
• Asynchrone Handler. Hooks und Aktionen sind Coroutinen; halten Sie blockierende Aufrufe daraus fern oder verlagern Sie diese Arbeit in einen Thread.
• Kein FileAdmin. Wenn Ihr Workflow das Durchsuchen des Server-Dateisystems erfordert, deckt starlette-admin das nicht ab.
• Keine Modals zum Erstellen oder Bearbeiten. Formulare werden als vollständige Seiten statt als Popup-Modals gerendert.