Flask-API für Nachrichten-Flashing
Der Flash-Mechanismus wird verwendet, um bei der nächsten Anfrage eine einmalige Feedback-Nachricht anzuzeigen; ein typisches Szenario sind Benachrichtigungen über "Vorgang erfolgreich" oder "Eingabefehler".
Flask speichert Nachrichten in der Session und löscht sie automatisch, nachdem sie gelesen wurden.
flash-Funktion
| Parameter | Type | Standardwert | Beschreibung |
|---|---|---|---|
| message | str | Erforderlich | Der anzuzeigende Nachrichtentext |
| category | str | "message" | Nachrichtenkategorien, empfohlene Werte: message, success, error, warning, info |
get_flashed_messages-Funktion
| Parameter | Type | Standardwert | Beschreibung |
|---|---|---|---|
| with_categories | bool | False | Wenn True, wird eine Liste von (category, message)-Tupeln zurückgegeben |
| category_filter | iterierbar | () | Nur Nachrichten der angegebenen Kategorie zurückgeben |
| Rückgabewert | Beschreibung |
|---|---|
| with_categories=False | Gibt eine Liste von Nachrichtentexten zurück: ["msg1", "msg2"] |
| with_categories=True | Gibt eine Liste von (category, message)-Tupeln zurück: [("success", "msg1"), ("error", "msg2")] |
Verwendung in Templates
get_flashed_messages()Sie können direkt im Template aufgerufen werden, ohne durch render_template übergeben werden zu müssen.
Beispiel
<!-- Alle Flash-Nachrichten anzeigen -->
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
{% for category, message in messages %}
<div class="flash-{{ category }}">{{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
<!-- Nur Fehlermeldungen anzeigen -->
{% for msg in get_flashed_messages(category_filter=["error"]) %}
<div class="error">{{ msg }}</div>
{% endfor %}
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
{% for category, message in messages %}
<div class="flash-{{ category }}">{{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
<!-- Nur Fehlermeldungen anzeigen -->
{% for msg in get_flashed_messages(category_filter=["error"]) %}
<div class="error">{{ msg }}</div>
{% endfor %}
Codebeispiele
Beispiel
from flask import Flask, flash, get_flashed_messages, redirect, url_for, request
app = Flask(__name__)
app.secret_key = "secret"
@app.route("/post", methods=["GET", "POST"])
def create_post():
if request.method == "POST":
title = request.form.get("title", "").strip()
if not title:
flash("Titel darf nicht leer sein", "error")
else:
flash(f"Artikel '{title}' erfolgreich veröffentlicht!", "success")
return redirect(url_for("create_post"))
return redirect(url_for("create_post"))
# GET-Anfrage: alle Nachrichten abrufen und anzeigen
messages = get_flashed_messages(with_categories=True)
return render_template("post.html", messages=messages)
app = Flask(__name__)
app.secret_key = "secret"
@app.route("/post", methods=["GET", "POST"])
def create_post():
if request.method == "POST":
title = request.form.get("title", "").strip()
if not title:
flash("Titel darf nicht leer sein", "error")
else:
flash(f"Artikel '{title}' erfolgreich veröffentlicht!", "success")
return redirect(url_for("create_post"))
return redirect(url_for("create_post"))
# GET-Anfrage: alle Nachrichten abrufen und anzeigen
messages = get_flashed_messages(with_categories=True)
return render_template("post.html", messages=messages)
Weitere ErweiterungenFlash-Nachrichten werden in der Session gespeichert, daher muss der geheime Schlüssel gesetzt werdenSECRET_KEY. Die Nachricht ist nur in der nächsten Anfrage sichtbar, nachdem sie gelesen wurde, und wird dann automatisch gelöscht.