Django模板系統

官方文件

常用語法

只需要記兩種特殊符號：

{{ }}和 {% %}

變數相關的用{{}}，邏輯相關的用{%%}。

變數

在Django的模板語言中按此語法使用：{{ 變數名 }}。

當模版引擎遇到一個變數，它將計算這個變數，然後用結果替換掉它本身。 變數的命名包括任何字母數字以及下劃線 ("_")的組合。 變數名稱中不能有空格或標點符號。

點（.）在模板語言中有特殊的含義。當模版系統遇到點(".")，它將以這樣的順序查詢：

字典查詢（Dictionary lookup） 屬性或方法查詢（Attribute or method lookup） 數字索引查詢（Numeric index lookup）

注意事項：

1. 如果計算結果的值是可呼叫的，它將被無引數的呼叫。 呼叫的結果將成為模版的值。

2. 如果使用的變數不存在， 模版系統將插入 string_if_invalid 選項的值， 它被預設設定為'' (空字串) 。

幾個例子：

view中程式碼：

def template_test(request):
    l = [11, 22, 33]
    d = {"name": "alex"}
​
    class Person(object):
        def __init__(self, name, age):
            self.name = name
            self.age = age
​
        def dream(self):
            return "{} is dream...".format(self.name)
​
    Alex = Person(name="Alex", age=34)
    jason = Person(name="jason", age=9000)
    Eva_J = Person(name="Eva_J", age=18)
​
    person_list = [Alex, jason, Eva_J]
    return render(request, "template_test.html", {"l": l, "d": d, "person_list": person_list})
 

模板中支援的寫法：

{# 取l中的第一個引數 #}
{{ l.0 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取物件的name屬性 #}
{{ person_list.0.name }}
{# .操作只能呼叫不帶引數的方法 #}
{{ person_list.0.dream }}

Filters（過濾器）

在Django的模板語言中，通過使用 過濾器 來改變變數的顯示。

過濾器的語法： {{ value|filter_name:引數 }}

使用管道符"|"來應用過濾器。

例如：{{ name|lower }}會將name變數應用lower過濾器之後再顯示它的值。lower在這裡的作用是將文字全都變成小寫。

注意事項：

1. 過濾器支援“鏈式”操作。即一個過濾器的輸出作為另一個過濾器的輸入。

2. 過濾器可以接受引數，例如：{{ sss|truncatewords:30 }}，這將顯示sss的前30個詞。

3. 過濾器引數包含空格的話，必須用引號包裹起來。比如使用逗號和空格去連線一個列表中的元素，如：{{ list|join:', ' }}

4. '|'左右沒有空格沒有空格沒有空格

Django的模板語言中提供了大約六十個內建過濾器。

default

如果一個變數是false或者為空，使用給定的預設值。 否則，使用變數的值。

{{ value|default:"nothing"}}

如果value沒有傳值或者值為空的話就顯示nothing

length

返回值的長度，作用於字串和列表。

{{ value|length }}

返回value的長度，如 value=['a', 'b', 'c', 'd']的話，就顯示4.

filesizeformat

將值格式化為一個 “人類可讀的” 檔案尺寸 （例如 '13 KB', '4.1 MB', '102 bytes', 等等）。例如：

{{ value|filesizeformat }}

如果 value 是 123456789，輸出將會是 117.7 MB。

slice

切片

{{value|slice:"2:-1"}}

date

格式化

{{ value|date:"Y-m-d H:i:s"}}

可用的引數：

safe

Django的模板中會對HTML標籤和JS等語法標籤進行自動轉義，原因顯而易見，這樣是為了安全。但是有的時候我們可能不希望這些HTML元素被轉義，比如我們做一個內容管理系統，後臺新增的文章中是經過修飾的，這些修飾可能是通過一個類似於FCKeditor編輯加註了HTML修飾符的文字，如果自動轉義的話顯示的就是保護HTML標籤的原始檔。為了在Django中關閉HTML的自動轉義有兩種方式，如果是一個單獨的變數我們可以通過過濾器“|safe”的方式告訴Django這段程式碼是安全的不必轉義。

比如：

value = "點我"

{{ value|safe}}

truncatechars

如果字串字元多於指定的字元數量，那麼會被截斷。截斷的字串將以可翻譯的省略號序列（“...”）結尾。

引數：截斷的字元數

{{ value|truncatechars:9}}

truncatewords

在一定數量的字後截斷字串。

{{ value|truncatewords:9}}

cut

移除value中所有的與給出的變數相同的字串

{{ value|cut:' ' }}

如果value為'i love you'，那麼將輸出'iloveyou'.

join

使用字串連線列表，例如Python的str.join(list)

timesince

將日期格式設為自該日期起的時間（例如，“4天，6小時”）。

採用一個可選引數，它是一個包含用作比較點的日期的變數（不帶引數，比較點為現在）。 例如，如果blog_date是表示2006年6月1日午夜的日期例項，並且comment_date是2006年6月1日08:00的日期例項，則以下將返回“8小時”：

{{ blog_date|timesince:comment_date }}

分鐘是所使用的最小單位，對於相對於比較點的未來的任何日期，將返回“0分鐘”。

timeuntil

似於timesince，除了它測量從現在開始直到給定日期或日期時間的時間。 例如，如果今天是2006年6月1日，而conference_date是保留2006年6月29日的日期例項，則{{ conference_date | timeuntil }}將返回“4周”。

使用可選引數，它是一個包含用作比較點的日期（而不是現在）的變數。 如果from_date包含2006年6月22日，則以下內容將返回“1周”：

{{ conference_date|timeuntil:from_date }}

自定義過濾器filter

自定義過濾器只是帶有一個或兩個引數的Python函式:

• 變數（輸入）的值 - -不一定是一個字串

• 引數的值 - 這可以有一個預設值，或完全省略

例如，在過濾器{{var | foo:'bar'}}中，過濾器foo將傳遞變數var和引數“bar”。

自定義filter程式碼檔案擺放位置：

app01/
    __init__.py
    models.py
    templatetags/  # 在app01下面新建一個package package
        __init__.py
        app01_filters.py  # 建一個存放自定義filter的檔案
    views.py

編寫自定義filter

from django import template
register = template.Library()


@register.filter(name="cut")
def cut(value, arg):
    return value.replace(arg, "")


@register.filter(name="addSB")
def add_sb(value):
    return "{} SB".format(value)

使用自定義filter

{# 先匯入我們自定義filter那個檔案 #}
{% load app01_filters %}

{# 使用我們自定義的filter #}
{{ somevariable|cut:"0" }}
{{ d.name|addSB }}

Tags

for迴圈

普通for迴圈

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>

for迴圈可用的一些引數：

for ... empty

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% empty %}
    <li>空空如也</li>
{% endfor %}
</ul>

if判斷

if,elif和``else

{% if user_list %}
  使用者人數：{{ user_list|length }}
{% elif black_list %}
  黑名單數：{{ black_list|length }}
{% else %}
  沒有使用者
{% endif %}

當然也可以只有if和else

{% if user_list|length > 5 %}
  七座豪華SUV
{% else %}
    黃包車
{% endif %}

if語句支援 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判斷。

with

定義一箇中間變數，多用於給一個複雜的變數起別名。

注意等號左右不要加空格。

{% with total=business.employees.count %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

或

{% with business.employees.count as total %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

csrf_token

這個標籤用於跨站請求偽造保護。

在頁面的form表單裡面寫上{% csrf_token %}

註釋

{# ... #}

注意事項

\1. Django的模板語言不支援連續判斷，即不支援以下寫法：

{% if a > b > c %}
...
{% endif %}

\2. Django的模板語言中屬性的優先順序大於方法

def xx(request):
    d = {"a": 1, "b": 2, "c": 3, "items": "100"}
    return render(request, "xx.html", {"data": d})

如上，我們在使用render方法渲染一個頁面的時候，傳的字典d有一個key是items並且還有預設的 d.items() 方法，此時在模板語言中:

{{ data.items }}

預設會取d的items key的值。

母板

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Title</title>
  {% block page-css %}
  
  {% endblock %}
</head>
<body>

<h1>這是母板的標題</h1>

{% block page-main %}

{% endblock %}
<h1>母板底部內容</h1>
{% block page-js %}

{% endblock %}
</body>
</html>

注意：我們通常會在母板中定義頁面專用的CSS塊和JS塊，方便子頁面替換。

繼承母板

在子頁面中在頁面最上方使用下面的語法來繼承母板。

{% extends 'layouts.html' %}

塊（block）

通過在母板中使用{% block xxx %}來定義"塊"。

在子頁面中通過定義母板中的block名來對應替換母板中相應的內容。

{% block page-main %}
  <p>世情薄</p>
  <p>人情惡</p>
  <p>雨送黃昏花易落</p>
{% endblock %}

元件

可以將常用的頁面內容如導航條，頁尾資訊等元件儲存在單獨的檔案中，然後在需要使用的地方按如下語法匯入即可。

{% include 'navbar.html' %}

靜態檔案相關

{% static %}

{% load static %}
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />

引用JS檔案時使用：

{% load static %}
<script src="{% static "mytest.js" %}"></script>

某個檔案多處被用到可以存為一個變數

{% load static %}
{% static "images/hi.jpg" as myphoto %}
<img src="{{ myphoto }}"></img>

{% get_static_prefix %}

{% load static %}
<img src="{% get_static_prefix %}images/hi.jpg" alt="Hi!" />

或者

{% load static %}
{% get_static_prefix as STATIC_PREFIX %}

<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi!" />
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" alt="Hello!" />

自定義標籤simple_tag

和自定義filter類似，只不過接收更靈活的引數。

定義註冊simple tag

@register.simple_tag(name="plus")
def plus(a, b, c):
    return "{} + {} + {}".format(a, b, c)

使用自定義simple tag

{% load app01_demo %}

{# simple tag #}
{% plus "1" "2" "abc" %}

inclusion_tag

多用於返回html程式碼片段

示例：

templatetags/my_inclusion.py

from django import template

register = template.Library()


@register.inclusion_tag('result.html')
def show_results(n):
    n = 1 if n < 1 else int(n)
    data = ["第{}項".format(i) for i in range(1, n+1)]
    return {"data": data}

templates/snippets/result.html

<ul>
  {% for choice in data %}
    <li>{{ choice }}</li>
  {% endfor %}
</ul>

templates/index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>inclusion_tag test</title>
</head>
<body>

{% load inclusion_tag_test %}

{% show_results 10 %}
</body>
</html>