這份文檔描述了模板引擎中的語法和語義結構,對于創(chuàng)建 Jinja 模板是一份相當有用 的參考。因為模板引擎非常靈活,應用中的配置會在分隔符和未定義值的行為方面與 這里的配置有細微差異。
模板僅僅是文本文件。它可以生成任何基于文本的格式(HTML、XML、CSV、LaTex 等等)。 它并沒有特定的擴展名, .html 或 .xml 都是可以的。
模板包含 變量或 表達式,這兩者在模板求值的時候會被替換為值。模板中 還有標簽,控制模板的邏輯。模板語法的大量靈感來自于 Django 和 Python 。
下面是一個最小的模板,它闡明了一些基礎。我們會在文檔中后面的部分解釋細節(jié):
這包含了默認的設定。應用開發(fā)者也會把語法從 {% foo %} 改成 <% foo %> 或類似的東西。
這里有兩種分隔符: {% ... %} 和 {{ ... }} 。前者用于執(zhí)行諸如 for 循環(huán) 或賦值的語句,后者把表達式的結果打印到模板上。
應用把變量傳遞到模板,你可能在模板中弄混。變量上面也可以有你能訪問的屬性或元 素。變量看起來是什么,完全取決于應用提供了什么。
你可以使用點( . )來訪問變量的屬性,作為替代,也可以使用所謂的“下標”語 法( [] )。下面的幾行效果是一樣的:
知曉花括號 不是變量的一部分,而是打印語句的一部分是重要的。如果你訪問標簽 里的不帶括號的變量。
如果變量或屬性不存在,會返回一個未定義值。你可以對這類值做什么取決于應用的配 置,默認的行為是它如果被打印,其求值為一個空字符串,并且你可以迭代它,但其它 操作會失敗。
實現
為方便起見,Jinja2 中 foo.bar 在 Python 層中做下面的事情:
foo['bar'] 的方式相反,只在順序上有細小差異:
如果一個對象有同名的項和屬性,這很重要。此外,有一個過濾 器,它只查找屬性。
變量可以通過 過濾器修改。過濾器與變量用管道符號( | )分割,并且也 可以用圓括號傳遞可選參數。多個過濾器可以鏈式調用,前一個過濾器的輸出會被作為 后一個過濾器的輸入。
例如 {{ name|striptags|title }} 會移除 name中的所有 HTML 標簽并且改寫 為標題樣式的大小寫格式。過濾器接受帶圓括號的參數,如同函數調用。這個例子會 把一個列表用逗號連接起來: {{ list|join(', ') }} 。
下面的節(jié)介紹了所有的內置過濾器。
除了過濾器,所謂的“測試”也是可用的。測試可以用于對照普通表達式測試一個變量。 要測試一個變量或表達式,你要在變量后加上一個 is以及測試的名稱。例如,要得出 一個值是否定義過,你可以用 name is defined ,這會根據 name是否定義返回 true 或 false 。
測試也可以接受參數。如果測試只接受一個參數,你可以省去括號來分組它們。例如, 下面的兩個表達式做同樣的事情:
下面的章節(jié)介紹了所有的內置測試。
要把模板中一行的部分注釋掉,默認使用 {# ... #} 注釋語法。這在調試或 添加給你自己或其它模板設計者的信息時是有用的:
默認配置中,模板引擎不會對空白做進一步修改,所以每個空白(空格、制表符、換行符 等等)都會原封不動返回。如果應用配置了 Jinja 的 trim_blocks,模板標簽后的 第一個換行符會被自動移除(像 PHP 中一樣)。
此外,你也可以手動剝離模板中的空白。當你在塊(比如一個 for 標簽、一段注釋或變 量表達式)的開始或結束放置一個減號( - ),可以移除塊前或塊后的空白:
這會產出中間不帶空白的所有元素。如果 seq是 1 到 9 的數字的列表, 輸出會是 123456789 。
如果開啟了,它們會自動去除行首的空白。
提示
標簽和減號之間不能有空白。
有時想要或甚至必要讓 Jinja 忽略部分,不會把它作為變量或塊來處理。例如,如果 使用默認語法,你想在在使用把 {{ 作為原始字符串使用,并且不會開始一個變量 的語法結構,你需要使用一個技巧。
最簡單的方法是在變量分隔符中( {{ )使用變量表達式輸出:
對于較大的段落,標記一個塊為 raw是有意義的。例如展示 Jinja 語法的實例, 你可以在模板中用這個片段:
如果應用啟用了行語句,就可以把一個行標記為一個語句。例如如果行語句前綴配置為 # ,下面的兩個例子是等價的:
行語句前綴可以出現在一行的任意位置,只要它前面沒有文本。為了語句有更好的可讀 性,在塊的開始(比如 for、 if、 elif等等)以冒號結尾:
提示
若有未閉合的圓括號、花括號或方括號,行語句可以跨越多行:
從 Jinja 2.2 開始,行注釋也可以使用了。例如如果配置 ## 為行注釋前綴, 行中所有 ## 之后的內容(不包括換行符)會被忽略:
Jinja 中最強大的部分就是模板繼承。模板繼承允許你構建一個包含你站點共同元素的基 本模板“骨架”,并定義子模板可以覆蓋的 塊。
聽起來復雜,實際上很簡單。從例子上手是最易于理解的。
這個模板,我們會把它叫做 base.html ,定義了一個簡單的 HTML 骨架文檔,你可 能使用一個簡單的兩欄頁面。用內容填充空的塊是子模板的工作:
在本例中, {% block %} 標簽定義了四個字幕版可以填充的塊。所有的 block標簽 告訴模板引擎子模板可以覆蓋模板中的這些部分。
一個子模板看起來是這樣:
{% extend %} 標簽是這里的關鍵。它告訴模板引擎這個模板“繼承”另一個模板。 當模板系統(tǒng)對這個模板求值時,首先定位父模板。 extends 標簽應該是模板中的第一個 標簽。它前面的所有東西都會按照普通情況打印出來,而且可能會導致一些困惑。更多 該行為的細節(jié)以及如何利用它,見 Null-Master 退回 。
模板的文件名依賴于模板加載器。例如 FileSystemLoader 允許你用文件名訪 問其它模板。你可以使用斜線訪問子目錄中的模板:
這種行為也可能依賴于應用內嵌的 Jinja 。注意子模板沒有定義 footer 塊,會 使用父模板中的值。
你不能在同一個模板中定義多個同名的 {% block %} 標簽。因為塊標簽以兩種 方向工作,所以存在這種限制。即一個塊標簽不僅提供一個可以填充的部分,也在父級 定義填充的內容。如果同一個模板中有兩個同名的 {% blok %} 標簽,父模板 無法獲知要使用哪一個塊的內容。
如果你想要多次打印一個塊,無論如何你可以使用特殊的 self變量并調用與塊同名 的函數:
可以調用 super來渲染父級塊的內容。這會返回父級塊的結果:
Jinja2 允許你在塊的結束標簽中加入的名稱來改善可讀性:
無論如何, endblock后面的名稱一定與塊名匹配。
嵌套塊可以勝任更復雜的布局。而默認的塊不允許訪問塊外作用域中的變量:
這個例子會輸出空的 <li> 項,因為 item在塊中是不可用的。其原因是,如果 塊被子模板替換,變量在其塊中可能是未定義的或未被傳遞到上下文。
從 Jinja 2.2 開始,你可以顯式地指定在塊中可用的變量,只需在塊聲明中添加 scoped修飾,就把塊設定到作用域中:
當覆蓋一個塊時,不需要提供 scoped修飾。
Changed in version 2.4.
當一個模板對象被傳遞到模板上下文,你也可以從那個對象繼承。假設調用 代碼傳遞 layout_template布局模板到環(huán)境,這段代碼會工作:
之前 layout_template變量一定是布局模板文件名的字符串才能工作。
當從模板生成 HTML 時,始終有這樣的風險:變量包含影響已生成 HTML 的字符。有兩種 解決方法:手動轉義每個字符或默認自動轉義所有的東西。
Jinja 兩者都支持,使用哪個取決于應用的配置。默認的配置未開啟自動轉義有這樣幾個 原因:
如果啟用了手動轉義,按需轉義變量就是 你的責任。要轉義什么?如果你有 一個 可能包含 > 、 < 、 & 或 ' 字符的變量,你必須轉義 它,除非變量中的 HTML 有可信的良好格式。轉義通過用管道傳遞到過濾器 |e 來實現: {{ user.username|e }} 。
當啟用了自動轉移,默認會轉移一切,除非值被顯式地標記為安全的??梢栽趹弥?標記,也可以在模板中使用 |safe過濾器標記。這種方法的主要問題是 Python 本 身沒有被污染的值的概念,所以一個值是否安全的信息會丟失。如果這個信息丟失, 會繼續(xù)轉義,你最后會得到一個轉義了兩次的內容。
但雙重轉義很容易避免,只需要依賴 Jinja2 提供的工具而不使用諸如字符串模運算符 這樣的 Python 內置結構。
返回模板數據(宏、 super、 self.BLOCKNAME)的函數,其返回值總是被標記 為安全的。
模板中的字符串字面量在自動轉義中被也被視為是不安全的。這是因為安全的字符串是 一個對 Python 的擴展,而不是每個庫都能妥善地使用它。
控制結構指的是所有的那些可以控制程序流的東西 —— 條件(比如 if/elif/ekse )、 for 循環(huán)、以及宏和塊之類的東西。控制結構在默認語法中以 {% .. %} 塊的形式 出現。
遍歷序列中的每項。例如,要顯示一個由 users`變量提供的用戶列表:
因為模板中的變量保留它們的對象屬性,可以迭代像 dict的容器:
注意無論如何字典通常是無序的,所以你可能需要把它作為一個已排序的列表傳入 到模板或使用 dictsort過濾器。
在一個 for 循環(huán)塊中你可以訪問這些特殊的變量:
變量 | 描述 |
---|---|
loop.index | 當前循環(huán)迭代的次數(從 1 開始) |
loop.index0 | 當前循環(huán)迭代的次數(從 0 開始) |
loop.revindex | 到循環(huán)結束需要迭代的次數(從 1 開始) |
loop.revindex0 | 到循環(huán)結束需要迭代的次數(從 0 開始) |
loop.first | 如果是第一次迭代,為 True 。 |
loop.last | 如果是最后一次迭代,為 True 。 |
loop.length | 序列中的項目數。 |
loop.cycle | 在一串序列間期取值的輔助函數。見下面的解釋。 |
在 for 循環(huán)中,可以使用特殊的 loop.cycle輔助函數,伴隨循環(huán)在一個字符串/變 量列表中周期取值:
從 Jinja 2.1 開始,一個額外的 cycle輔助函數允許循環(huán)限定外的周期取值。 更多信息請閱讀。
與 Python 中不同,模板中的循環(huán)內不能 break或 continue。但你可以在迭代 中過濾序列來跳過項目。下面的例子中跳過了所有隱藏的用戶:
好處是特殊的 loop可以正確地計數,從而不計入未迭代過的用戶。
如果因序列是空或者過濾移除了序列中的所有項目而沒有執(zhí)行循環(huán),你可以使用 else渲染一個用于替換的塊:
也可以遞歸地使用循環(huán)。當你處理諸如站點地圖之類的遞歸數據時很有用。要遞歸地 使用循環(huán),你只需要在循環(huán)定義中加上 recursive修飾,并在你想使用遞歸的地 方,對可迭代量調用 loop變量。
下面的例子用遞歸循環(huán)實現了站點地圖:
Jinja 中的 if語句可比 Python 中的 if 語句。在最簡單的形式中,你可以測試 一個變量是否未定義,為空或 false:
像在 Python 中一樣,用 elif和 else來構建多個分支。你也可以用更復雜的:
If 也可以被用作并作為。
宏類似常規(guī)編程語言中的函數。它們用于把常用行為作為可重用的函數,取代 手動重復的工作。
這里是一個宏渲染表單元素的小例子:
在命名空間中,宏之后可以像函數一樣調用:
如果宏在不同的模板中定義,你需要首先使用。
在宏內部,你可以訪問三個特殊的變量:
宏也可以暴露某些內部細節(jié)。下面的宏對象屬性是可用的:
如果一個宏的名稱以下劃線開始,它不是導出的且不能被導入。
在某些情況下,需要把一個宏傳遞到另一個宏。為此,可以使用特殊的 call塊。 下面的例子展示了如何讓宏利用調用功能:
也可以向調用塊傳遞參數。這在為循環(huán)做替換時很有用??偠灾?,調用塊的工作方 式幾乎與宏相同,只是調用塊沒有名稱。
這里是一個帶參數的調用塊的例子:
過濾器段允許你在一塊模板數據上應用常規(guī) Jinja2 過濾器。只需要把代碼用 filter節(jié)包裹起來:
在代碼塊中,你也可以為變量賦值。在頂層的(塊、宏、循環(huán)之外)賦值是可導出的,即 可以從別的模板中導入。
賦值使用 set標簽,并且可以為多個變量賦值:
extends標簽用于從另一個模板繼承。你可以在一個文件中使用多次繼承,但是 只會執(zhí)行其中的一個。見上面的關于的節(jié)。
塊用于繼承,同時作為占位符和用于替換的內容。節(jié)中詳細地介紹了塊。
include語句用于包含一個模板,并在當前命名空間中返回那個文件的內容渲 染結果:
被包含的模板默認可以訪問活動的上下文中的變量。更多關于導入和包含的上下文 行為見。
從 Jinja 2.2 開始,你可以把一句 include 用 ignore missing 標記,這樣 如果模板不存在,Jinja 會忽略這條語句。當與 with 或 without context 語句聯(lián)合使用時,它必須被放在上下文可見性語句 之前。這里是一些有效的例 子:
New in version 2.2.
你也可以提供一個模板列表,它會在包含前被檢查是否存在。第一個存在的模板會 被包含進來。如果給出了 ignore missing,且所有這些模板都不存在,會退化 至不做任何渲染,否則將會拋出一個異常。
例子:
Changed in version 2.4:如果傳遞一個模板對象到模板上下文,你可以用 include包含這個對 象。
Jinja2 支持在宏中放置經常使用的代碼。這些宏可以被導入,并不同的模板中使用。這 與 Python 中的 import 語句類似。要知道的是,導入量會被緩存,并且默認下導入的 模板不能訪問當前模板中的非全局變量。更多關于導入和包含的上下文行為見。
有兩種方式來導入模板。你可以把整個模板導入到一個變量或從其中導入請求特定的宏 /導出量。
比如我們有一個渲染表單(名為 forms.html)的助手模塊:
最簡單靈活的方式是把整個模塊導入為一個變量。這樣你可以訪問屬性:
此外你也可以從模板中導入名稱到當前的命名空間:
名稱以一個或更多下劃線開始的宏和變量是私有的,不能被導入。
Changed in version 2.4:如果傳遞一個模板對象到模板上下文,從那個對象中導入。
默認下,每個包含的模板會被傳遞到當前上下文,而導入的模板不會。這樣做的原因 是導入量不會像包含量被緩存,因為導入量經常只作容納宏的模塊。
無論如何,這當然也可以顯式地更改。通過在 import/include 聲明中直接添加 with context或 without context,當前的上下文可以傳遞到模板,而且不會 自動禁用緩存。
這里有兩個例子:
提示
在 Jinja 2.0 中,被傳遞到被包含模板的上下文不包含模板中定義的變量。 事實上,這不能工作:
在 Jinja 2.0 中,被包含的模板 render_box.html 不能訪問 box。從 Jinja 2.1 開始, render_box.html 可以這么做。
Jinja 中到處都允許使用基本表達式。這像常規(guī)的 Python 一樣工作,即使你不用 Python 工作,你也會感受到其帶來的便利。
表達式最簡單的形式就是字面量。字面量表示諸如字符串和數值的 Python 對象。下面 的字面量是可用的:
一對中括號括起來的東西是一個列表。列表用于存儲和迭代序列化的數據。例如 你可以容易地在 for 循環(huán)中用列表和元組創(chuàng)建一個鏈接的列表:
提示
特殊常量 true、 false和 none實際上是小寫的。因為這在過去會導致 混淆,過去 True擴展為一個被認為是 false 的未定義的變量。所有的這三個 常量也可以被寫成首字母大寫( True、 False和 None)。盡管如此, 為了一致性(所有的 Jinja 標識符是小寫的),你應該使用小寫的版本。
Jinja 允許你用計算值。這在模板中很少用到,但是為了完整性允許其存在。支持下面的 運算符:
對于 if語句,在 for過濾或 if表達式中,它可以用于聯(lián)合多個表達式:
提示
is 和 in 運算符同樣支持使用中綴記法: foo is not bar 和 foo not in bar 而不是 not foo is bar 和 not foo in bar 。所有的 其它表達式需要前綴記法 not (foo and bar) 。
下面的運算符非常有用,但不適用于其它的兩個分類:
同樣,也可以使用內聯(lián)的 if表達式。這在某些情況很有用。例如你可以用來在一個 變量定義的情況下才繼承一個模板,否則繼承默認的布局模板:
一般的語法是 <do something> if <something is true> else <do something else> 。
else部分是可選的。如果沒有顯式地提供 else 塊,會求值一個未定義對象:
Return the absolute value of the argument.
Get an attribute of an object. foo|attr('bar') works like foo['bar'] just that always an attribute is returned and items are not looked up.
See Notes on subscriptions for more details.
A filter that batches items. It works pretty much like slicejust the other way round. It returns a list of lists with the given number of items. If you provide a second parameter this is used to fill up missing items. See this example:
Capitalize a value. The first character will be uppercase, all others lowercase.
Centers the value in a field of a given width.
If the value is undefined it will return the passed default value, otherwise the value of the variable:
This will output the value of my_variable if the variable was defined, otherwise 'my_variable is not defined' . If you want to use default with variables that evaluate to false you have to set the second parameter to true:
Aliases : | d |
---|
Sort a dict and yield (key, value) pairs. Because python dicts are unsorted you may want to use this function to order them by either key or value:
Convert the characters &, <, >, ‘, and ” in string s to HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML. Marks return value as markup string.
Aliases : | e |
---|
Format the value like a ‘human-readable’ file size (i.e. 13 kB, 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega, Giga, etc.), if the second parameter is set to Truethe binary prefixes are used (Mebi, Gibi).
Return the first item of a sequence.
Convert the value into a floating point number. If the conversion doesn’t work it will return 0.0 . You can override this default using the first parameter.
Enforce HTML escaping. This will probably double escape variables.
Apply python string formatting on an object:
Group a sequence of objects by a common attribute.
If you for example have a list of dicts or objects that represent persons with gender, first_nameand last_nameattributes and you want to group all users by genders you can do something like the following snippet:
Additionally it’s possible to use tuple unpacking for the grouper and list:
As you can see the item we’re grouping by is stored in the grouperattribute and the listcontains all the objects that have this grouper in common.
Changed in version 2.6:It’s now possible to use dotted notation to group by the child attribute of another attribute.
Return a copy of the passed string, each line indented by 4 spaces. The first line is not indented. If you want to change the number of spaces or indent the first line too you can pass additional parameters to the filter:
Convert the value into an integer. If the conversion doesn’t work it will return 0 . You can override this default using the first parameter.
Return a string which is the concatenation of the strings in the sequence. The separator between elements is an empty string per default, you can define it with the optional parameter:
It is also possible to join certain attributes of an object:
New in version 2.6:The attributeparameter was added.
Return the last item of a sequence.
Return the number of items of a sequence or mapping.
Aliases : | count |
---|
Convert the value into a list. If it was a string the returned list will be a list of characters.
Convert a value to lowercase.
Applies a filter on a sequence of objects or looks up an attribute. This is useful when dealing with lists of objects but you are really only interested in a certain value of it.
The basic usage is mapping on an attribute. Imagine you have a list of users but you are only interested in a list of usernames:
Alternatively you can let it invoke a filter by passing the name of the filter and the arguments afterwards. A good example would be applying a text conversion filter on a sequence:
New in version 2.7.
Pretty print a variable. Useful for debugging.
With Jinja 1.2 onwards you can pass it a parameter. If this parameter is truthy the output will be more verbose (this requires pretty)
Return a random item from the sequence.
Filters a sequence of objects by appying a test to either the object or the attribute and rejecting the ones with the test succeeding.
Example usage:
New in version 2.7.
Filters a sequence of objects by appying a test to either the object or the attribute and rejecting the ones with the test succeeding.
New in version 2.7.
Return a copy of the value with all occurrences of a substring replaced with a new one. The first argument is the substring that should be replaced, the second is the replacement string. If the optional third argument count is given, only the first count occurrences are replaced:
Reverse the object or return an iterator the iterates over it the other way round.
Round the number to a given precision. The first parameter specifies the precision (default is 0 ), the second the rounding method:
If you don’t specify a method 'common' is used.
Note that even if rounded to 0 precision, a float is returned. If you need a real integer, pipe it through int:
Mark the value as safe which means that in an environment with automatic escaping enabled this variable will not be escaped.
Filters a sequence of objects by appying a test to either the object or the attribute and only selecting the ones with the test succeeding.
Example usage:
New in version 2.7.
Filters a sequence of objects by appying a test to either the object or the attribute and only selecting the ones with the test succeeding.
Example usage:
New in version 2.7.
Slice an iterator and return a list of lists containing those items. Useful if you want to create a div containing three ul tags that represent columns:
If you pass it a second argument it’s used to fill missing values on the last iteration.
Sort an iterable. Per default it sorts ascending, if you pass it true as first argument it will reverse the sorting.
If the iterable is made of strings the third parameter can be used to control the case sensitiveness of the comparison which is disabled by default.
It is also possible to sort by an attribute (for example to sort by the date of an object) by specifying the attributeparameter:
Changed in version 2.6:The attributeparameter was added.
Make a string unicode if it isn’t already. That way a markup string is not converted back to unicode.
Strip SGML/XML tags and replace adjacent whitespace by one space.
Returns the sum of a sequence of numbers plus the value of parameter ‘start’ (which defaults to 0). When the sequence is empty it returns start.
It is also possible to sum up only certain attributes:
Changed in version 2.6:The attributeparameter was added to allow suming up over attributes. Also the startparameter was moved on to the right.
Return a titlecased version of the value. I.e. words will start with uppercase letters, all remaining characters are lowercase.
Strip leading and trailing whitespace.
Return a truncated copy of the string. The length is specified with the first parameter which defaults to 255 . If the second parameter is true the filter will cut the text at length. Otherwise it will discard the last word. If the text was in fact truncated it will append an ellipsis sign ( '...' ). If you want a different ellipsis sign than '...' you can specify it using the third parameter.
Convert a value to uppercase.
Escape strings for use in URLs (uses UTF-8 encoding). It accepts both dictionaries and regular strings as well as pairwise iterables.
New in version 2.7.
Converts URLs in plain text into clickable links.
If you pass the filter an additional integer it will shorten the urls to that number. Also a third argument exists that makes the urls “nofollow”:
Count the words in that string.
Return a copy of the string passed to the filter wrapped after 79 characters. You can override this default using the first parameter. If you set the second parameter to falseJinja will not split words apart if they are longer than width. By default, the newlines will be the default newlines for the environment, but this can be changed using the wrapstring keyword argument.
New in version 2.7:Added support for the wrapstringparameter.
Create an SGML/XML attribute string based on the items in a dict. All values that are neither nonenor undefinedare automatically escaped:
Results in something like this:
As you can see it automatically prepends a space in front of the item if the filter returned something unless the second parameter is false.
Return whether the object is callable (i.e., some kind of function). Note that classes are callable, as are instances with a __call__() method.
Return true if the variable is defined:
See thefilter for a simple way to set undefined variables.
Check if a variable is divisible by a number.
Check if the value is escaped.
Return true if the variable is even.
Check if it’s possible to iterate over an object.
Return true if the variable is lowercased.
Return true if the object is a mapping (dict etc.).
New in version 2.6.
Return true if the variable is none.
Return true if the variable is a number.
Return true if the variable is odd.
Check if an object points to the same memory address than another object:
Return true if the variable is a sequence. Sequences are variables that are iterable.
Return true if the object is a string.
Likebut the other way round.
Return true if the variable is uppercased.
默認下,下面的函數在全局作用域中可用:
返回一個包含整等差級數的列表。 range(i, j) 返回 [i, i 1, i 2, ...., j-1] ;起始值(!)默認為 0 。當給定了公差,它決定了增長(或減?。?。 例如 range(4) 返回 [0, 1, 2, 3] 。末端的值被丟棄了。這些是一個 4 元素 數組的有效索引值。
例如重復一個模板塊多次來填充一個列表是有用的。想向你有一個 7 個用戶的 列表,但你想要渲染三個空項目來用 CSS 強制指定高度:
在模板中生成 lorem ipsum 亂數假文。默認會生成 5 段 HTML ,每段在 20 到 100 詞之間。如果 HTML 被禁用,會返回常規(guī)文本。這在測試布局時生成簡單內容時很有 用。
方便的字典字面量替代品。 {'foo' : 'bar'} 與 dict(foo=bar) 等價。
周期計允許你在若干個值中循環(huán),類似 loop.cycle的工作方式。不同于 loop.cycle的是,無論如何你都可以在循環(huán)外或在多重循環(huán)中使用它。
比如如果你想要顯示一個文件夾和文件列表,且文件夾在上,它們在同一個列表中且 行顏色是交替的。
下面的例子展示了如何使用周期計:
重置周期計到第一個項。
返回當前項并跳轉到下一個。
返回當前項。.
New in version 2.1.
一個小巧的輔助函數用于“連接”多個節(jié)。連接器接受一個字符串,每次被調用時返回 那個字符串,除了第一次調用時返回一個空字符串。你可以使用它來連接:
New in version 2.1.
下面的幾節(jié)涵蓋了可能被應用啟用的 Jinja2 內置的擴展。應用也可以提供進一步 的擴展,但這不會在此描述。會有獨立的文檔來解釋那種情況下的擴展。
如果啟用來 i18n 擴展,可以把模板中的部分標記為可譯的。標記一個段為可譯的,可 以使用 trans:
要翻譯一個模板表達式——比如使用模板過濾器或訪問對象的屬性——你需要綁定表達式到 一個名稱來在翻譯塊中使用:
如果你需要在 trans標簽中綁定一個以上的表達式,用逗號來分割( , ):
在翻譯塊中不允許使用語句,只能使用變量標簽。
為表示復數,在 trans和 endtrans之間用 pluralize標簽同時指定單數和復 數形式:
默認情況下塊中的第一個變量用于決定使用單數還是復數。如果這不奏效,你可以指定 用于復數的名稱作為 pluralize的參數:
也可以翻譯表達式中的字符串。為此,有三個函數:
_ gettext: 翻譯一個單數字符串 - ngettext: 翻譯一個復數字符串 - _: gettext的別名
例如你可以容易地這樣打印一個已翻譯的字符串:
你可以使用 format過濾器來使用占位符:
因為其它語言可能不會用同樣的順序使用詞匯,要使用多個占位符,應始終用字符 串參數傳給 format。
Changed in version 2.5.
如果激活了新樣式的 gettext 調用( 新樣式 Gettext ),使用占位符 會更加簡單:
注意 ngettext函數的格式化字符串自動接受 num參數作為計數作為附加的 常規(guī)參數。
如果加載了表達式語句擴展,一個名為 do的擴展即可用。它工作幾乎如同常規(guī)的變量 表達式( {{ ... }} ),只是它不打印任何東西。這可以用于修改列表:
如果應用啟用來 循環(huán)控制 ,則可以在循環(huán)中使用 break和 continue。到達 break時,循環(huán)終止。到達 continue時,當前處理會終止并 從下一次迭代繼續(xù)。
這個循環(huán)每兩項跳過一次:
同樣,這個循環(huán) 10 次迭代之后會終止處理:
New in version 2.3.
如果應用啟用了 With 語句 ,將允許在模板中使用 with關鍵 字。這使得創(chuàng)建一個新的內作用域。這個作用域中的變量在外部是不可見的。
With 用法簡介:
因為在作用域的開始設置變量很常見,你可以在 with 語句里這么做。下面的兩 個例子是等價的:
New in version 2.4.
如果你的應用程序設置了 自動轉義擴展 ,你就可以在模版中開啟或者關閉自動轉義。
例子:
在 endautoescape標簽之后,自動轉義的行為將回到與之前相同的狀態(tài)。
聯(lián)系客服