Flask 简明教程

Flask – Message Flashing

一个好的基于 GUI 的应用程序会向用户提供有关交互的反馈。例如,桌面应用程序会使用对话框或消息框,而 JavaScript 会使用警报以实现类似目的。

在 Flask Web 应用程序中,生成此类信息消息十分容易。Flask 框架的 Flashing 系统能够在一个视图中创建消息,并在名为 next 的视图函数中渲染它。

Flask 模块包含 flash() 方法。它将消息传递给下一个请求(通常是一个模板)。

flash(message, category)

在此,

  1. message 参数是实际的消息,用于显示。

  2. category 参数是可选的。它可以是“error”(错误)、“info”(信息)或“warning”(警告)。

为了从会话中删除消息,模板会调用 get_flashed_messages()

get_flashed_messages(with_categories, category_filter)

这两个参数都是可选的。第一个参数是元组,如果接收到消息,则说明类型。第二个参数对仅显示特定消息很有用。

以下闪光灯收到了模板中的消息。

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

我们现在来看一个简单的例子,演示 Flask 中闪烁机制的操作。在下面的代码中,一个 ‘/’ URL 显示指向登录页面的链接,没有要显示的消息。

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

这个链接将引导用户到 ‘/login’ URL,后者显示登录表单。提交后, login() 视图函数会验证用户名和密码,然后相应地闪烁 ‘success’ 消息或创建 ‘error’ 变量。

@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('login.html', error = error)

error 的情况下,重新显示登录模板并附有错误消息。

Login.html

<!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 成功,将在索引模板上闪烁一条成功消息。

Index.html

<!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('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'] != 'admin':
         error = 'Invalid username or password. Please try again!'
      else:
         flash('You were successfully logged in')
         return redirect(url_for('index'))

   return render_template('login.html', error = error)

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

在执行上述代码后,您将看到如下所示的屏幕。

flask message flashing example

当您单击该链接时,您将被定向到登录页面。

输入用户名和密码。

login page

单击 Login 。一条消息“您已成功登录”将被显示。

successfully logged in page