Python的Flask框架標(biāo)配模板引擎Jinja2的使用教程
Jinja2需要Python2.4以上的版本。
安裝
按照J(rèn)inja有多種方式,你可以根據(jù)需要選擇不同的按照方式。
使用easy_install 或pip:
#sudo easy_install Jinja2 #sudo pip install Jinja2
從tar包安裝:
# 下載Jinja的安裝包 # 解壓縮 # sudo python setup.py install
基本API用法
用Jinja創(chuàng)建模板最簡單的方式是通過 Template. 但在實(shí)際應(yīng)用中并不推薦此用法:
<pre> >>> from Jinja2 import Template >>> template = Template('Hello {{ name }}!') >>> template.render(name='World') u'Hello World!' </pre>
這個例子使用字符串作為模板內(nèi)容創(chuàng)建了一個Template實(shí)例,然后用"name='World'"作為參數(shù)調(diào)用"render方法,將內(nèi)容中 的'name'替換為"World",最終返回渲染過的字符串--"u'Hello World!'"。
有兩種分隔符。{% raw %}{% ... %}{% endraw %} 和 {% raw %}{{ ... }}{% endraw %}。第一個用于執(zhí)行類似 for 循環(huán)或者賦值的聲明,后者是用于輸出表達(dá)的結(jié)果到模板中。
如何組織模板
那么模板如何融入到我們的應(yīng)用程序?如果你一直關(guān)注 Flask 的話,你可能注意到了 Flask 是十分靈活,它并沒有對其內(nèi)容進(jìn)行一些特殊的限制。模板也不例外。你可能也注意到了通常有一個推薦的地方來放置東西(比如,模板)。對于模板而言,那個地方就是在包的目錄里。
myapp/ __init__.py models.py views/ templates/ static/ run.py requirements.txt templates/ layout.html index.html about.html profile/ layout.html index.html photos.html admin/ layout.html index.html analytics.html
templates 目錄的結(jié)構(gòu)是與我們路由結(jié)構(gòu)平行的。對于路由 myapp.com/admin/analytics 的模板就是 templates/admin/analytics.html。在目錄里面還有一些額外的模板,它們不會直接地被渲染。layout.html 文件是為了讓其它的模板繼承。
繼承
很像蝙蝠俠的背景故事一樣,一個組織優(yōu)秀的模板目錄很大程度上依靠繼承。父模板 通常定義一個通用的結(jié)構(gòu),所有 子模板 都能很好的繼承它。在我們的例子中,layout.html 就是一個父模板而其它 .html 文件就是子模板。
你通常有一個頂層的 layout.html,它定義了你的應(yīng)用程序的通用布局以及你的網(wǎng)站的每一部分。如果你看看上面的目錄的話,你會看到一個頂層的 myapp/templates/layout.html,同樣還有 myapp/templates/profile/layout.html 和 myapp/templates/admin/layout.html。最后兩個文件繼承和修改第一個文件。
{# _myapp/templates/layout.html_ #} <!DOCTYPE html> <html lang="en"> <head> <title>{% raw %}{% block title %}{% endblock %}{% endraw %}</title> </head> <body> {% block body %} <h1>This heading is defined in the parent.</h1> {% endblock %} </body> </html>
在子模板中,我們可以擴(kuò)展父模板并且定義這些塊的內(nèi)容。
{# _myapp/templates/index.html_ #} {% extends "layout.html" %} {% block title %}Hello world!{% endblock %} {% block body %} {{ super() }} <h2>This heading is defined in the child.</h2> {% endblock %}
super() 函數(shù)讓我們渲染父級塊的內(nèi)容。
創(chuàng)建宏
我們可以在我們模板中堅(jiān)持 DRY(不要重復(fù)自己)的原則,通過抽象出重復(fù)出現(xiàn)的代碼片段到 宏。如果我們正工作在為我們應(yīng)用程序?qū)Ш降?HTML 上,我們需要給一個 “活躍的”鏈接一個 class(class=”active”)。沒有宏的話,我們要編寫一大段 if ... else 語句,這些語句檢查每一個鏈接找到正處于活躍的一個。
宏提供了一種模塊化代碼的方式;它們像函數(shù)一樣工作。讓我們看看如何使用宏標(biāo)記一個活躍的鏈接。
{# myapp/templates/layout.html #} {% from "macros.html" import nav_link with context %} <!DOCTYPE html> <html lang="en"> <head> {% block head %} <title>My application</title> {% endblock %} </head> <body> <ul class="nav-list"> {{ nav_link('home', 'Home') }} {{ nav_link('about', 'About') }} {{ nav_link('contact', 'Get in touch') }} </ul> {% block body %} {% endblock %} </body> </html>
在這個模板中我們現(xiàn)在要做的就是調(diào)用一個未定義的宏 - nav_link -接著向其傳遞兩個參數(shù):目標(biāo)端點(diǎn)(例如,目標(biāo)視圖的函數(shù)名)以及我們要顯示的文本。
你可能會注意到在導(dǎo)入語句中我們指定了 with context。Jinja 的 context 是由傳遞到 render_template() 函數(shù)的參數(shù)以及來自我們的 Python 代碼的 Jinja 環(huán)境上下文組成。對于模板來說,這些變量在模板被渲染的時候是可用的。
一些變量是明顯地由我們傳入,例如,render_template("index.html", color="red"),但是還有一些變量和函數(shù)是由 Flask 自動地包含在上下文中,例如,request, g 和 session。當(dāng)我們說 {% raw %}{% from ... import ... with context %}{% endraw %} 的時候,就是告訴 Jinja 這些變量對宏也可用。
現(xiàn)在是時候定義在我們模板中使用的 nav_link 宏。
{# myapp/templates/macros.html #} {% macro nav_link(endpoint, text) %} {% if request.endpoint.endswith(endpoint) %} <li class="active"><a href="{{ url_for(endpoint) }}">{{text}}</a></li> {% else %} <li><a href="{{ url_for(endpoint) }}">{{text}}</a></li> {% endif %} {% endmacro %}
現(xiàn)在我們已經(jīng)在 myapp/templates/macros.html 中定義了宏。在這個宏中我們使用了 Flask 的 request 對象 — 默認(rèn)情況下在 Jinja 上下文中是可用的 — 用來檢查傳入到 nav_link 中的路由的端點(diǎn)是否是當(dāng)前請求。如果是,我們正在當(dāng)前頁面上,接著我們標(biāo)記它為活躍的。
從 x 導(dǎo)入 y 語句采用了 x 的相對路徑。如果我們的模板是 myapp/templates/user/blog.html,我們可以在使用 from "../macros.html" 導(dǎo)入 nav_link。
自定義過濾器
Jinja 過濾器是一個函數(shù),它能夠在 {% raw %}{{ ... }}{% endraw %} 中用于處理一個表達(dá)式的結(jié)果。在表達(dá)式結(jié)果輸出到模板之前它就被調(diào)用。
<h2>{{ article.title|title }}</h2>
在這段代碼中,title 過濾器接收 article.title 作為參數(shù)并且返回一個過濾后的標(biāo)題,接著過濾后的標(biāo)題將會輸出到模板中。這就像 UNIX 的“管道化”一個程序到另一個程序的輸出。
有很多像 title 一樣的內(nèi)置過濾器。請參閱 Jinja 文檔中的 完整列表。
我們可以在我們的 Jinja 模板中定義自己的過濾器供使用。舉例來說,我們將會實(shí)現(xiàn)一個簡單 caps 過濾器用來大寫一個字符串中所有的字母。
Jinja 已經(jīng)有一個 upper 過濾器來做這樣的事情,并且還有一個 capitalize 過濾器,它能用來大寫第一個字母,小寫其余的字母。這些也能處理 unicode 轉(zhuǎn)換,但是我們會繼續(xù)我們的示例,讓大家目前能夠知道如何自定義過濾器。
我們要在 myapp/util/filters.py 中定義我們的過濾器。這里給出一個 util 包,它里面有各種各樣的模塊。
# myapp/util/filters.py from .. import app @app.template_filter() def caps(text): """Convert a string to all caps.""" return text.uppercase()
在這段代碼中我們使用 @app.template_filter() 裝飾器注冊我們的函數(shù)成一個 Jinja 過濾器。默認(rèn)的過濾器名稱就是函數(shù)的名稱,但是你可以傳入一個參數(shù)到裝飾器中來改變它。
@app.template_filter('make_caps') def caps(text): """Convert a string to all caps.""" return text.uppercase()
現(xiàn)在我們可以在模板中調(diào)用 make_caps 而不是 {% raw %}caps:{{ "hello world!"|make_caps }}{% endraw %}。
為了要讓我們的過濾器在模板中可用的話,我們只需要在我們的頂層 \\_init.py\\_ 的中導(dǎo)入它。
# myapp/__init__.py # Make sure app has been initialized first to prevent circular imports. from .util import filters
相關(guān)文章
Python實(shí)現(xiàn)針對給定字符串尋找最長非重復(fù)子串的方法
這篇文章主要介紹了Python實(shí)現(xiàn)針對給定字符串尋找最長非重復(fù)子串的方法,涉及Python針對字符串的遍歷、排序、計(jì)算等相關(guān)操作技巧,需要的朋友可以參考下2018-04-04Python Locust負(fù)載測試工具安裝配置使用詳解
本文將提供有關(guān)Python Locust的全面指南,包括安裝和配置、基本概念、性能測試、任務(wù)編寫、報(bào)告生成以及實(shí)際應(yīng)用場景,將通過豐富的示例代碼來幫助深入理解Locust的使用2024-01-01基于python實(shí)現(xiàn)鼠標(biāo)實(shí)時坐標(biāo)監(jiān)測
這篇文章主要給大家介紹了如何基于python實(shí)現(xiàn)鼠標(biāo)實(shí)時坐標(biāo)監(jiān)測,文章通過代碼示例介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2023-11-11Keras深度學(xué)習(xí)模型Sequential和Model詳解
這篇文章主要介紹了Keras深度學(xué)習(xí)模型Sequential和Model詳解,在Keras中有兩種深度學(xué)習(xí)的模型:序列模型(Sequential)和通用模型(Model),差異在于不同的拓?fù)浣Y(jié)構(gòu),,需要的朋友可以參考下2023-08-08Python實(shí)戰(zhàn)之markdown轉(zhuǎn)pdf(包含公式轉(zhuǎn)換)
由于我們markdown編輯器比較特殊,不是很方便瀏覽,如果轉(zhuǎn)換成pdf的話,就不需要可以的去安裝各種編輯器才可以看了。所以本文將介紹如何通過Python實(shí)現(xiàn)md轉(zhuǎn)pdf或者是docx,需要的朋友可以參考一下2021-12-12python并發(fā)編程多進(jìn)程 模擬搶票實(shí)現(xiàn)過程
這篇文章主要介紹了python并發(fā)編程多進(jìn)程 模擬搶票實(shí)現(xiàn)過程,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-08-08python GUI庫圖形界面開發(fā)之PyQt5拖放控件實(shí)例詳解
這篇文章主要介紹了python GUI庫圖形界面開發(fā)之PyQt5使用拖放控件實(shí)例詳解,需要的朋友可以參考下2020-02-02pandas or sql計(jì)算前后兩行數(shù)據(jù)間的增值方法
下面小編就為大家分享一篇pandas or sql計(jì)算前后兩行數(shù)據(jù)間的增值方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-04-04