Flask系列教程(3)——Jinja2模版

模板:

在之前的章節(jié)中,視圖函數(shù)只是直接返回文本,而在實(shí)際生產(chǎn)環(huán)境中其實(shí)很少這樣用,因?yàn)閷?shí)際的頁面大多是帶有樣式和復(fù)雜邏輯的HTML代碼,這可以讓瀏覽器渲染出非常漂亮的頁面。目前市面上有非常多的模板系統(tǒng),其中最知名最好用的就是Jinja2和Mako,我們先來看一下這兩個(gè)模板的特點(diǎn)和不同:

Jinja2:Jinja是日本寺廟的意思,并且寺廟的英文是temple和模板的英文template的發(fā)音類似。Jinja2是默認(rèn)的仿Django模板的一個(gè)模板引擎,由Flask的作者開發(fā)。它速度快,被廣泛使用,并且提供了可選的沙箱模板來保證執(zhí)行環(huán)境的安全,它有以下優(yōu)點(diǎn):

讓前端開發(fā)者和后端開發(fā)者工作分離。

減少Flask項(xiàng)目代碼的耦合性,頁面邏輯放在模板中,業(yè)務(wù)邏輯放在視圖函數(shù)中,將頁面邏輯和業(yè)務(wù)邏輯解耦有利于代碼的維護(hù)。

提供了控制語句、繼承等高級功能,減少開發(fā)的復(fù)雜度。

Marko:Marko是另一個(gè)知名的模板。他從Django、Jinja2等模板借鑒了很多語法和API,他有以下優(yōu)點(diǎn):

性能和Jinja2相近,在這里可以看到。

有大型網(wǎng)站在使用,有成功的案例。Reddit和豆瓣都在使用。

有知名的web框架支持。Pylons和Pyramid這兩個(gè)web框架內(nèi)置模板就是Mako。

支持在模板中寫幾乎原生的Python語法的代碼,對Python工程師比較友好,開發(fā)效率高。

自帶完整的緩存系統(tǒng)。當(dāng)然也提供了非常好的擴(kuò)展借口,很容易切換成其他的緩存系統(tǒng)。

Flask渲染Jinja模板:

要渲染一個(gè)模板,通過render_template方法即可,以下將用一個(gè)簡單的例子進(jìn)行講解:

fromflaskimportFlask,render_templateapp = Flask(__name__)@app.route('/about/')defabout():returnrender_template('about.html')

當(dāng)訪問/about/的時(shí)候,about()函數(shù)會(huì)在當(dāng)前目錄下的templates文件夾下尋找about.html模板文件。如果想更改模板文件地址,應(yīng)該在創(chuàng)建app的時(shí)候,給Flask傳遞一個(gè)關(guān)鍵字參數(shù)template_folder,指定具體的路徑,再看以下例子:

fromflaskimportFlask,render_templateapp = Flask(__name__,template_folder=r'C:\templates')@app.route('/about/')defabout():returnrender_template('about.html')

以上例子將會(huì)在C盤的templates文件夾中尋找模板文件。還有最后一點(diǎn)是,如果模板文件中有參數(shù)需要傳遞,應(yīng)該怎么傳呢,我們再來看一個(gè)例子:

fromflaskimportFlask,render_templateapp = Flask(__name__)@app.route('/about/')defabout():# return render_template('about.html',user='xiaotuo')returnrender_template('about.html',**{'user':'xiaotuo})

以上例子介紹了兩種傳遞參數(shù)的方式,因?yàn)閞ender_template需要傳遞的是一個(gè)關(guān)鍵字參數(shù),所以第一種方式是順其自然的。但是當(dāng)你的模板中要傳遞的參數(shù)過多的時(shí)候,把所有參數(shù)放在一個(gè)函數(shù)中顯然不是一個(gè)好的選擇,因此我們使用字典進(jìn)行包裝,并且加兩個(gè)*號(hào),來轉(zhuǎn)換成關(guān)鍵字參數(shù)。

Jinja2:

Jinja2默認(rèn)已經(jīng)跟著Flask進(jìn)行安裝了,如果沒有被安裝到,可以通過pip install Jinja2來進(jìn)行安裝。

概要:

Jinja模板是簡單的一個(gè)純文本文件(html/xml/csv...),不僅僅是用來產(chǎn)生html文件,后綴名也依照你自己的心情而定。當(dāng)然,盡量命名為模板正確的文件格式,增加可讀性。先看一個(gè)簡單例子:

1.2.3.My Webpage4.5.6.7. {% for item in navigation %}8.

  • {{ item.caption }}
  • 9. {% endfor %}10.11.12. {{ a_variable }}13. {{ user.name }}14. {{ user['name'] }}15.16. {# a comment #}17.18.

    以上示例有需要進(jìn)行解釋:

    第12~14行的{{ ... }}:用來裝載一個(gè)變量,模板渲染的時(shí)候,會(huì)把這個(gè)變量代表的值替換掉。并且可以間接訪問一個(gè)變量的屬性或者一個(gè)字典的key。關(guān)于點(diǎn).號(hào)訪問和[]中括號(hào)訪問,沒有任何區(qū)別,都可以訪問屬性和字典的值。

    第7~9行的{% ... %}:用來裝載一個(gè)控制語句,以上裝載的是for循環(huán),以后只要是要用到控制語句的,就用{% ... %}。

    第14行的{# ... #}:用來裝載一個(gè)注釋,模板渲染的時(shí)候會(huì)忽視這中間的值。

    屬性訪問規(guī)則:

    比如在模板中有一個(gè)變量這樣使用:foo.bar,那么在Jinja2中是這樣進(jìn)行訪問的:

    先去查找foo的bar這個(gè)屬性,也即通過getattr(foo,'bar')。

    如果沒有,就去通過foo.__getitem__('bar')的方式進(jìn)行查找。

    如果以上兩種方式都沒有找到,返回一個(gè)undefined。

    在模板中有一個(gè)變量這樣使用:foo['bar'],那么在Jinja2中是這樣進(jìn)行訪問:

    通過foo.__getitem__('bar')的方式進(jìn)行查找。

    如果沒有,就通過getattr(foo,'bar')的方式進(jìn)行查找。

    如果以上沒有找到,則返回一個(gè)undefined。

    過濾器:

    過濾器是通過管道符號(hào)(|)進(jìn)行使用的,例如:{{ name|length }},將返回name的長度。過濾器相當(dāng)于是一個(gè)函數(shù),把當(dāng)前的變量傳入到過濾器中,然后過濾器根據(jù)自己的功能,再返回相應(yīng)的值,之后再將結(jié)果渲染到頁面中。Jinja2中內(nèi)置了許多過濾器,在這里可以看到所有的過濾器,現(xiàn)對一些常用的過濾器進(jìn)行講解:

    abs(value):返回一個(gè)數(shù)值的絕對值。示例:-1|abs

    default(value,default_value,boolean=false):如果當(dāng)前變量沒有值,則會(huì)使用參數(shù)中的值來代替。示例:name|default('xiaotuo')——如果name不存在,則會(huì)使用xiaotuo來替代。boolean=False默認(rèn)是在只有這個(gè)變量為undefined的時(shí)候才會(huì)使用default中的值,如果想使用python的形式判斷是否為false,則可以傳遞boolean=true。也可以使用or來替換。

    escape(value)或e:轉(zhuǎn)義字符,會(huì)將<、>等符號(hào)轉(zhuǎn)義成HTML中的符號(hào)。示例:content|escape或content|e。

    first(value):返回一個(gè)序列的第一個(gè)元素。示例:names|first

    format(value,*arags,**kwargs):格式化字符串。比如:

    {{"%s"-"%s"|format('Hello?',"Foo!") }}將輸出:Helloo? - Foo!

    last(value):返回一個(gè)序列的最后一個(gè)元素。示例:names|last。

    length(value):返回一個(gè)序列或者字典的長度。示例:names|length。

    join(value,d=u''):將一個(gè)序列用d這個(gè)參數(shù)的值拼接成字符串。

    safe(value):如果開啟了全局轉(zhuǎn)義,那么safe過濾器會(huì)將變量關(guān)掉轉(zhuǎn)義。示例:content_html|safe。

    int(value):將值轉(zhuǎn)換為int類型。

    float(value):將值轉(zhuǎn)換為float類型。

    lower(value):將字符串轉(zhuǎn)換為小寫。

    upper(value):將字符串轉(zhuǎn)換為小寫。

    replace(value,old,new): 替換將old替換為new的字符串。

    truncate(value,length=255,killwords=False):截取length長度的字符串。

    striptags(value):刪除字符串中所有的HTML標(biāo)簽,如果出現(xiàn)多個(gè)空格,將替換成一個(gè)空格。

    trim:截取字符串前面和后面的空白字符。

    string(value):將變量轉(zhuǎn)換成字符串。

    wordcount(s):計(jì)算一個(gè)長字符串中單詞的個(gè)數(shù)。

    控制語句:

    所有的控制語句都是放在{% ... %}中,并且有一個(gè)語句{% endxxx %}來進(jìn)行結(jié)束,Jinja中常用的控制語句有if/for..in..,現(xiàn)對他們進(jìn)行講解:

    if:if語句和python中的類似,可以使用>,<,<=,>=,==,!=來進(jìn)行判斷,也可以通過and,or,not,()來進(jìn)行邏輯合并操作,以下看例子:

    {%ifkenny.sick %}Kennyissick.{%elifkenny.dead %}You killed Kenny! You bastard!!!{%else%}Kenny looks okay --- so far{% endif %}

    for...in...:for循環(huán)可以遍歷任何一個(gè)序列包括數(shù)組、字典、元組。并且可以進(jìn)行反向遍歷,以下將用幾個(gè)例子進(jìn)行解釋:

    普通的遍歷:

      {% for user in users %}
    • {{ user.username|e }}
    • {% endfor %}

    遍歷字典:

    {% for key, value in my_dict.iteritems() %}{{ key|e }}{{ value|e }}{% endfor %}

    如果序列中沒有值的時(shí)候,進(jìn)入else:

      {% for user in users %}
    • {{ user.username|e }}
    • {% else %}
    • no users found
    • {% endfor %}

    并且Jinja中的for循環(huán)還包含以下變量,可以用來獲取當(dāng)前的遍歷狀態(tài):

    變量描述

    loop.index當(dāng)前迭代的索引(從1開始)

    loop.index0當(dāng)前迭代的索引(從0開始)

    loop.first是否是第一次迭代,返回True/False

    loop.last是否是最后一次迭代,返回True/False

    loop.length序列的長度

    另外,不可以使用continue和break表達(dá)式來控制循環(huán)的執(zhí)行

    測試器:

    測試器主要用來判斷一個(gè)值是否滿足某種類型,并且這種類型一般通過普通的if判斷是有很大的挑戰(zhàn)的。語法是:if...is...,先來簡單的看個(gè)例子:

    {%ifvariableisescaped%}value of variable: {{ escaped }}{%else%}variableisnotescaped{% endif %}

    以上判斷variable這個(gè)變量是否已經(jīng)被轉(zhuǎn)義了,Jinja中內(nèi)置了許多的測試器,看以下列表:

    callable(object):是否可調(diào)用。

    defined(object):是否已經(jīng)被定義了。

    escaped(object):是否已經(jīng)被轉(zhuǎn)義了。

    upper(object):是否全是大寫。

    lower(object):是否全是小寫。

    string(object):是否是一個(gè)字符串。

    sequence(object):是否是一個(gè)序列。

    number(object):是否是一個(gè)數(shù)字。

    odd(object):是否是奇數(shù)。

    even(object):是否是偶數(shù)。

    宏:

    模板中的宏跟python中的函數(shù)類似,可以傳遞參數(shù),但是不能有返回值,可以將一些經(jīng)常用到的代碼片段放到宏中,然后把一些不固定的值抽取出來當(dāng)成一個(gè)變量,以下將用一個(gè)例子來進(jìn)行解釋:

    {% macro input(name, value='',type='text') %}

    value|e }}">{% endmacro %}

    以上例子可以抽取出了一個(gè)input標(biāo)簽,指定了一些默認(rèn)參數(shù)。那么我們以后創(chuàng)建input標(biāo)簽的時(shí)候,可以通過他快速的創(chuàng)建:

    {{ input('username') }}

    {{ input('password',type='password') }}

    import語句:

    在真實(shí)的開發(fā)中,會(huì)將一些常用的宏單獨(dú)放在一個(gè)文件中,在需要使用的時(shí)候,再從這個(gè)文件中進(jìn)行導(dǎo)入。import語句的用法跟python中的import類似,可以直接import...as...,也可以from...import...或者from...import...as...,假設(shè)現(xiàn)在有一個(gè)文件,叫做forms.html,里面有兩個(gè)宏分別為input和textarea,如下:

    forms.html:{% macro input(name, value='',type='text') %}{% endmacro %}{% macro textarea(name, value='', rows=10, cols=40) %}

    }}">{{ value|e }}{% endmacro %}

    看以下導(dǎo)入宏的例子:

    import...as...形式:

    {% import 'forms.html' as forms %}Username{{ forms.input('username') }}Password{{ forms.input('password', type='password') }}

    {{ forms.textarea('comment') }}

    from...import...as.../from...import...形式:

    {% from 'forms.html' import input as input_field, textarea %}Username{{ input_field('username') }}Password{{ input_field('password', type='password') }}

    {{ textarea('comment') }}

    另外需要注意的是,導(dǎo)入模板并不會(huì)把當(dāng)前上下文中的變量添加到被導(dǎo)入的模板中,如果你想要導(dǎo)入一個(gè)需要訪問當(dāng)前上下文變量的宏,有兩種可能的方法:

    顯式地傳入請求或請求對象的屬性作為宏的參數(shù)。

    與上下文一起(with context)導(dǎo)入宏。

    與上下文中一起(with context)導(dǎo)入的方式如下:

    {%from'_helpers.html'importmy_macrowithcontext %}

    include語句:

    include語句可以把一個(gè)模板引入到另外一個(gè)模板中,類似于把一個(gè)模板的代碼copy到另外一個(gè)模板的指定位置,看以下例子:

    {%include'header.html'%}Body{%include'footer.html'%}

    賦值(set)語句:

    有時(shí)候我們想在在模板中添加變量,這時(shí)候賦值語句(set)就派上用場了,先看以下例子:

    {%setname='xiaotuo'%}

    那么以后就可以使用name來代替xiaotuo這個(gè)值了,同時(shí),也可以給他賦值為列表和元組:

    {%setnavigation = [('index.html','Index'), ('about.html','About')] %}

    賦值語句創(chuàng)建的變量在其之后都是有效的,如果不想讓一個(gè)變量污染全局環(huán)境,可以使用with語句來創(chuàng)建一個(gè)內(nèi)部的作用域,將set語句放在其中,這樣創(chuàng)建的變量只在with代碼塊中才有效,看以下示例:

    {%with%}{% set foo =42%}{{ foo }} foois42here{% endwith %}

    也可以在with的后面直接添加變量,比如以上的寫法可以修改成這樣:

    {%withfoo =42%}{{ foo }}{% endwith %}

    這兩種方式都是等價(jià)的,一旦超出with代碼塊,就不能再使用foo這個(gè)變量了。

    模板繼承:

    Flask中的模板可以繼承,通過繼承可以把模板中許多重復(fù)出現(xiàn)的元素抽取出來,放在父模板中,并且父模板通過定義block給子模板開一個(gè)口,子模板根據(jù)需要,再實(shí)現(xiàn)這個(gè)block,假設(shè)現(xiàn)在有一個(gè)base.html這個(gè)父模板,代碼如下:

    {% block head %}{% block title %}{% endblock %} - My Webpage{% endblock %}{% block content %}{% endblock %}{% block footer %}? Copyright 2008 byyou.{% endblock %}

    以上父模板中,抽取了所有模板都需要用到的元素html、body等,并且對于一些所有模板都要用到的樣式文件style.css也進(jìn)行了抽取,同時(shí)對于一些子模板需要重寫的地方,比如title、head、content都定義成了block,然后子模板可以根據(jù)自己的需要,再具體的實(shí)現(xiàn)。以下再來看子模板的代碼:

    {% extends "base.html" %}{% block title %}Index{% endblock %}{% block head %}{{ super() }}.important{color:#336699; }{% endblock %}{% block content %}

    Index

    Welcome to my awesome homepage.{% endblock %}

    首先第一行就定義了子模板繼承的父模板,并且可以看到子模板實(shí)現(xiàn)了title這個(gè)block,并填充了自己的內(nèi)容,再看head這個(gè)block,里面調(diào)用了super()這個(gè)函數(shù),這個(gè)函數(shù)的目的是執(zhí)行父模板中的代碼,把父模板中的內(nèi)容添加到子模板中,如果沒有這一句,則父模板中處在head這個(gè)block中的代碼將會(huì)被子模板中的代碼給覆蓋掉。

    另外,模板中不能出現(xiàn)重名的block,如果一個(gè)地方需要用到另外一個(gè)block中的內(nèi)容,可以使用self.blockname的方式進(jìn)行引用,比如以下示例:

    {% block title %}{% endblock %}

    {{ self.title() }}

    {% block body %}{% endblock %}

    以上示例中h1標(biāo)簽重用了title這個(gè)block中的內(nèi)容,子模板實(shí)現(xiàn)了title這個(gè)block,h1標(biāo)簽也能擁有這個(gè)值。

    另外,在子模板中,所有的文本標(biāo)簽和代碼都要添加到從父模板中繼承的block中。否則,這些文本和標(biāo)簽將不會(huì)被渲染。

    轉(zhuǎn)義:

    轉(zhuǎn)義的概念是,在模板渲染字符串的時(shí)候,字符串有可能包括一些非常危險(xiǎn)的字符比如<、>等,這些字符會(huì)破壞掉原來HTML標(biāo)簽的結(jié)構(gòu),更嚴(yán)重的可能會(huì)發(fā)生XSS跨域腳本攻擊,因此如果碰到<、>這些字符的時(shí)候,應(yīng)該轉(zhuǎn)義成HTML能正確表示這些字符的寫法,比如>在HTML中應(yīng)該用<來表示等。

    但是Flask中默認(rèn)沒有開啟全局自動(dòng)轉(zhuǎn)義,針對那些以.html、.htm、.xml和.xhtml結(jié)尾的文件,如果采用render_template函數(shù)進(jìn)行渲染的,則會(huì)開啟自動(dòng)轉(zhuǎn)義。并且當(dāng)用render_template_string函數(shù)的時(shí)候,會(huì)將所有的字符串進(jìn)行轉(zhuǎn)義后再渲染。而對于Jinja2默認(rèn)沒有開啟全局自動(dòng)轉(zhuǎn)義,作者有自己的原因:

    渲染到模板中的字符串并不是所有都是危險(xiǎn)的,大部分還是沒有問題的,如果開啟自動(dòng)轉(zhuǎn)義,那么將會(huì)帶來大量的不必要的開銷。

    Jinja2很難獲取當(dāng)前的字符串是否已經(jīng)被轉(zhuǎn)義過了,因此如果開啟自動(dòng)轉(zhuǎn)義,將對一些已經(jīng)被轉(zhuǎn)義過的字符串發(fā)生二次轉(zhuǎn)義,在渲染后會(huì)破壞原來的字符串。

    在沒有開啟自動(dòng)轉(zhuǎn)義的模式下(比如以.conf結(jié)尾的文件),對于一些不信任的字符串,可以通過{{ content_html|e }}或者是{{ content_html|escape }}的方式進(jìn)行轉(zhuǎn)義。在開啟了自動(dòng)轉(zhuǎn)義的模式下,如果想關(guān)閉自動(dòng)轉(zhuǎn)義,可以通過{{ content_html|safe }}的方式關(guān)閉自動(dòng)轉(zhuǎn)義。而{%autoescape true/false%}...{%endautoescape%}可以將一段代碼塊放在中間,來關(guān)閉或開啟自動(dòng)轉(zhuǎn)義,例如以下代碼關(guān)閉了自動(dòng)轉(zhuǎn)義:

    {% autoescape false %}

    autoescaping is disabled here

    {{ will_not_be_escaped }}{% endautoescape %}

    數(shù)據(jù)類型:

    Jinja支持許多數(shù)據(jù)類型,包括:字符串、整型、浮點(diǎn)型、列表、元組、字典、true/false。注意其中的布爾類型是true/false,都是小寫,不是Python中的True/False。

    運(yùn)算符:

    +號(hào)運(yùn)算符:可以完成數(shù)字相加,字符串相加,列表相加。但是并不推薦使用+運(yùn)算符來操作字符串,字符串相加應(yīng)該使用~運(yùn)算符。

    -號(hào)運(yùn)算符:只能針對兩個(gè)數(shù)字相減。

    /號(hào)運(yùn)算符:對兩個(gè)數(shù)進(jìn)行相除。

    %號(hào)運(yùn)算符:取余運(yùn)算。

    *號(hào)運(yùn)算符:乘號(hào)運(yùn)算符,并且可以對字符進(jìn)行相乘。

    **號(hào)運(yùn)算符:次冪運(yùn)算符,比如2**3=8。

    in操作符:跟python中的in一樣使用,比如{{1 in [1,2,3]}}返回true。

    ~號(hào)運(yùn)算符:拼接多個(gè)字符串,比如{{"Hello" ~ "World"}}將返回HelloWorld。

    靜態(tài)文件配置:

    Web應(yīng)用中會(huì)出現(xiàn)大量的靜態(tài)文件來使得網(wǎng)頁更加生動(dòng)美觀。靜態(tài)文件主要包括有CSS樣式文件、JavaScript腳本文件、圖片文件、字體文件等靜態(tài)資源。在Jinja中加載靜態(tài)文件非常簡單,只需要通過url_for全局函數(shù)就可以實(shí)現(xiàn),看以下代碼:

    url_for函數(shù)默認(rèn)會(huì)在項(xiàng)目根目錄下的static文件夾中尋找about.css文件,如果找到了,會(huì)生成一個(gè)相對于項(xiàng)目根目錄下的/static/about.css路徑。當(dāng)然我們也可以把靜態(tài)文件不放在static文件夾中,此時(shí)就需要具體指定了,看以下代碼:

    app = Flask(__name__,static_folder='/tmp')

    那么訪問靜態(tài)文件的時(shí)候,將會(huì)到/tmp這個(gè)文件夾下尋找

    最后編輯于
    ?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
    【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
    平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

    相關(guān)閱讀更多精彩內(nèi)容

    友情鏈接更多精彩內(nèi)容