Flask Message Flashing API
メッセージフラッシュ(Flash)メカニズムは、次のリクエストで一度きりのフィードバックメッセージを表示するために使用されます。典型的なシナリオは「操作成功」や「入力エラー」の通知です。
Flask はメッセージを Session に保存し、読み取り後に自動的にクリアします。
flash関数
| パラメータ | 型 | デフォルト値 | 説明 |
|---|---|---|---|
| message | str | 必須 | 表示するメッセージテキスト |
| category | str | "message" | メッセージカテゴリ。推奨値:message、success、error、warning、info |
get_flashed_messages関数
| パラメータ | 型 | デフォルト値 | 説明 |
|---|---|---|---|
| with_categories | bool | False | True の場合、(category, message) タプルのリストを返します |
| category_filter | iterable | () | 指定したカテゴリのメッセージのみを返します |
| 戻り値 | 説明 |
|---|---|
| with_categories=False | メッセージテキストのリストを返します:["msg1", "msg2"] |
| with_categories=True | カテゴリ+メッセージのタプルリストを返します:[("success", "msg1"), ("error", "msg2")] |
テンプレートでの使用
get_flashed_messages()テンプレート内で直接呼び出せます。render_template を介して渡す必要はありません。
例
<!-- すべての flash メッセージを表示 -->
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
{% for category, message in messages %}
<div class="flash-{{ category }}">{{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
<!-- エラーメッセージのみ表示 -->
{% 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 %}
<!-- エラーメッセージのみ表示 -->
{% for msg in get_flashed_messages(category_filter=["error"]) %}
<div class="error">{{ msg }}</div>
{% endfor %}
コード例
例
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("タイトルは空にできません", "error")
else:
flash(f"記事「{title}」が公開されました!", "success")
return redirect(url_for("create_post"))
return redirect(url_for("create_post"))
# GET リクエスト:すべてのメッセージを取得して表示
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("タイトルは空にできません", "error")
else:
flash(f"記事「{title}」が公開されました!", "success")
return redirect(url_for("create_post"))
return redirect(url_for("create_post"))
# GET リクエスト:すべてのメッセージを取得して表示
messages = get_flashed_messages(with_categories=True)
return render_template("post.html", messages=messages)
その他の拡張Flash メッセージは Session に保存されるため、必ず設定する必要がありますSECRET_KEY。メッセージはそれを読み取った次のリクエストでのみ表示され、その後自動的にクリアされます。