當遇到一個模板標簽（template tag）時，模板解析器就會把標簽包含的內容，以及模板解析器自己作為參數(shù)調用一個python函數(shù)。 這個函數(shù)負責返回一個和當前模板標簽內容相對應的節(jié)點（Node）的實例。

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

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

注意

沒錯, 這個模板標簽是多余的，Django默認的 {% now %} 用更簡單的語法完成了同樣的工作。 這個模板標簽在這里只是作為一個例子。

這個函數(shù)的分析器會獲取參數(shù)并創(chuàng)建一個 Node 對象:

from django import template

register = 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])

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

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

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

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

    這個函數(shù)可以拋出 django.template.TemplateSyntaxError ，這個異常提供所有語法錯誤的有用信息。

    不要把標簽名稱硬編碼在你的錯誤信息中，因為這樣會把標簽名稱和你的函數(shù)耦合在一起。 token.split_contents()[0]總是記錄標簽的名字，就算標簽沒有任何參數(shù)。

    這個函數(shù)返回一個 CurrentTimeNode （稍后我們將創(chuàng)建它），它包含了節(jié)點需要知道的關于這個標簽的全部信息。 在這個例子中，它只是傳遞了參數(shù) "%Y-%m-%d %I:%M %p" 。模板標簽開頭和結尾的引號使用 format_string[1:-1] 除去。

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

最新評論