フラッシュメッセージ

いいアプリケーションといいユーザーインターフェースにはフィードバックが全てです。 ユーザーフィードバックを十分に得ることができなければ、アプリケーションを嫌いになるかもしれません。 Flaskは、フラッシュメッセージの仕組みを用いて本当にシンプルな方法でユーザーにフィードバックを与える方法が提供されています。 フラッシュメッセージは基本的に、リクエストの終了時に次のアクセスするページへリクエストを出して、その時だけ有効なメッセージを記録しておくことができます。 これをすることでレイアウトテンプレートに使いやすいように統合されています。

簡単なフラッシュメッセージ

では、以下に例を紹介します。

from flask import Flask, flash, redirect, render_template, \
     request, url_for

app = Flask(__name__)
app.secret_key = 'some_secret'

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/login', methods=['GET', 'POST'])
def login():
    error = None
    if request.method == 'POST':
        if request.form['username'] != 'admin' or \
                request.form['password'] != 'secret':
            error = 'Invalid credentials'
        else:
            flash('You were successfully logged in')
            return redirect(url_for('index'))
    return render_template('login.html', error=error)

if __name__ == "__main__":
    app.run()

そして、以下のようにすると layout.html テンプレートは魔法を使うことができます。 :

<!doctype html>
<title>My Application</title>
{% with messages = get_flashed_messages() %}
  {% if messages %}
    <ul class=flashes>
    {% for message in messages %}
      <li>{{ message }}</li>
    {% endfor %}
    </ul>
  {% endif %}
{% endwith %}
{% block body %}{% endblock %}

そして、以下はindex.htmlテンプレートです。 :

{% extends "layout.html" %}
{% block body %}
  <h1>Overview</h1>
  <p>Do you want to <a href="{{ url_for('login') }}">log in?</a>
{% endblock %}

そして、もちろんログインテンプレートもです。 :

{% extends "layout.html" %}
{% block body %}
  <h1>Login</h1>
  {% if error %}
    <p class=error><strong>Error:</strong> {{ error }}
  {% endif %}
  <form action="" method=post>
    <dl>
      <dt>Username:
      <dd><input type=text name=username value="{{
          request.form.username }}">
      <dt>Password:
      <dd><input type=password name=password>
    </dl>
    <p><input type=submit value=Login>
  </form>
{% endblock %}

カテゴリ付きのフラッシュメッセージ

New in version 0.3.

フラッシュメッセージを記録するときにカテゴリを追加することも可能です。 指定をしなければ、デフォルトのカテゴリは 'message' になります。 他のカテゴリはユーザーにとっていいと思われるフィードバックを与えるために使って下さい。 例えば、エラーメッセージを赤い背景で表示させる場合などです。

異なるカテゴリでメッセージを記録するためには、 flash() 関数の二番目の引数を使って下さい。

flash(u'Invalid password provided', 'error')

テンプレート内で、 get_flashed_messages() 関数がカテゴリを返すように指示しなければいけません。 その場合にループ処理は少し違う形式になります。

{% with messages = get_flashed_messages(with_categories=true) %}
  {% if messages %}
    <ul class=flashes>
    {% for category, message in messages %}
      <li class="{{ category }}">{{ message }}</li>
    {% endfor %}
    </ul>
  {% endif %}
{% endwith %}

これは、フラッシュメッセージを表示するための一つの例でしかありません。 メッセージに <strong>Error:</strong> のような接頭詞を追加するためにカテゴリを使う場合もあるかもしれません。

フラッシュメッセージのフィルタリング

New in version 0.9.

任意で、 get_flashed_messages() の結果をフィルタリングするカテゴリのリストを渡すことができます。 これは異なるブロックに個々のカテゴリを表示させたい場合に便利です。

{% with errors = get_flashed_messages(category_filter=["error"]) %}
{% if errors %}
<div class="alert-message block-message error">
  <a class="close" href="#">×</a>
  <ul>
    {%- for msg in errors %}
    <li>{{ msg }}</li>
    {% endfor -%}
  </ul>
</div>
{% endif %}
{% endwith %}