フラスコ–メッセージの点滅

優れたGUIベースのアプリケーションは、相互作用に関するフィードバックをユーザーに提供します。たとえば、デスクトップアプリケーションはダイアログまたはメッセージボックスを使用し、JavaScriptは同様の目的でアラートを使用します。

Flask Webアプリケーションでは、このような情報メッセージの生成は簡単です。 Flaskフレームワークのフラッシュシステムにより、1つのビューでメッセージを作成し、 next と呼ばれるビュー関数でレンダリングすることができます。

Flaskモジュールには* flash（）*メソッドが含まれています。通常はテンプレートである次のリクエストにメッセージを渡します。

flash(message, category)

ここに、

message パラメータは、フラッシュされる実際のメッセージです。
category パラメーターはオプションです。「エラー」、「情報」または「警告」のいずれかです。

セッションからメッセージを削除するために、テンプレートは* get_flashed_messages（）*を呼び出します。

get_flashed_messages(with_categories, category_filter)

両方のパラメーターはオプションです。受信したメッセージにカテゴリがある場合、最初のパラメーターはタプルです。 2番目のパラメーターは、特定のメッセージのみを表示するのに役立ちます。

以下は、テンプレートで受信したメッセージをフラッシュします。

{% with messages = get_flashed_messages() %}
   {% if messages %}
      {% for message in messages %}
         {{ message }}
      {% endfor %}
   {% endif %}
{% endwith %}

ここで、Flaskのフラッシュメカニズムを示す簡単な例を見てみましょう。次のコードでは、 ’/’ URLがログインページへのリンクを表示し、フラッシュするメッセージはありません。

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

このリンクは、ログインフォームを表示する ’/login’ URLにユーザーを誘導します。送信されると、* login（）ビュー関数はユーザー名とパスワードを検証し、それに応じて「成功」メッセージを点滅させるか、「エラー」*変数を作成します。

@app.route('/login', methods = ['GET', 'POST'])
def login():
   error = None

   if request.method == 'POST':
      if request.form['username'] != 'admin' or \
         request.form['password'] != 'admin':
         error = 'Invalid username or password. Please try again!'
      else:
         flash('You were successfully logged in')
         return redirect(url_for('index'))
   return render_template('loginl', error = error)

エラー*の場合、ログインテンプレートはエラーメッセージとともに再表示されます。

<!doctype html>
<html>
   <body>
      <h1>Login</h1>

      {% if error %}
         <p><strong>Error:</strong> {{ error }}
      {% endif %}

      <form action = "" method = post>
         <dl>
            <dt>Username:</dt>
            <dd>
               <input type = text name = username
                  value = "{{request.form.username }}">
            </dd>
            <dt>Password:</dt>
            <dd><input type = password name = password></dd>
         </dl>
         <p><input type = submit value = Login></p>
      </form>
   </body>
</html>

一方、 login が成功すると、インデックステンプレートで成功メッセージがフラッシュされます。

インデクス

<!doctype html>
<html>
   <head>
      <title>Flask Message flashing</title>
   </head>
   <body>
      {% with messages = get_flashed_messages() %}
         {% if messages %}
            <ul>
               {% for message in messages %}
               <li<{{ message }}</li>
               {% endfor %}
            </ul>
         {% endif %}
      {% endwith %}

      <h1>Flask Message Flashing Example</h1>
      <p>Do you want to <a href = "{{ url_for('login') }}">
         <b>log in?</b></a></p>
   </body>
</html>

Flaskメッセージフラッシュの例の完全なコードを以下に示します-

Flash.py

from flask import Flask, flash, redirect, render_template, request, url_for
app = Flask(__name__)
app.secret_key = 'random string'

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

@app.route('/login', methods = ['GET', 'POST'])
def login():
   error = None

   if request.method == 'POST':
      if request.form['username'] != 'admin' or \
         request.form['password'] != 'admin':
         error = 'Invalid username or password. Please try again!'
      else:
         flash('You were successfully logged in')
         return redirect(url_for('index'))

   return render_template('loginl', error = error)

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

上記のコードを実行すると、次のような画面が表示されます。

フラッシュメッセージの点滅の例

リンクをクリックすると、ログインページが表示されます。

ユーザー名とパスワードを入力します。

ログインページ

[ログイン]をクリックします。「あなたは正常にログインしました」というメッセージが表示されます。

ログインページに成功しました

Flask-message-flashing

フラスコ–メッセージの点滅

ログイン

インデクス

Flash.py

目次