當(dāng)遇到一個(gè)模板標(biāo)簽（template tag）時(shí)，模板解析器就會(huì)把標(biāo)簽包含的內(nèi)容，以及模板解析器自己作為參數(shù)調(diào)用一個(gè)python函數(shù)。 這個(gè)函數(shù)負(fù)責(zé)返回一個(gè)和當(dāng)前模板標(biāo)簽內(nèi)容相對(duì)應(yīng)的節(jié)點(diǎn)（Node）的實(shí)例。

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

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

注意

沒錯(cuò), 這個(gè)模板標(biāo)簽是多余的，Django默認(rèn)的 {% now %} 用更簡(jiǎn)單的語法完成了同樣的工作。 這個(gè)模板標(biāo)簽在這里只是作為一個(gè)例子。

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

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

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

    每個(gè)標(biāo)簽編譯函數(shù)有兩個(gè)參數(shù)，parser和token。parser是模板解析器對(duì)象。 我們?cè)谶@個(gè)例子中并不使用它。 token是正在被解析的語句。

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

    token.split_contents() 方法按空格拆分參數(shù)同時(shí)保證引號(hào)中的字符串不拆分。 應(yīng)該避免使用 token.contents.split() （僅使用Python的標(biāo)準(zhǔn)字符串拆分）。 它不夠健壯，因?yàn)樗皇呛?jiǎn)單的按照所有空格進(jìn)行拆分，包括那些引號(hào)引起來的字符串中的空格。

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

    不要把標(biāo)簽名稱硬編碼在你的錯(cuò)誤信息中，因?yàn)檫@樣會(huì)把標(biāo)簽名稱和你的函數(shù)耦合在一起。 token.split_contents()[0]總是記錄標(biāo)簽的名字，就算標(biāo)簽沒有任何參數(shù)。

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

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

最新評(píng)論