Django之模板系统

Posted 2021-03-04 rx-h

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Django之模板系统相关的知识，希望对你有一定的参考价值。

　　　　　　　　　Django之模板系统　　　　　　　　

官方文档

　　　　　　　　常用语法　　　　　　　　

变量相关的用{{content}}，逻辑相关的用{%%}。

　　　　　　变量　　　　　　

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

当模板引擎遇到一个变量，它将计算这个变量，然后用结果替换掉它本身。变量的命名包括任何字母数字以及下划线 ("_")的组合。变量名称中不能有空格或标点符号。

点（.）在模板语言中有特殊的含义。当模版系统遇到点(".")，它将以这样的顺序查询：

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

注意事项：

如果计算结果的值是可调用的，它将被无参数的调用。调用的结果将成为模板的值。
如果使用的变量不存在，模板系统将插入 string_if_invalid 选项的值，它被默认设置为‘‘ (空字符串) 。

view中的代码：

def test(request):
    l = [11, 22, 33]
    d = {"name": "Eric"}
#  在函数中定义类，并实例化进行调用
    class Person(object):
        def __init__(self, name, age):
            self.name = name
            self.age = age

        def dream(self):
            return "{} is dream...".format(self.name)

        def __str__(self):  # python3中调用
            return ‘person object:{}‘.format(self.name)

        def __unicode__(self):  # python2中调用
            return ‘person object:{}‘.format(self.name)

    smallcao = Person(name="小草草", age=11)
    Eric = Person(name="Eric", age=22)

    person_list = [smallcao, Eric]#此列表中存储的是两个实例化对象，在前端通过‘.‘进行调用其属性和方法
    return render(request,
                  "test.html",#所传入的前端页面，后面要替换的值均来自此页面代码
                  {#大括号中的键值，其中键是在前端页面代码中进行书写，后面的值是通过替换传至前端页面，
                      "l": l,
                      "d": d,
                      "person_list": person_list}
                  )

View Code

注意:此函数定义的类方法不能传参。

urls中的代码：

urls=[
    path(‘test/‘,views.test)# 通过前端网址路径相对路径‘test/‘执行后面的views中的test函数
]

模板中支持的写法：

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

View Code

　　　　　　filter器件　　　　　　

在Django的模板语言中，通过使用 filter 来改变变量的显示。可以理解为对传到前端的值进行了处理。
过滤器的语法：

{{ value|filter_name:参数 }}

使用管道符"|"来应用过滤器。

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

注意事项：

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

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

注意:此六十个内置filter均可在上面的官方文档中找到，以及找到对应的参考示例。

　　　　default　　　　

此处所给的默认值只有当一个变量是false或者为空时才会起作用。否则，使用变量的值。

{{ value|default:"nothing"}}

上面所写的显示于HTML代码页中的代码行表示当后端返回的值为空或者没有传值时则在HTML页面显示nothing。

　　　　 length　　　　

返回值的长度，作用于字符串和列表。

返回value的长度，如 value=[‘a‘, ‘b‘, ‘c‘, ‘d‘]的话，就显示4.即展示在HTML页面的内容是4而不是它对应的value。

　　　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 过滤器：

{{ data }}#这种会将其进行转义
{{ data|safe }}#通过使用filter中的safe方法可以取消这种转义，使其按其字面的意思进行执行。

对于模板块

　　　　要控制模板的自动转义，请将模板（或模板的特定部分）包装到autoescape标记中，如下所示：

{% autoescape off %}
    Hello {{ name }}
{% endautoescape %}

　　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是表示2020年3月16日午夜的日期实例，并且comment_date是2020年3月16日08:00的日期实例，则以下将返回“8小时”：

{{ blog_date|timesince:comment_date }}

分钟是所使用的最小单位，对于相对于比较点的未来的任何日期，将返回“0分钟”。{{未来的时间|timesince:前面的一个时间点}}

　　　　timeuntil　　

类似于timesince，除了它测量从现在开始直到给定日期或日期时间的时间。例如，如果今天是2020年3月16日，而conference_date是保留2020年3月29日的日期实例，则{{ conference_date | timeuntil }}将返回“4周”。

使用可选参数，它是一个包含用作比较点的日期（而不是现在）的变量。如果from_date包含2020年3月22日，则以下内容将返回“1周”：

{{ conference_date|timeuntil:from_date }}

分钟是使用的最小单位，对于过去相对于比较点的任何日期，都将返回“0分钟”。{{前面的时间|timeuntil:未来的时间}}

　　自定义filter　　

自定义过滤器只是带有一个或两个参数的Python函数:

变量（输入）的值 - -不一定是一个字符串
参数的值 - 这可以有一个默认值，或完全省略

例如，在过滤器{{var | foo:‘bar‘}}中，过滤器foo将传递变量var和参数“bar”。

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

编写自定义filter

使用自定义filter

具体实现方式如下

定义阶段：

在app下面新建一个python的包：templatetags
在上面的python包中新建一个python文件，名字随意
在上述python文件中：

from django import template
# 生成一个注册用的实例
register=template.Library()
# 定义并注册一个自定义的filter 函数
@register.filter(name=‘addsb‘)#所起的这个名字与最后的模板使用有关
def add_str(arg):
    return ‘{}str‘.format(arg)

test

调用阶段

在django的模板文件中，导入刚才新建的python文件：{%load py文件名%}
按照filter的语法调用：{{name|addsb}}

　　　　for循环　　　　

普通for循环

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

for循环可用的一些参数:

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

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 %}

View Code

也可以只有if和else

{% if user_list|length > 5 %}
  ……
{% else %}
   ……
{% endif %}

普通if else

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

　　　　　　　　　　母板　　　　　　　　　　　　

将多数页面共同存在的一些标签组成的基础页面放在一个HTML中，在需要改变的位置加上一个模板语言中的block块。如下代码：

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

base.html 示例

示例中的块就是需要子页面中进行定义设计的，然后通过导入母板实现整个页面的加载。

　　　　　　继承母板　　　　　　

在页面最上方使用下面的语法来继承母板（此页面为子页面）。

{% extends ‘layouts.html‘ %}

使用步骤：

把公用的HTML部分提取出来，放到base.html文件中.
在base.html中，通过定义block，把每个页面不同的部分区分出来.
在具体的页面中，先继承母版.
然后block名去指定替换母板中的相应位置.

使用母版和继承的注意事项：

{%extends ‘base.html‘%} -->母版文件：‘base.html‘要加引号
必须要放在子页面的第一行
可以在base.html中定义很多block，通常我们会额外定义一个-->page-css和page-js
view.py相应的函数中返回的是对应的子页面文件，不是母版文件。

　　　　　　块(block)　　　　　

通过在母板中使用{% block xxx %}来定义"块"。在子页面中通过定义母板中的block名来对应替换母板中相应的内容。

{% block page-main %}
  <p>送那人御街打马</p>
  <p>才子佳人断佳话</p>
  <p>怜余来苦咽下</p>
{% endblock %}

子页面的块

　　　　　　　组件　　　　　　

可以将常用的页面内容如导航条，页尾信息等组件保存在单独的文件中，然后在需要使用的地方按如下语法导入即可。重复的代码包装成一个独立的小HTML。

{% include ‘navbar.html‘ %}

　　　　静态文件相关　　　　

django的模板语言中关于静态文件路径的灵活写法

利用django模板语言内置的static方法帮我拼接静态文件路径
利用内置的get_static_prefix获取静态文件路径的别名，我们自行拼接路径。
as语法（一个路径多次用到，可以使用as保存为一个变量，后面就直接使用变量代替具体路径）
自定义的simple_tag：比filter高级一点，可接受的参数大于2
自定义的inclusion_tag：用来返回一段HTML代码，(示例：返回ul标签)

　　　　{% static %}　　　　

{% load static %}
<a href="{% static " book_list/books/book" %}" " />

引用JS文件时使用：

{% load static %}
<script src="{% static "bootstrap/bootstrap3.1.2.min.js" %}"></script>

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

{% load static %}
{% static "booklist/books/book" as mytest %}
<img src="{{ mytest }}"></img>
<!--此处再传值时须以变量的形式传入-->

{% get_static_prefix %}

{% load static %}
<a href="{% get_static_prefix %}booklist/books/book/">booklist</>

或者：

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

<a href="{{ STATIC_PREFIX }}booklist/books/book/22" />book</a>
<a href="{{ STATIC_PREFIX }}booklist/books/book/11" />books</a>

　　　　simple_tag　　　

和自定义filter类似，只不过接收更灵活的参数。

定义注册simple_tag。

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

使用自定义simple_tag

{% load app01_demo %}
{# simple tag #}
{% ss_s  "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}

具体实现方式：

1.定义阶段：

在app下面新建一个python的包：templatetags
在上面的python包中新建一个python文件，名字随意
在上述python文件中：

from django import template
# 生成一个注册用的实例
register=template.Library()
@register.inclusion_tag(‘.html‘)所起的这个名字与最后的模板使用有关
def show_ul(num):
    return ‘{}str‘.format(num)

2.调用阶段

{%load xx%}#xx为python包
{%show_ul 10%}

templates/snippets/result.html：子页面

<ul>
  {% for choice in data %}<!--此data是从后面聘用合同文件传回的，将其展示至页面-->
    <li>{{ choice }}</li>
  {% endfor %}
</ul>

templates/index.html ：base页面

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

母板页面

以上是关于Django之模板系统的主要内容，如果未能解决你的问题，请参考以下文章

如何在 Django 中显式重置模板片段缓存？

使用 Django 模板作为片段

Django之模板系统

django基础知识之定义模板:

JavaScript 片段在 Django 模板中不起作用

Django之博客系统：自定义模板标签

Django之模板系统

Django之模板系统

常用语法

变量

filter器件

default

length

filesizeformat

slice

date

safe

对于个体变量

对于模板块

truncatechars

truncatewords

cut

join

timesince

timeuntil

自定义filter

具体实现方式如下

tag

for循环

if判断

with

csrf_token

注释

母板

继承母板

块(block)

组件

静态文件相关

django的模板语言中关于静态文件路径的灵活写法

{% static %}

{% get_static_prefix %}

simple_tag

inclusion_tag

　　　　　　　　　Django之模板系统　　　　　　　　

　　　　　　　　常用语法　　　　　　　　

　　　　　　变量　　　　　　

　　　　　　filter器件　　　　　　

　　　　default　　　　

　　　　 length　　　　

　　　filesizeformat　　

　　　　　slice　　　

　　　　date　　　

　　　　　safe　　　　

　　truncatechars　　

　　truncatewords　　

　　　　 cut　　　　　

　　　　join　　　　

　　　　timesince　　

　　　　timeuntil　　

　　自定义filter　　

　　　　　　　　　　tag　　　　　　　　　　

　　　　for循环　　　　

　　　　if判断　　　　

　　　　　with　　　　

　　 csrf_token　　

　　　　　注释　　　

　　　　　　　　　　母板　　　　　　　　　　　　

　　　　　　继承母板　　　　　　

　　　　　　块(block)　　　　　

　　　　　　　组件　　　　　　

　　　　静态文件相关　　　　

　　　　{% static %}　　　　

　　　　simple_tag　　　

　　　inclusion_tag　　