在Python的Django架構中編寫編譯函數

當遇到一個模板標籤（template tag）時，模板解析器就會把標籤包含的內容，以及模板解析器自己作為參數調用一個python函數。 這個函數負責返回一個和當前模板標籤內容相對應的節點（Node）的執行個體。

例如，寫一個顯示當前日期的模板標籤：{% current_time %}。該標籤會根據參數指定的 strftime 格式（參見：http://www.djangoproject.com/r/python/strftime/）顯示目前時間。首先確定標籤的文法是個好主意。 在這個例子裡，標籤應該這樣使用：

The time is {% current_time "%Y-%m-%d %I:%M %p" %}.

注意

沒錯, 這個模板標籤是多餘的，Django預設的 {% now %} 用更簡單的文法完成了同樣的工作。 這個模板標籤在這裡只是作為一個例子。

這個函數的分析器會擷取參數並建立一個 Node 對象:

from django import templateregister = template.Library()def do_current_time(parser, token):  try:    # split_contents() knows not to split quoted strings.    tag_name, format_string = token.split_contents()  except ValueError:    msg = '%r tag requires a single argument' % token.split_contents()[0]    raise template.TemplateSyntaxError(msg)  return CurrentTimeNode(format_string[1:-1])

這裡需要說明的地方很多：

每個標籤編譯函數有兩個參數，parser和token。parser是模板解析器對象。 我們在這個例子中並不使用它。 token是正在被解析的語句。

token.contents 是包含有標籤原始內容的字串。 在我們的例子中，它是 'current_time "%Y-%m-%d %I:%M %p"' 。

token.split_contents() 方法按空格拆分參數同時保證引號中的字串不拆分。 應該避免使用 token.contents.split() （僅使用Python的標準字串拆分）。 它不夠健壯，因為它只是簡單的按照所有空格進行拆分，包括那些引號引起來的字串中的空格。

這個函數可以拋出 django.template.TemplateSyntaxError ，這個異常提供所有語法錯誤的有用資訊。

不要把標籤名稱寫入程式碼在你的錯誤資訊中，因為這樣會把標籤名稱和你的函數耦合在一起。 token.split_contents()[0]總是記錄標籤的名字，就算標籤沒有任何參數。

這個函數返回一個 CurrentTimeNode （稍後我們將建立它），它包含了節點需要知道的關於這個標籤的全部資訊。 在這個例子中，它只是傳遞了參數 "%Y-%m-%d %I:%M %p" 。模板標籤開頭和結尾的引號使用 format_string[1:-1] 除去。

模板標籤編譯函數 必須 返回一個 Node 子類，返回其它值都是錯的。

