Python模板庫Mako的用法

Mako是一個高效能的Python模板庫，它的語法和API借鑑了很多其他的模板庫，如Django、Jinja2等等。

基本用法

建立模板並渲染它的最基本的方法是使用 Template 類：

傳給 Template 的文字引數被編譯為一個Python模組。模組包含一個 render_body() 函式，它產生模板的輸出。呼叫 render() 方法時，Mako建立了一個模板的執行環境，並呼叫 render_body() 函式，把輸出儲存到緩衝，返回它的字串內容。
render_body() 函式中可以訪問一個變數集。可以向 render() 方法傳送額外的關鍵詞引數來指定這些變數：

ender() 方法使Mako建立一個 Context 物件，它儲存模板可以訪問的所有變數和一個用來儲存輸出的緩衝。也可以自己建立 Context ，用 render_context() 方法使模板用它來渲染：

使用檔案模板

Template 也可以從檔案載入模板，使用 filename 引數：

為了提高效能，從檔案載入的 Template 還可以在檔案系統中將生成的模組快取為一般的Python模組檔案（.py檔案），這通過新增 module_directory 引數實現：

上面的程式碼渲染後，會建立一個/tmp/mako_modules/docs/tpl.txt.py檔案，其中包含模組的原始碼。下次同樣引數的 Template 建立時，自動重用這個模組檔案。

使用TemplateLookup

到現在的例子都是有關單個 Template 物件的用法。如果模板中的程式碼要定位其他模板資源，需要某種使用URI來找到它們的方法。這種需求是由 TemplateLookup 類來達到的。這個類通過傳入一個模板查詢目錄的列表來構造，然後作為關鍵詞引數傳給 Template 物件：

上面建立的模板中包含檔案header.txt。為了查詢header.txt，傳了一個 TemplateLookup 物件給它。
通常，應用會以文字檔案形式在檔案系統上儲存大部分或全部的模板。一個真正的應用會直接從 TemplateLookup 取得它的模板，使用 get_template() 方法，它接受需要的模板的URI作為引數：

面的例子中我們建立了一個 TemplateLookup ，它從/docs目錄中查詢模板，並把所有的模組檔案儲存到/tmp/mako_modules目錄中。通過將傳入的URI附加到每個查詢目錄來定位模 板，如傳遞/etc/beans/info.txt，將查詢檔案/docs/etc/beans/info.txt，如果沒找到將丟擲 TopLevelNotFound 異常。
當定位到模板的時候，傳給 get_template() 呼叫的URI也會作為 Template 的 uri 屬性。 Template 使用這個URI來得到模組檔案的名字，因此上面的例子中對/etc/beans/info.txt會建立模組檔案/tmp/mako_modules /etc/beans/info.txt.py。

設定收集的大小

TemplateLookup 還滿足將記憶體中快取的模板總數設為一個固定的值。預設情況 TemplateLookup 大小是不限的。可以用 collection_size 引數指定一個固定值：

上面的 lookup 將模板載入到記憶體中的上限是500個。之後，它將使用LRU策略來清理替換模板。

設定檔案系統檢查

TemplateLookup 的另一個重要標誌是 filesystem_checks 。預設為 True ，每次 get_template() 方法返回一個模板，會比較原始模板檔案的修改時間和模板的最近載入時間，如果檔案更新，就重新載入和編譯模板。在生產系統中，將 filesystem_checks 設為 False 能獲得一些效能的提升。

使用Unicode和編碼

Template 和 TemplateLookup 可以設定 output_encoding 和 encoding_errors 引數來將輸出編碼為Python支援的編碼格式：

使用Python 3時，如果設定了 output_encoding ， render() 方法將返回一個 bytes 物件，否則返回 string 。
render_unicode() 方法返回模板輸出為Python unicode 物件，Python 3為 string ：

上面的方法沒有輸出編碼的引數，可以自行編碼：

注意Mako中模板的底層輸出流是Python Unicode物件。

處理異常

模板異常可能發生在兩個地方。一個是當你查詢、解析和編譯模板的時候，一個是執行模板的時候。模板執行中發生的異常會正常在產生問題的Python程式碼處 丟擲。Mako有自己的一組異常類，它們主要用於模板構造的查詢和編譯階段。Mako提供了一些庫例程用來對異常棧提供Mako的資訊，並將異常輸出為文 本或HTML格式。Python檔名、行號和程式碼片段會被轉換為Mako模板檔名、行號和程式碼片段。Mako模板模組的行會被轉換為原始的模板檔案對 應行。

text_error_template() 和 html_error_template() 函式用於格式化異常跟蹤。它們使用 sys.exc_info() 來得到最近丟擲的異常。這些處理器的用法像下面這樣：

html_error_template() 模板接受兩個選項：指定 full=False 只渲染HTML的一節，指定 css=False 關閉預設的樣式表。如：

HTML渲染函式也可以用 format_exceptions 標誌加到 Template 中。這種情況下，模板在渲染階段的任何異常在輸出中的結果都會替換為 html_error_template() 的輸出：

注意上面模板的編譯階段發生在構造 Template 時，沒有定義輸出流。因此查詢、解析、編譯階段發生的異常正常情況下不會被處理，而是傳播下去。渲染前的追溯不包括Mako形式的行，這意味著渲染前和渲 染中發生的異常會用不同的方式處理，因此 try/except 可能更常用。

錯誤模板函式使用的底層物件是 RichTraceback 物件。這個物件也可以直接用來提供自定義的錯誤檢視。下面是一個用法的樣例：

整合Mako

在Django中整合Mako

通過Django的中介軟體可以整合Mako。首先需要安裝django-mako模組。
在Django專案的settings.py檔案中，修改 MIDDLEWARE_CLASSES ，新增 djangomako.middleware.MakoMiddleware 。使用 render_to_response() 函式即可使用：

在Tornado中整合Mako

在Tornado中可以直接使用Mako，下面是一個使用示例：