消息闪现¶
优秀的应用程序和用户界面都与反馈息息相关。如果用户没有得到足够的反馈,他们可能会讨厌这个应用程序。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()
函数的第二个参数
flash('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 %}