Django——模板層(template)(模板語法、自定義模板過濾器及標簽、模板繼承)


前言:當我們想在頁面上給客戶端返回一個當前時間,一些初學者可能會很自然的想到用占位符,字符串拼接來達到我們想要的效果,但是這樣做會有一個問題,HTML被直接硬編碼在 Python代碼之中。

1
2
3
4
def current_datetime(request):
     now = datetime.datetime.now()
     html = "<html><body>It is now %s.</body></html>" % now
     return HttpResponse(html)

盡管這種技術便於解釋視圖是如何工作的,但直接將HTML硬編碼到你的視圖里卻並不是一個好主意。 讓我們來看一下為什么:

  • 對頁面設計進行的任何改變都必須對 Python 代碼進行相應的修改。 站點設計的修改往往比底層 Python 代碼的修改要頻繁得多,因此如果可以在不進行 Python 代碼修改的情況下變更設計,那將會方便得多。

  • Python 代碼編寫和 HTML 設計是兩項不同的工作,大多數專業的網站開發環境都將他們分配給不同的人員(甚至不同部門)來完成。 設計者和HTML/CSS的編碼人員不應該被要求去編輯Python的代碼來完成他們的工作。

  • 程序員編寫 Python代碼和設計人員制作模板兩項工作同時進行的效率是最高的,遠勝於讓一個人等待另一個人完成對某個既包含 Python又包含 HTML 的文件的編輯工作。

基於這些原因,將頁面的設計和Python的代碼分離開會更干凈簡潔更容易維護。 我們可以使用 Django的 模板系統 (Template System)來實現這種模式,這就是本章要具體討論的問題。

python的模板:HTML代碼+模板語法

模版包括在使用時會被值替換掉的 變量,和控制模版邏輯的 標簽

def current_time(req):
    # ================================原始的視圖函數
    # import datetime
    # now=datetime.datetime.now()
    # html="<html><body>現在時刻:<h1>%s.</h1></body></html>" %now


    # ================================django模板修改的視圖函數
    # from django.template import Template,Context
    # now=datetime.datetime.now()
    # t=Template('<html><body>現在時刻是:<h1>{{current_date}}</h1></body></html>')
    # #t=get_template('current_datetime.html')
    # c=Context({'current_date':str(now)})
    # html=t.render(c)
    #
    # return HttpResponse(html)


    #另一種寫法(推薦)
    import datetime
    now=datetime.datetime.now()
    return render(req, 'current_datetime.html', {'current_date':str(now)[:19]})

 

模板語法之變量

在 Django 模板中遍歷復雜數據結構的關鍵是句點字符  .

語法:  

語法:  

1
{{var_name}}

views:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
def index(request):
     import datetime
     s = "hello"
     l = [ 111 , 222 , 333 ]    # 列表
     dic = { "name" : "yuan" , "age" : 18 # 字典
     date = datetime.date( 1993 , 5 , 2 )   # 日期對象
 
     class Person( object ):
         def __init__( self ,name):
             self .name = name
 
     person_yuan = Person( "yuan" # 自定義類對象
     person_egon = Person( "egon" )
     person_alex = Person( "alex" )
 
     person_list = [person_yuan,person_egon,person_alex]
 
 
     return render(request, "index.html" ,{ "l" :l, "dic" :dic, "date" :date, "person_list" :person_list})
    # return render(request,"index.html",locals())  
     #這種方法只能用在鍵和值的變量名相同的情況下,且會導入所以變量,即使不需要用到的也好被導入

template: 

1
2
3
4
5
6
<h4>{{s}}< / h4>
<h4>列表:{{ l. 0 }}< / h4>
<h4>列表:{{ l. 2 }}< / h4>
<h4>字典:{{ dic.name }}< / h4>
<h4>日期:{{ date.year }}< / h4>
<h4>類對象列表:{{ person_list. 0.name }}< / h4>

注意:句點符也可以用來引用對象的方法(無參數方法)。

1
<h4>字典:{{ dic.name.upper }}< / h4>

模板之過濾器

語法:

1
{{obj|filter__name:param}}

default

如果一個變量是false或者為空,使用給定的默認值。否則,使用變量的值。例如:

1
{{ value|default: "nothing" }}

length

返回值的長度。它對字符串和列表都起作用。例如:

1
{{ value|length }}

如果 value 是 ['a', 'b', 'c', 'd'],那么輸出是 4。

filesizeformat

將值格式化為一個 “人類可讀的” 文件尺寸 (例如‘13 KB’,‘4.1 MB’,‘102 bytes’, 等等)。例如:

1
{{ value|filesizeformat }}

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

date

如果 value=datetime.datetime.now(),將返回當前時間的年-月-日格式

1
{{ value|date: "Y-m-d" }}  

 

slice

如果 value="hello world",則結果為ello worl  (也是顧頭不顧尾)

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

truncatechars

如果字符串字符多於指定的字符數量,那么會被截斷。截斷的字符串將以可翻譯的省略號序列(“...”)結尾。(truncatewords則是按單詞數目截斷(單詞與單詞間按空格算),用法相同)

參數:要截斷的字符數

例如:

1
{{ value|truncatechars: 3 }}

如果value“Joela,輸出將為“Joe...”

safe

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

1
value = "<a href=" ">點擊</a>"
1
{{ value|safe}}

這里簡單介紹一些常用的模板的過濾器,更多詳見

模板之標簽 

標簽看起來像是這樣的: {% tag %}。標簽比變量更加復雜:一些在輸出中創建文本,一些通過循環或邏輯來控制流程,一些加載其后的變量將使用到的額外信息到模版中。

一些標簽需要開始和結束標簽 (例如 {% tag %} ...標簽 內容 ... {% endtag %})。

for標簽

遍歷每一個元素:

{% for person in person_list %}
    <p>{{ person.name }}</p>
{% endfor %}

可以利用{% for obj in list reversed %}反向完成循環。

遍歷一個字典:

{% for key,val in dic.items %}
    <p>{{ key }}:{{ val }}</p>
{% endfor %}

注:循環序號可以通過{{forloop}}顯示

forloop.counter         #默認第一個循環的序號為1,升序
forloop.counter0       # 默認第一個循環的序號為0,升序
forloop.revcounter    #循環序號為降序,最后一個為1 
forloop.revcounter0   #循環序號為降序,最后一個為0
forloop.first              #第一個為True,其余為False
forloop.last               #最后一個為True,其余為False
View Code

for ... empty

for 標簽帶有一個可選的{% empty %} 從句,以便在給出的組是空的或者沒有被找到時,可以有所操作。

{% for person in person_list %}
    <p>{{ person.name }}</p>

{% empty %}
    <p>sorry,no person here</p>
{% endfor %}

if 標簽

{% if %}會對一個變量求值,如果它的值是“True”(存在、不為空、且不是boolean類型的false值),對應的內容塊會輸出。

{% if num > 100 or num < 0 %}
    <p>無效</p>
{% elif num > 80 and num < 100 %}
    <p>優秀</p>
{% else %}
    <p>湊活吧</p>
{% endif %}

 

==, !=, >=, <=, >, < 這些比較都可以在模板中使用 

注意:比較符號前后必須有至少一個空格!

and, or, not, in, not in 也可以在模板中使用

 

with

使用一個簡單地名字緩存一個復雜的變量,當你需要使用一個“昂貴的”方法(比如訪問數據庫)很多次的時候是非常有用的

例如:

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

 

csrf_token

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

<form action="/login/" method="post">
    {% csrf_token %}  #加上這個才能正常POST請求 <p><input type="text" name="user"></p>
    <input type="submit">
</form>

 

 一些有趣的用法:

.獲取當前用戶:

{{ request.user }}

如果登陸就顯示內容,不登陸就不顯示內容:

{% if request.user.is_authenticated %}
    {{ request.user.username }},您好!
{% else %}
    請登陸,這里放登陸鏈接
{% endif %}

 

 

自定義標簽和過濾器

1、在settings中的INSTALLED_APPS配置當前app(即加上當前app的名字,如‘app01’),不然django無法找到自定義的simple_tag.

2、在app中創建templatetags模塊(模塊名只能是templatetags)

3、創建任意 .py 文件,如:my_tags.py

from django import template
from django.utils.safestring import mark_safe
 
register = template.Library()   #register的名字是固定的,不可改變

####################以上行是固定不變要寫的#############################

######################定義過濾器#################### @register.filter
def filter_multi(v1,v2): return v1 * v2

######################定義標簽#####################
<br> @register.simple_tag def simple_tag_multi(v1,v2): return v1 * v2 <br> @register.simple_tag def my_input(id,arg): result = "<input type='text' id='%s' class='%s' />" %(id,arg,) return mark_safe(result)

 

4、在使用自定義simple_tag和filter的html文件中導入之前創建的 my_tags.py

1
{ % load my_tags % } 

5、使用simple_tag和filter(如何調用)

 

-------------模板頁面.html--------------------

過濾器: {{var|filter_name:參數}} # 參數只能是一個

標簽: {% simple_tag 參數1 參數2 ... %} #參數不限


{
% load my_tags %} # num=12 {{ num|filter_multi:2 }} #24 #參數只能有一個 {{ num|filter_multi:"[22,333,4444]" }} {% simple_tag_multi 2 5 %} #參數不限,但不能放在if for語句中 {% simple_tag_multi num 5 %}

注意:filter可以用在if等語句后,simple_tag不可以

1
2
3
{ % if num|filter_multi: 30 > 100 % }
     {{ num|filter_multi: 30 }}
{ % endif % }

 

 

對比過濾器與自定義標簽的使用:
  過濾器函數的參數只能有兩個,自定義標簽無參數限制
  過濾器可以與邏輯標簽共同使用,比如if標簽。自定義標簽不可以。

 

 

模板繼承 (extend)

Django模版引擎中最強大也是最復雜的部分就是模版繼承了。模版繼承可以讓您創建一個基本的“骨架”模版,它包含您站點中的全部元素,並且可以定義能夠被子模版覆蓋的 blocks 。

通過從下面這個例子開始,可以容易的理解模版繼承,首先我們寫一個模板:

<!DOCTYPE html>
<html lang="en">
<head>
    <link rel="stylesheet" href="style.css" />
    <title>{% block title %}My amazing site{% endblock %}</title>
</head>

<body>
    <div id="sidebar">
        {% block sidebar %}
        <ul>
            <li><a href="/">Home</a></li>
            <li><a href="/blog/">Blog</a></li>
        </ul>
        {% endblock %}
    </div>

    <div id="content">
        {% block content %}{% endblock %}
    </div>
</body>
</html>

這個模版,我們把它叫作 base.html它定義了一個可以用於兩列排版頁面的簡單HTML骨架。“子模版”的工作是用它們的內容填充空的blocks。

在這個例子中, block 標簽定義了三個可以被子模版內容填充的block。 block 告訴模版引擎: 子模版可能會覆蓋掉模版中的這些位置。

接下來,我們再寫一個子模板:

{% extends "base.html" %}
 
{% block title %}My amazing blog{% endblock %}
 
{% block content %}
{% for entry in blog_entries %}
    <h2>{{ entry.title }}</h2>
    <p>{{ entry.body }}</p>
{% endfor %}
{% endblock %}

extends 標簽是這里的關鍵。它告訴模版引擎,這個模版“繼承”了另一個模版。當模版系統處理這個模版時,首先,它將定位父模版——在此例中,就是“base.html”。

那時,模版引擎將注意到 base.html 中的三個 block 標簽,並用子模版中的內容來替換這些block。根據 blog_entries 的值,子模板輸出的內容會是下面的內容:

<!DOCTYPE html>
<html lang="en">
<head>
    <link rel="stylesheet" href="style.css" />
    <title>My amazing blog</title>
</head>
 
<body>
    <div id="sidebar">
        <ul>
            <li><a href="/">Home</a></li>
            <li><a href="/blog/">Blog</a></li>
        </ul>
    </div>
 
    <div id="content">
        <h2>Entry one</h2>
        <p>This is my first entry.</p>
 
        <h2>Entry two</h2>
        <p>This is my second entry.</p>
    </div>
</body>
</html>

請注意,子模版並沒有定義 sidebar block,所以系統使用了父模版中的值。父模版的 {% block %} 標簽中的內容總是被用作備選內容(fallback)

這種方式使代碼得到最大程度的復用,並且使得添加內容到共享的內容區域更加簡單,例如,部分范圍內的導航。

這里是使用繼承的一些提示:

  • 如果你在模版中使用 {% extends %} 標簽,它必須是模版中的第一個標簽。其他的任何情況下,模版繼承都將無法工作。

  • 在base模版中設置越多的 {% block %} 標簽越好。請記住,子模版不必定義全部父模版中的blocks,所以,你可以在大多數blocks中填充合理的默認內容,然后,只定義你需要的那一個。多一點鈎子總比少一點好。

  • 如果你發現你自己在大量的模版中復制內容,那可能意味着你應該把內容移動到父模版中的一個 {% block %} 中。

  • 有時候,想在父模板的基礎上再添加點其他的,而不是完全覆蓋父模板的內容,那么你只需要在想要填充的塊里,再加上一句 {{ block.super }},我們就可以把父模板里的東西給留下來,如:

    父模板中的
    {% block title %}My amazing site{% endblock %},
    如果我們只想子模板的結果是在后面加一個!,
    則只需要在子模板中寫成
    {% block title %}
        {{ block.super }}!
    {% endblock %}
    即可。

     

  • 為了更好的可讀性,你也可以給你的 {% endblock %} 標簽一個 名字 。例如:

    1
    2
    3
    { %  block content  % }
    ...
    { %  endblock content  % }  

    在大型模版中,這個方法幫你清楚的看到哪一個  {% block %} 標簽被關閉了。

最后,請注意您並不能在一個模版中定義多個相同名字的 block 標簽。這個限制的存在是因為block標簽的作用是“雙向”的。這個意思是,block標簽不僅提供了一個坑去填,它還在 _父模版_中定義了填坑的內容。如果在一個模版中有兩個名字一樣的 block 標簽,模版的父模版將不知道使用哪個block的內容。

 

 

注意模板一般放在app下的templates中,Django會自動去這個文件夾中找。但 假如我們每個app的templates中都有一個 index.html,當我們在views.py中使用的時候,直接寫一個 render(request, 'index.html'),Django 能不能找到當前 app 的 templates 文件夾中的 index.html 文件夾呢?(答案是不一定能,有可能找錯)

 

Django 模板查找機制: Django 查找模板的過程是在每個 app 的 templates 文件夾中找(而不只是當前 app 中的代碼只在當前的 app 的 templates 文件夾中找)。各個 app 的 templates 形成一個文件夾列表,Django 遍歷這個列表,一個個文件夾進行查找,當在某一個文件夾找到的時候就停止,所有的都遍歷完了還找不到指定的模板的時候就是 Template Not Found (過程類似於Python找包)。這樣設計有利當然也有弊,有利是的地方是一個app可以用另一個app的模板文件,弊是有可能會找錯了。所以我們使用的時候在 templates 中建立一個 app 同名的文件夾,這樣就好了。

 

這就需要把每個app中的 templates 文件夾中再建一個 app 的名稱,僅和該app相關的模板放在 app/templates/app/ 目錄下面,

 

例如:項目 zqxt 有兩個 app,分別為 tutorial 和 tryit

 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
zqxt
├── tutorial
│   ├── __init__.py
│   ├── admin.py
│   ├── models.py
│   ├── templates
│   │   └── tutorial
│   │       ├── index.html
│   │       └── search.html
│   ├── tests.py
│   └── views.py
├── tryit
│   ├── __init__.py
│   ├── admin.py
│   ├── models.py
│   ├── templates
│   │   └── tryit
│   │       ├── index.html
│   │       └── poll.html
│   ├── tests.py
│   └── views.py
├── manage.py
└── zqxt
     ├── __init__.py
     ├── settings.py
     ├── urls.py
     └── wsgi.py

 

這樣,使用的時候,模板就是 "tutorial/index.html" 和 "tryit/index.html" 這樣有app作為名稱的一部分,就不會混淆。

 

模板語法之include

點擊查看

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM