Python的Flask架構標配模板引擎Jinja2的使用教程,flaskjinja2

來源:互聯網
上載者:User

Python的Flask架構標配模板引擎Jinja2的使用教程,flaskjinja2

Jinja2需要Python2.4以上的版本。
安裝
按照Jinja有多種方式,你可以根據需要選擇不同的按照方式。
使用easy_install 或pip:

#sudo easy_install Jinja2 #sudo pip install Jinja2 
這兩個工具可以自動從網站上下載Jinja,並安裝到python目錄的site-packages目錄中。
從tar包安裝:
# 下載Jinja的安裝包 # 解壓縮 # sudo python setup.py install 

基本API用法
用Jinja建立模板最簡單的方式是通過 Template. 但在實際應用中並不推薦此用法: 

<pre>  >>> from Jinja2 import Template  >>> template = Template('Hello {{ name }}!')  >>> template.render(name='World')  u'Hello World!' </pre> 

這個例子使用字串作為模板內容建立了一個Template執行個體,然後用"name='World'"作為參數調用"render方法,將內容中 的'name'替換為"World",最終返回渲染過的字串--"u'Hello World!'"。
有兩種分隔字元。{% raw %}{% ... %}{% endraw %} 和 {% raw %}{{ ... }}{% endraw %}。第一個用於執行類似 for 迴圈或者賦值的聲明,後者是用於輸出表達的結果到模板中。

如何組織模板
那麼模板如何融入到我們的應用程式?如果你一直關注 Flask 的話,你可能注意到了 Flask 是十分靈活,它並沒有對其內容進行一些特殊的限制。模板也不例外。你可能也注意到了通常有一個推薦的地方來放置東西(比如,模板)。對於模板而言,那個地方就是在包的目錄裡。

myapp/  __init__.py  models.py  views/  templates/  static/run.pyrequirements.txttemplates/  layout.html  index.html  about.html  profile/    layout.html    index.html  photos.html  admin/    layout.html    index.html    analytics.html

templates 目錄的結構是與我們路由結構平行的。對於路由 myapp.com/admin/analytics 的模板就是 templates/admin/analytics.html。在目錄裡面還有一些額外的模板,它們不會直接地被渲染。layout.html 檔案是為了讓其它的模板繼承。

繼承
很像蝙蝠俠的背景故事一樣,一個組織優秀的模板目錄很大程度上依靠繼承。父模板 通常定義一個通用的結構,所有 子模板 都能很好的繼承它。在我們的例子中,layout.html 就是一個父模板而其它 .html 檔案就是子模板。
你通常有一個頂層的 layout.html,它定義了你的應用程式的通用布局以及你的網站的每一部分。如果你看看上面的目錄的話,你會看到一個頂層的 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>

在子模板中,我們可以擴充父模板並且定義這些塊的內容。

{# _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() 函數讓我們渲染父級塊的內容。

建立宏
我們可以在我們模板中堅持 DRY(不要重複自己)的原則,通過抽象出重複出現的程式碼片段到 宏。如果我們正工作在為我們應用程式導航的 HTML 上,我們需要給一個 “活躍的”連結一個 class(class=”active”)。沒有宏的話,我們要編寫一大段 if ... else 語句,這些語句檢查每一個連結找到正處於活躍的一個。
宏提供了一種模組化代碼的方式;它們像函數一樣工作。讓我們看看如何使用宏標記一個活躍的連結。

{# 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>

在這個模板中我們現在要做的就是調用一個未定義的宏 - nav_link -接著向其傳遞兩個參數:目標端點(例如,目標視圖的函數名)以及我們要顯示的文本。
你可能會注意到在匯入語句中我們指定了 with context。Jinja 的 context 是由傳遞到 render_template() 函數的參數以及來自我們的 Python 代碼的 Jinja 環境內容組成。對於模板來說,這些變數在模板被渲染的時候是可用的。
一些變數是明顯地由我們傳入,例如,render_template("index.html", color="red"),但是還有一些變數和函數是由 Flask 自動地包含在上下文中,例如,request, g 和 session。當我們說 {% raw %}{% from ... import ... with context %}{% endraw %} 的時候,就是告訴 Jinja 這些變數對宏也可用。
現在是時候定義在我們模板中使用的 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 %}

現在我們已經在 myapp/templates/macros.html 中定義了宏。在這個宏中我們使用了 Flask 的 request 對象 — 預設情況下在 Jinja 上下文中是可用的 — 用來檢查傳入到 nav_link 中的路由的端點是否是當前請求。如果是,我們正在當前頁面上,接著我們標記它為活躍的。
從 x 匯入 y 語句採用了 x 的相對路徑。如果我們的模板是 myapp/templates/user/blog.html,我們可以在使用 from "../macros.html" 匯入 nav_link。

自訂過濾器
Jinja 過濾器是一個函數,它能夠在 {% raw %}{{ ... }}{% endraw %} 中用於處理一個運算式的結果。在運算式結果輸出到模板之前它就被調用。

<h2>{{ article.title|title }}</h2>

在這段代碼中,title 過濾器接收 article.title 作為參數並且返回一個過濾後的標題,接著過濾後的標題將會輸出到模板中。這就像 UNIX 的“管道化”一個程式到另一個程式的輸出。
有很多像 title 一樣的內建過濾器。請參閱 Jinja 文檔中的 完整列表。
我們可以在我們的 Jinja 模板中定義自己的過濾器供使用。舉例來說,我們將會實現一個簡單 caps 過濾器用來大寫一個字串中所有的字母。
Jinja 已經有一個 upper 過濾器來做這樣的事情,並且還有一個 capitalize 過濾器,它能用來大寫第一個字母,小寫其餘的字母。這些也能處理 unicode 轉換,但是我們會繼續我們的樣本,讓大家目前能夠知道如何自訂過濾器。
我們要在 myapp/util/filters.py 中定義我們的過濾器。這裡給出一個 util 包,它裡面有各種各樣的模組。

# myapp/util/filters.pyfrom .. import app@app.template_filter()def caps(text):  """Convert a string to all caps."""  return text.uppercase()

在這段代碼中我們使用 @app.template_filter() 裝飾器註冊我們的函數成一個 Jinja 過濾器。預設的過濾器名稱就是函數的名稱,但是你可以傳入一個參數到裝飾器中來改變它。

@app.template_filter('make_caps')def caps(text):  """Convert a string to all caps."""  return text.uppercase()

現在我們可以在模板中調用 make_caps 而不是 {% raw %}caps:{{ "hello world!"|make_caps }}{% endraw %}。
為了要讓我們的過濾器在模板中可用的話,我們只需要在我們的頂層 \\_init.py\\_ 的中匯入它。

# myapp/__init__.py# Make sure app has been initialized first to prevent circular imports.from .util import filters

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.