简体中文（ZH-CN）English（EN）繁体中文（ZH-TW）日本語（JA）한국어（KO）Melayu（MS）Français（FR）Deutsch（DE）
首頁
文章
問答
課程
專題
下載
遊戲
詞典
最近更新

首頁  >  文章  >  後端開發  >  Python的Flask框架中的Jinja2模板引擎

Python的Flask框架中的Jinja2模板引擎

高洛峰
高洛峰原創
2017-03-01 13:43:111691瀏覽

Flask的模板功能是基於Jinja2模板引擎來實現的。模板檔案存放在目前目前下的子目錄templates（一定要使用這個名字）下。

main.py 程式碼如下：

from flask import Flask, render_template
 
app = Flask(__name__)
 
@app.route('/hello')
@app.route(&#39;/hello/<name>&#39;)
def hello(name=None):
  return render_template(&#39;hello.html&#39;, name=name)
 
 
if __name__ == &#39;__main__&#39;:
  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渲染模板時傳過來，如上例中的”name”

  • 也可以是任一Python基礎型，例如字串{{ “Hello” }}，用引號括起；或數值，列表，元祖，字典，布林值。直接顯示基礎型別沒啥意義，一般會配合其他表達式一起用

  • 運算。包括算數運算，如{{ 2 + 3 }}；比較運算，如{{ 2 > 1 }}；邏輯運算，如{{ False and True }}

  • 濾波器“|”和測試器“is”。這個在後面會介紹

  • 函數調用，如{{ current_time() }}；數組下標操作，如{{ arr[1] }}

  • “in”運算符，如{{ 1 in [1,2,3] }}

  • 字串連接符”~”，作用同Python中的”+”一樣，如{{ “Hello ” ~ name ~ “!” }}

  • #“if”關鍵字，如{{ 'Hi, %s' % name if name }}。這裡的”if”不是條件控制語句。

控制語句

Jinja2的控制語句主要就是條件控制語句if，和迴圈控制語句for，語法類似Python。我們可以改動下上節的範本程式碼：

{% if name and name == &#39;admin&#39; %}
  <h1>This is admin console</h1>
{% elif name %}
  <h1>Welcome {{ name }}!</h1>
{% else %}
  <h1>Please login</h1>
{% endif %}

#上面是一個條件控制語句的例子，注意if控制語句要用」{% endif %} 」來結束。模板中無法像程式碼中一樣靠縮進來判斷程式碼區塊的結束。再來看個迴圈的例子，我們先改下Python程式碼中的”hello」函數，讓其傳兩個列表進模板。 

def hello(name=None):
  return render_template(&#39;hello.html&#39;, name=name, digits=[1,2,3,4,5],
              users=[{&#39;name&#39;:&#39;John&#39;},
                 {&#39;name&#39;:&#39;Tom&#39;, &#39;hidden&#39;:True},
                 {&#39;name&#39;:&#39;Lisa&#39;}
                 {&#39;name&#39;:&#39;Bob&#39;}])

範本如下：

#
{% if name and name == &#39;admin&#39; %}
  <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(&#39;odd&#39;, &#39;even&#39;) }}">
  <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>

這裡有三個知識點。首先for迴圈支援else語句，當待遍歷的列表”users」為空或為None時，就進入else語句。
其次，在for語句後面使用if關鍵字，可以對迴圈中的項目進行過濾。本例中，所有hidden屬性為True的user都會被過濾掉。
另外，for迴圈中可以存取Jinja2的迴圈內建變數。本例中，我們會在第一項前顯示標題，最後一項後顯示總數，每一項顯示序號。另外，奇偶項的HTML p元素會有不同的class。如果我們加入下面的CSS style，就能看到斑馬線。 

<style type="text/css">
  .odd {
    background-color: #BDF;
  }
</style>

Jinja2的迴圈內建變數主要有以下幾個：


1

2

3

4

5

##6

#7

8

9

#10

#11

12


from flask import Flask, render_template

 

app##= Flask(__name__#) 

#

##@app.route#('/hello' )

@app.路線(' / hello/')

def#hello##(姓名=無):

    

return render_template('hello.html',#名稱=名稱)# 

 

##if

__name__ == '__main__'##:    

應用程式

。 正確)#


另外，如果你启用了”jinja2.ext.loopcontrols”扩展的话，你还可以在循环中使用”{% break %}”和”{% continue %}”来控制循环执行。
其它常用语句：

忽略模板语法

有时候，我们在页面上就是要显示”{{ }}”这样的符号怎么办？Jinja2提供了”raw”语句来忽略所有模板语法。

{% raw %}
  <ul>
  {% for item in items %}
    <li>{{ item }}</li>
  {% endfor %}
  </ul>
{% endraw %}

自动转义

我们将本文一开始的Flask代码”hello()”方法改动下：

@app.route(&#39;/hello&#39;)
@app.route(&#39;/hello/<name>&#39;)
def hello(name=None):
  if name is None:
    name = &#39;<em>World</em>&#39;
  return render_template(&#39;hello.html&#39;, 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 = [&#39;Sunny&#39;] %}
 {{ arr.append(&#39;Rainy&#39;) }}
 {{ arr }}
{% endwith %}

看上面这段代码，我们想执行列表的”append”操作，这时使用”{{ arr.append(‘Rainy') }}”页面会输出”None”，换成”{% %}”来执行，程序会报错，因为这是个表达式，不是语句。那怎么办？我们可以启用”jinja2.ext.do”扩展。然后在模板中执行”do”语句即可：

{% with arr = [&#39;Sunny&#39;] %}
 {% do arr.append(&#39;Rainy&#39;) %}
 {{ 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(&#39;/&#39;)
def index():
  session[&#39;user&#39;] = &#39;guest&#39;
  return render_template(&#39;hello.html&#39;)
 
app.secret_key = &#39;123456&#39;

模板代码：

<p>User: {{ session.user }}</p>

在没有请求上下文的环境中，这个对象不可用。
全局对象g
全局变量g，用来保存请求中会用到全局内容，比如数据库连接。模板中也可以访问。
Flask代码：

@app.route(&#39;/&#39;)
def index():
  g.db = &#39;mysql&#39;
  return render_template(&#39;hello.html&#39;)

模板代码：

<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(&#39;static&#39;, filename=&#39;style.css&#39;) }}">

该函数是全局的，离开了请求生命周期也可以调用。
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(&#39;/&#39;)
def index():
  session[&#39;user&#39;] = &#39;guest&#39;
  g.db = &#39;mysql&#39;
  return render_template(&#39;hello-2.html&#39;)
 
@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 = &#39;123456&#39;
 
if __name__ == &#39;__main__&#39;:
  app.run(debug=True)

模板代码：


Hello Sample
<link rel="stylesheet" href="{{ url_for(&#39;static&#39;, filename=&#39;style.css&#39;) }}">
 
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中文网！
陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
上一篇：Python的Tornado框架配置使用Jinja2模板引擎下一篇：Python的Tornado框架配置使用Jinja2模板引擎

相關文章

看更多