Python の Flask フレームワークの Jinja2 テンプレート エンジン
- 高洛峰オリジナル
- 2017-03-01 13:43:111675ブラウズ
Flask のテンプレート機能は、Jinja2 テンプレート エンジンに基づいて実装されています。テンプレート ファイルは、現在のサブディレクトリ template に保存されます (必ずこの名前を使用してください)。
main.py コードは次のとおりです:
from flask import Flask, render_template app = Flask(__name__) @app.route('/hello') @app.route('/hello/<name>') def hello(name=None): return render_template('hello.html', name=name) if __name__ == '__main__': app.run(debug=True)
hello.html コードは次のとおりです:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Hello Sample</title>
</head>
<body>
{% if name %}
<h1>Hello {{ name }} !</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}
</body>
</html>
テンプレートの式はすべて区切り文字「{{ }}」に含まれています; 制御ステートメント これらはすべて区切り文字「{% %}」に含まれます。さらに、テンプレートはコメントもサポートしており、すべて区切り文字「{# #}」に含まれます。
式
式には通常、次のタイプがあります:
最も一般的に使用されるものは、Flaskがテンプレートをレンダリングするときに渡される変数です。たとえば、上記の例の「名前」です
。引用符で囲まれた文字列 {{ "Hello" }} などの基本的な Python タイプ、または数値、リスト、タプル、辞書、またはブール値を指定することもできます。基本型を直接表示することは意味がありません。通常、
操作を実行するために他の式と一緒に使用されます。 {{ 2 + 3 }} などの算術演算、{{ False と True }} などの論理演算、およびテスターを含みます。 " は"。これは後で紹介します
関数呼び出し ({{ current_time() }} など)、配列添字演算 ({{ arr[1] }} など)
"in" 演算子 ({{ 1 など) in [1,2,3] }}
文字列連結子「~」は、Python の「+」と同じ機能を持ちます。たとえば、{{ "Hello " ~ name ~ " }}
「if」キーワード ({{ 'こんにちは、%s' % name if name }} など)。ここでの「if」は条件付き制御ステートメントではありません。
- 制御文
Jinja2の制御文は主に条件制御文ifとループ制御文forです。構文はPythonと似ています。前のセクションのテンプレート コードを変更できます。
{% if name and name == 'admin' %}
<h1>This is admin console</h1>
{% elif name %}
<h1>Welcome {{ name }}!</h1>
{% else %}
<h1>Please login</h1>
{% endif %}
上記は条件付き制御ステートメントの例です。if 制御ステートメントは「{% endif %}」で終了する必要があることに注意してください。テンプレートでは、コードのようにインデントに依存してコード ブロックの終わりを決定することはできません。ループの例をもう一度見てみましょう。まず、Python コードの「hello」関数を変更して、2 つのリストをテンプレートに渡します。
def hello(name=None):
return render_template('hello.html', name=name, digits=[1,2,3,4,5],
users=[{'name':'John'},
{'name':'Tom', 'hidden':True},
{'name':'Lisa'}
{'name':'Bob'}])
テンプレートは次のとおりです:
{% if name and name == 'admin' %}
<h1>Helle admin</h1>
{% elif name %}
<h1>"Hello" ~ {{ name }} ~ "!"</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}
{% for digit in digits %}
{{ digit }}
{% endfor %}
if文と同様に、for制御文も「{% endfor %}」で終了する必要があります。ページでは、各要素の間にスペースが入ります。スペースを入れたくない場合は、「for」ステートメントの最後と「endfor」ステートメントの先頭に「-」記号を追加します。例:
{% for digit in digits -%}
{{ digit }}
{%- endfor %}
「12345」という数字が一緒に表示されているのがわかります。複雑なループの例をもう一度見てみましょう:
<dl>
{% for user in users if not user.hidden %}
{% if loop.first %}
<p>User List:</p>
{% endif %}
<p class="{{ loop.cycle('odd', 'even') }}">
<dt>User No. {{ loop.index }}</dt>
<dd>{{ user.name }}</dd>
</p>
{% if loop.last %}
<dir>Total Users: {{ loop.length }}</dir>
{% endif %}
{% else %}
<li>No users found</li>
{% endfor %}
</dl>
ここには 3 つの知識ポイントがあります。まず、for ループは else ステートメントをサポートします。走査対象のリスト "users" が空または None の場合、else ステートメントが入力されます。
次に、for ステートメントの後に if キーワードを使用して、ループ内の項目をフィルターします。この例では、hidden 属性が True であるすべてのユーザーが除外されます。さらに、Jinja2 の組み込みループ変数には for ループでアクセスできます。この例では、最初の項目の前にタイトル、最後の項目の後に合計数、各項目のシリアル番号を表示します。さらに、奇数項目と偶数項目の HTML p 要素は異なるクラスを持ちます。次の CSS スタイルを追加すると、横断歩道が表示されます。
<style type="text/css">
.odd {
background-color: #BDF;
}
</style>Jinja2 の組み込みループ変数には主に次のものが含まれます:
6
7
| 10
12 from
flask インポート
Flask 、
| render_template
アプリ = フラスコ(__name__) @app.route('/hello') @app.route ('/こんにちは/ ;') def こんにちは(名前=なし): return render_template( 'hello.html', name=name)
if __name__ == '__main__' : app.run(debug=True) |
另外，如果你启用了”jinja2.ext.loopcontrols”扩展的话，你还可以在循环中使用”{% break %}”和”{% continue %}”来控制循环执行。
其它常用语句：
忽略模板语法
有时候，我们在页面上就是要显示”{{ }}”这样的符号怎么办？Jinja2提供了”raw”语句来忽略所有模板语法。
{% raw %}
<ul>
{% for item in items %}
<li>{{ item }}</li>
{% endfor %}
</ul>
{% endraw %}
自动转义
我们将本文一开始的Flask代码”hello()”方法改动下：
@app.route('/hello')
@app.route('/hello/<name>')
def hello(name=None):
if name is None:
name = '<em>World</em>'
return render_template('hello.html', name=name)
此时，访问”http://www.php.cn/:5000/hello”，页面上会显示”Welcome 907fae80ddef53131f3292ee4f81644bWorldd1c6776b927dc33c5d9114750b586338!”，也就是这个HTML标签”907fae80ddef53131f3292ee4f81644b”被自动转义了。Flask会对”.html”, “.htm”, “.xml”, “.xhtml”这四种类型的模板文件开启HTML格式自动转义。这样也可以防止HTML语法注入。如果我们不想被转义怎么办？
{% autoescape false %}
<h1>Hello {{ name }}!</h1>
{% endautoescape %}
将”autoescape”开关设为”false”即可，反之，设为”true”即开启自动转义。使用”autoescape”开关前要启用”jinja2.ext.autoescape”扩展，在Flask框架中，这个扩展默认已启用。
赋值
使用”set”关键字给变量赋值：
{% set items = [[1,2],[3,4,5]] %}
with语句
类似于Python中的”with”关键字，它可以限制with语句块内对象的作用域：
{% with foo = 1 %}
{% set bar = 2 %}
{{ foo + bar }}
{% endwith %}
{# foo and bar are not visible here #}
使用”with”关键字前要启用”jinja2.ext.with_”扩展，在Flask框架中，这个扩展默认已启用。
执行表达式
{% with arr = ['Sunny'] %}
{{ arr.append('Rainy') }}
{{ arr }}
{% endwith %}
看上面这段代码，我们想执行列表的”append”操作，这时使用”{{ arr.append(‘Rainy') }}”页面会输出”None”，换成”{% %}”来执行，程序会报错，因为这是个表达式，不是语句。那怎么办？我们可以启用”jinja2.ext.do”扩展。然后在模板中执行”do”语句即可：
{% with arr = ['Sunny'] %}
{% do arr.append('Rainy') %}
{{ arr }}
{% endwith %}
上下文环境
Flask每个请求都有生命周期，在生命周期内请求有其上下文环境Request Context。作为在请求中渲染的模板，自然也在请求的生命周期内，所以Flask应用中的模板可以使用到请求上下文中的环境变量，及一些辅助函数。本文就会介绍下这些变量和函数。
标准上下文变量和函数
请求对象request
request对象可以用来获取请求的方法”request.method”，表单”request.form”，请求的参数”request.args”，请求地址”request.url”等。它本身是一个字典。在模板中，你一样可以获取这些内容，只要用表达式符号”{{ }}”括起来即可。
<p>{{ request.url }}</p>
在没有请求上下文的环境中，这个对象不可用。
会话对象session
session对象可以用来获取当前会话中保存的状态，它本身是一个字典。在模板中，你可以用表达式符号”{{ }}”来获取这个对象。
Flask代码如下，别忘了设置会话密钥哦：
@app.route('/') def index(): session['user'] = 'guest' return render_template('hello.html') app.secret_key = '123456'
模板代码：
<p>User: {{ session.user }}</p>
在没有请求上下文的环境中，这个对象不可用。
全局对象g
全局变量g，用来保存请求中会用到全局内容，比如数据库连接。模板中也可以访问。
Flask代码：
@app.route('/') def index(): g.db = 'mysql' return render_template('hello.html')
模板代码：
<p>DB: {{ g.db }}</p>
g对象是保存在应用上下文环境中的，也只在一个请求生命周期内有效。在没有应用上下文的环境中，这个对象不可用。
Flask配置对象config
导入的配置信息，就保存在”app.config”对象中。这个配置对象在模板中也可以访问。
<p>Host: {{ config.DEBUG }}</p>
“config”是全局对象，离开了请求生命周期也可以访问。
url_for()函数
url_for()函数可以用来快速获取及构建URL，Flask也将此函数引入到了模板中，比如下面的代码，就可以获取静态目录下的”style.css”文件。
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
该函数是全局的，离开了请求生命周期也可以调用。
get_flashed_messages()函数
get_flashed_messages()函数是用来获取消息闪现的。这也是一个全局可使用的函数。
自定义上下文变量和函数
自定义变量
除了Flask提供的标准上下文变量和函数，我们还可以自己定义。下面我们就来先定义一个上下文变量，在Flask应用代码中，加入下面的函数：
from flask import current_app @app.context_processor def appinfo(): return dict(appname=current_app.name)
函数返回的是一个字典，里面有一个属性”appname”，值为当前应用的名称。我们曾经介绍过，这里的”current_app”对象是一个定义在应用上下文中的代理。函数用”@app.context_processor”装饰器修饰，它是一个上下文处理器，它的作用是在模板被渲染前运行其所修饰的函数，并将函数返回的字典导入到模板上下文环境中，与模板上下文合并。然后，在模板中”appname”就如同上节介绍的”request”, “session”一样，成为了可访问的上下文对象。我们可以在模板中将其输出：
<p>Current App is: {{ appname }}</p>
自定义函数
同理我们可以自定义上下文函数，只需将上例中返回字典的属性指向一个函数即可，下面我们就来定义一个上下文函数来获取系统当前时间：
import time
@app.context_processor
def get_current_time():
def get_time(timeFormat="%b %d, %Y - %H:%M:%S"):
return time.strftime(timeFormat)
return dict(current_time=get_time)
我们可以试下在模板中将其输出：
<p>Current Time is: {{ current_time() }}</p>
<p>Current Day is: {{ current_time("%Y-%m-%d") }}</p>
上下文处理器可以修饰多个函数，也就是我们可以定义多个上下文环境变量和函数。
完整实例：
flask代码：
from flask import Flask, render_template, session, g, current_app
import time
app = Flask(__name__)
@app.route('/')
def index():
session['user'] = 'guest'
g.db = 'mysql'
return render_template('hello-2.html')
@app.context_processor
def appinfo():
return dict(appname=current_app.name)
@app.context_processor
def get_current_time():
def get_time(timeFormat="%b %d, %Y - %H:%M:%S"):
return time.strftime(timeFormat)
return dict(current_time=get_time)
app.secret_key = '123456'
if __name__ == '__main__':
app.run(debug=True)
模板代码：
Hello Sample <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">Hello World!
Request URL: {{ request.url }}
<p>User: {{ session.user }}</p> <p>DB: {{ g.db }}</p> <p>Host: {{ config.DEBUG }}</p> <p>Current App is: {{ appname }}</p> <p>Current Time is: {{ current_time() }}</p> <p>Current Day is: {{ current_time("%Y-%m-%d") }}</p> {% with messages = get_flashed_messages() %} {% if messages %} {% for message in messages %} Flash Message: {{ message }} {% endfor %} {% endif %} {% endwith %}
更多Python的Flask框架中的Jinja2模板引擎相关文章请关注PHP中文网！