首頁 > 文章 > 後端開發 > Python的Flask框架標配模板引擎Jinja2的使用教學課程

Python的Flask框架標配模板引擎Jinja2的使用教學課程

WBOY原創: 2016-08-04 08:55:461524瀏覽

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 class="brush:php;toolbar:false"> 
 >>> from Jinja2 import Template 
 >>> template = Template('Hello {{ name }}!') 
 >>> template.render(name='World') 
 u'Hello World!'

這個例子使用字串作為模板內容創建了一個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.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 目錄的結構是與我們路由結構平行的。對於路由 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.py
from .. 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

陳述：

本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn

上一篇：python 效能提升的幾種方法下一篇：python 效能提升的幾種方法

看更多

Python的Flask框架標配模板引擎Jinja2的使用教學課程

相關文章