這篇文章主要介紹了詳解Python的Django框架中inclusion_tag的使用,文中示例基于Python較早的2.x版本,希望能夠注意一下,需要的朋友可以參考下
另外一類常用的模板標簽是通過渲染 其他 模板顯示數據的。 比如說,Django的后臺管理界面,它使用了自定義的模板標簽來顯示新增/編輯表單頁面下部的按鈕。 那些按鈕看起來總是一樣的,但是鏈接卻隨著所編輯的對象的不同而改變。 這就是一個使用小模板很好的例子,這些小模板就是當前對象的詳細信息。
這些排序標簽被稱為 包含標簽 。如何寫包含標簽最好通過舉例來說明。 讓我們來寫一個能夠產生指定作者對象的書籍清單的標簽。 我們將這樣利用標簽:
- {% books_for_author author %}
結果將會像下面這樣:
- <ul>
- <li>The Cat In The Hat</li>
- <li>Hop On Pop</li>
- <li>Green Eggs And Ham</li>
- </ul>
首先,我們定義一個函數,通過給定的參數生成一個字典形式的結果。 需要注意的是,我們只需要返回字典類型的結果就行了,不需要返回更復雜的東西。 這將被用來作為模板片段的內容:
- def books_for_author(author):
- books = Book.objects.filter(authors__id=author.id)
- return {'books': books}
接下來,我們創建用于渲染標簽輸出的模板。 在我們的例子中,模板很簡單:
- <ul>
- {% for book in books %}
- <li>{{ book.title }}</li>
- {% endfor %}
- </ul>
最后,我們通過對一個 Library 對象使用 inclusion_tag() 方法來創建并注冊這個包含標簽。
在我們的例子中,如果先前的模板在 polls/result_snippet.html 文件中,那么我們這樣注冊標簽:
- register.inclusion_tag('book_snippet.html')(books_for_author)
Python 2.4裝飾器語法也能正常工作,所以我們可以這樣寫:
- @register.inclusion_tag('book_snippet.html')
- def books_for_author(author):
- # ...
有時候,你的包含標簽需要訪問父模板的context。 為了解決這個問題,Django為包含標簽提供了一個 takes_context 選項。 如果你在創建模板標簽時,指明了這個選項,這個標簽就不需要參數,并且下面的Python函數會帶一個參數: 就是當這個標簽被調用時的模板context。
例如,你正在寫一個包含標簽,該標簽包含有指向主頁的 home_link 和 home_title 變量。 Python函數會像這樣:
- @register.inclusion_tag('link.html', takes_context=True)
- def jump_link(context):
- return {
- 'link': context['home_link'],
- 'title': context['home_title'],
- }
(注意函數的第一個參數 必須 是 context 。)
模板 link.html 可能包含下面的東西:
- Jump directly to <a href="{{ link }}">{{ title }}</a>.
然后您想使用自定義標簽時,就可以加載它的庫,然后不帶參數地調用它,就像這樣:
- {% jump_link %}
新聞熱點
疑難解答