メッセージの点滅

優れたアプリケーションとユーザーインターフェイスはすべてフィードバックに関するものです。ユーザーが十分なフィードバックを受け取らない場合、おそらくアプリケーションを嫌うことになります。 Flaskは、フラッシュシステムを使用してユーザーにフィードバックを提供するための非常に簡単な方法を提供します。フラッシュシステムは基本的に、リクエストの最後にメッセージを記録し、次のリクエストと次のリクエストのみにアクセスすることを可能にします。これは通常、これを行うレイアウトテンプレートと組み合わされます。ブラウザおよび場合によってはWebサーバーがCookieのサイズに制限を課していることに注意してください。これは、セッションCookieに対して大きすぎるメッセージをフラッシュすると、メッセージのフラッシュがサイレントに失敗することを意味します。

シンプルな点滅

だからここに完全な例があります：

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

app = Flask(__name__)
app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'

@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)

そして、これが魔法を実行する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 %}

layout.htmlから継承したindex.htmlテンプレートは次のとおりです。

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

また、layout.htmlからも継承するlogin.htmlテンプレートは次のとおりです。

{% extends "layout.html" %}
{% block body %}
  <h1>Login</h1>
  {% if error %}
    <p class=error><strong>Error:</strong> {{ error }}
  {% endif %}
  <form 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 %}

カテゴリで点滅

バージョン0.3の新機能。

メッセージをフラッシュするときにカテゴリを指定することもできます。何も指定されていない場合のデフォルトのカテゴリは'message'です。代替カテゴリを使用して、ユーザーにより良いフィードバックを提供できます。たとえば、エラーメッセージは赤い背景で表示される可能性があります。

別のカテゴリのメッセージをフラッシュするには、flash()関数の2番目の引数を使用します。

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>などのプレフィックスをメッセージに追加することもできます。

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

バージョン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 %}

メッセージの点滅—フラスコのドキュメント

メッセージの点滅

シンプルな点滅

カテゴリで点滅

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

目次