Django模板语言

一  变量

1. 概述

只需要记两种特殊符号：{{  }}和 {% %}，变量相关的用{{}}，逻辑相关的用{%%}。

在Django的模板语言中按此语法使用：{{ 变量名 }}。

变量的命名包括任何字母数字以及下划线 ("_")的组合。 变量名称中不能有空格或标点符号。点（.）在模板语言中有特殊的含义。当模版系统遇到点(".")，它将以这样的顺序查询：

• 字典查询（Dictionary lookup）
• 属性或方法查询（Attribute or method lookup）
• 数字索引查询（Numeric index lookup）

{# 取li中的第一个参数 #}
{{ li.0 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取对象的name属性 #}
{{ person_list.0.name }}
{# .操作只能调用不带参数的方法 #}
{{ person_list.0.dream }}

2. 设置string_if_invalid

如果使用的变量不存在， 模版系统将插入 string_if_invalid 选项的值， 它被默认设置为'' (空字符串)

若修改默认值，在TEMPLATES的OPTIONS可以增加一个选项：'string_if_invalid':'找不到'，string_if_invalid的权限要比过滤器中的default高。

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
            'string_if_invalid': '找不到',
        },
    },
]

二  Filters 过滤器

官方文档

1. filters用法

在Django的模板语言中，通过使用 过滤器 来改变变量的显示。

过滤器的语法： {{ value|filter_name:参数 }}，使用管道符"|"来应用过滤器。

例如：{{ name|lower }}会将name变量应用lower过滤器之后再显示它的值。lower在这里的作用是将文本全都变成小写。

注意事项：

• 过滤器支持“链式”操作。即一个过滤器的输出作为另一个过滤器的输入。
• 过滤器可以接受参数，且最多只能接受一个参数，例如：{{ sss|truncatewords:30 }}，这将显示sss的前30个词。
• 过滤器参数包含空格的话，必须用引号包裹起来。比如使用逗号和空格去连接一个列表中的元素，如：{{ list|join:', ' }}
• '|'左右没有空格

2. 内置过滤器

Django的模板语言中提供了大约六十个内置过滤器。

default

{{ value|default:"nothing"}}

如果value值没传的话就显示nothing，若设置了string_if_invalid，default则不起作用，仍然显示string_if_invalid的值。

filesizeformat

将值格式化为一个 “人类可读的” 文件尺寸 （例如 '13 KB', '4.1 MB', '102 bytes', 等等）。例如：

{{ value|filesizeformat }}

如果 value 是 123456789，输出将会是 117.7 MB。

add 给变量加参数

{{ value|add:"2" }}

value是数字4，则输出结果为6。

{{ first|add:second }}

如果first是 [1,2,3]，second是[4,5,6]，则输出结果为[1,2,3,4,5,6]

lower 小写

{{ value|lower }}

upper 大写

{{ value|upper}}

title 标题

{{ value|title }}

ljust 左对齐

"{{ value|ljust:"10" }}"

rjust 右对齐

"{{ value|rjust:"10" }}"

center 居中

"{{ value|center:"15" }}"

length {{ value|length }}

返回value的长度，如 value=['a', 'b', 'c', 'd']的话，就显示4.

slice 切片

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

first 取第一个元素

{{ value|first }}

last 取最后一个元素

{{ value|last }}

join 使用字符串拼接列表。同python的str.join(list)。

{{ value|join:" // " }}

truncatechars 如果字符串字符多于指定的字符数量，那么会被截断。截断的字符串将以可翻译的省略号序列（“...”）结尾。

参数：截断的字符数

{{ value|truncatechars:9}}

date 日期格式化：官方文档

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

若多个时间戳需要设置格式，则修改setting：

USE_I18N = True  #原来为True

USE_L10N = False

USE_TZ = True

DATETIME_FORMAT = "Y-m-d H:i:s"
DATE_FORMAT ="Y-m-d"

格式：

a	'a.m.'或'p.m.'（请注意，这与PHP的输出略有不同，因为这包括符合Associated Press风格的期间）	'a.m.'
A	'AM'或'PM'。	'AM'
b	月，文字，3个字母，小写。	'jan'
B	未实现。
c	ISO 8601格式。
d	月的日子，带前导零的2位数字。	'01'到'31'
D	一周中的文字，3个字母。	“星期五”
e	时区名称 可能是任何格式，或者可能返回一个空字符串，具体取决于datetime。	''、'GMT'、'-500'、'US/Eastern'等
E	月份，特定地区的替代表示通常用于长日期表示。	'listopada'（对于波兰语区域，而不是'Listopad'）
f	时间，在12小时的小时和分钟内，如果它们为零，则分钟停留。 专有扩展。	'1'，'1:30'
F	月，文，长。	'一月'
g	小时，12小时格式，无前导零。	'1'到'12'
G	小时，24小时格式，无前导零。	'0'到'23'
h	小时，12小时格式。	'01'到'12'
H	小时，24小时格式。	'00'到'23'
i	分钟。	'00'到'59'
I	夏令时间，无论是否生效。	'1'或'0'
j	没有前导零的月份的日子。	'1'到'31'
l	星期几，文字长。	'星期五'
L	布尔值是否是一个闰年。	True或False
m	月，2位数字带前导零。	'01'到'12'
M	月，文字，3个字母。	“扬”
n	月无前导零。	'1'到'12'
N	美联社风格的月份缩写。 专有扩展。	'Jan.'，'Feb.'，'March'，'May'
o	ISO-8601周编号，对应于使用闰年的ISO-8601周数（W）。	'1999年'
O	与格林威治时间的差异在几小时内。	'+0200'
P	时间为12小时，分钟和'a.m。'/'p.m。'，如果为零，分钟停留。	'1 am'，'1:30 pm' / t3>，'midnight'，'noon'，'12：30 pm' / T10>
r	RFC 5322格式化日期。	'Thu, 21 Dec 2000 16:01:07 +0200'
s	秒，带前导零的2位数字。	'00'到'59'
S	一个月的英文序数后缀，2个字符。	'st'，'nd'，'rd'或'th'
t	给定月份的天数。	28 to 31
T	本机的时区。	'EST'，'MDT'
u	微秒。	000000 to 999999
U	自Unix Epoch以来的二分之一（1970年1月1日00:00:00 UTC）。
w	星期几，数字无前导零。	'0'（星期日）至'6'（星期六）
W	ISO-8601周数，周数从星期一开始。	1，53
y	年份，2位数字。	'99'
Y	年，4位数。	'1999年'
z	一年中的日子	0到365
Z	时区偏移量，单位为秒。 UTC以西时区的偏移量总是为负数，对于UTC以东时，它们总是为正。	-43200到43200

safe 通过过滤器“|safe”的方式告诉Django这段代码是安全的不必转义。

value = "点我"

{{ value|safe}}

3. 自定义filter

 自定义过滤器只是带有一个或两个参数的Python函数，装饰器进行装饰：

• 变量（value）
• 参数的值 ，可省略

自定义filter代码文件摆放位置：

app01/
    __init__.py
    models.py
    templatetags/  # 在app01下面新建一个package package
        __init__.py
        app01_filters.py  # 建一个存放自定义filter的py文件
    views.py

自定义filter

from django import template
register = template.Library()

@register.filter
def fill(value, arg):
    return value.replace(" ", arg)　#{{somevariable|fill:"_"}}中，value=somevaribale，fill为函数名，arg = "_"

@register.filter(name="addSB")　　　#装饰器中的name变更函数调用名称
def add_sb(value):
    return "{} SB".format(value)

使用自定义filter

{# 先导入我们自定义filter那个文件 #}
{% load app01_filters %}

{# 使用我们自定义的filter #}
{{ somevariable|fill:"__" }}
{{ d.name|addSB }}

三  tag 标签

用法：{%tag%}

1. for循环

{% for user in user_list %}
    
{{ user.name }}
{% endfor %}

for循环可用的一些参数：

Variable	Description
forloop.counter	当前循环的索引值（从1开始）
forloop.counter0	当前循环的索引值（从0开始）
forloop.revcounter	当前循环的倒序索引值（到1结束）
forloop.revcounter0	当前循环的倒序索引值（到0结束）
forloop.first	当前循环是不是第一次循环（布尔值）
forloop.last	当前循环是不是最后一次循环（布尔值）
forloop.parentloop	本层循环的外层循环

forloop.parentloop的用法：

    <tbody>
    {% for row in li %}
    <tr>
       {% for j in row %}
           {% if forloop.parentloop.counter|divisibleby:'2' and forloop.counter|divisibleby:'2' %}　　　　#判断是否能够整除，不支持%
           <td style="color: red">{{ j }}td>
           {% else %}
            <td>{{ j }}td>
           {% endif %}
       {% endfor %}
    tr>
    {% endfor %}
    tbody>

结果为：

1.1 for ... empty

{% for user in user_list %}
    
{{ user.name }}
　　　　#拿到的数据为空，执行empty语句，相当于加一个if语句
{% empty %}
    
空空如也
{% endfor %}

2. if语句

2.1 if，elif，else

{% if user_list %}
  用户人数：{{ user_list|length }}
{% elif black_list %}
  黑名单数：{{ black_list|length }}
{% else %}
  没有用户
{% endif %}

2.2 if，else

{% if user_list|length > 5 %}
  七座豪华SUV
{% else %}
    黄包车
{% endif %}

if语句支持 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判断。

3. with语句

定义一个中间变量名（当名字较为复杂时），变量仅在with语句内部起作用

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

4. csrf_token

csrf_token标签用于跨站请求伪造保护，在页面的form表单里面写上{% csrf_token %}

5. 注释

{# ... #}

6. 注意事项

6.1. Django的模板语言不支持连续判断，即不支持以下写法：

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

6.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的值。

四  母版继承

html文件都需要加引号

1. 母版

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>Titletitle>

  {% block page-css %}
  {% endblock %}

head>
<body>
<h1>这是母板的标题h1>

{% block page-main %}
{% endblock %}

<h1>母板底部内容h1>

{% block page-js %}
{% endblock %}

body>
html>

 

注意：我们通常会在母板中定义页面专用的CSS块和JS块，方便子页面替换。

2. 继承

在子页面中在页面最上方使用下面的语法来继承母板。

{% extends 'inherit.html' %}

3. block块

在子页面中通过定义母板中的block名来对应替换母板中相应的内容。

{% block page-main %}
  
　　aaaaaa　　
  
　　bbbbbb　　
  
　　cccccc　　
{% endblock %}

4. 组件

可以将常用的页面内容如导航条，页尾信息等组件保存在单独的文件中，然后在需要使用的地方按如下语法导入即可。

组件导入的是整个html文件，而blcok仅仅是一段语句。

{% include 'navbar.html' %}

5. 自定义 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" %}

6. 自定义 inclusion_tag

主要用于母版和组件之间传递参数

实例：

母版文件：base.html

{% load mytags %}
{% pagination 10 2  %}

函数文件：templatetags/mytags.py

from django import template
register = template.Library()

@register.inclusion_tag('001.html')
def pagination(num, cur_num):
    num = [i+1 for i in range(num)]
    return {'num': num, 'cur_num': cur_num}

组件文件：001.html

    
"Page navigation" >
        
class="pagination">
            

                "#" aria-label="Previous">
                    "true">«
                
            

            {% for i in num %}
                {% if i == cur_num %}
                
class="active">"#">{{ i }}

                {% else %}
                
"#">{{ i }}

                {% endif %}
            {% endfor %}
            

                "#" aria-label="Next">
                    "true">»
                
            
        
    

 

 流程为：母版文件将参数传递给函数文件，函数文件在将参数传递给组件，实现参数由母版到组件的传递。

五  静态文件相关

STATIC_URL = '/static_123/'  # HTML中使用的静态文件夹前缀，必须与html中static_123/bootstrap-3.3.7/css/bootstrap.css" type="text/css">一致。

STATICFILES_DIRS = [ 
os.path.join(BASE_DIR, "static_aaa"), # 静态文件存放位置，必须与static_aaa文件夹的名称一致
]

1. {% static %}

{% load static %}

引用JS文件时使用：

{% load static %}

某个文件多处被用到可以存为一个变量

{% load static %}
{% static "images/hi.jpg" as myphoto %}

2. {% get_static_prefix %}

仅仅是一个前缀，字符串类型：/static/

{% load static %}

或者

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