Django 模版过滤器

模版常用过滤器
在模版中，有时候需要对一些数据进行处理以后才能使用。一般在Python中我们是通过函数的形式来完成的。而在模版中，则是通过过滤器来实现的。过滤器使用的是|来使用。比如使用add过滤器，那么示例代码如下：

{{ value|add:"2" }}

那么以下就讲下在开发中常用的过滤器。

add
将传进来的参数添加到原来的值上面。这个过滤器会尝试将值和参数转换成整形然后进行相加。如果转换成整形过程中失败了，那么会将值和参数进行拼接。如果是字符串，那么会拼接成字符串，如果是列表，那么会拼接成一个列表。示例代码如下：

{{ value|add:“2” }}
如果value是等于4，那么结果将是6。如果value是等于一个普通的字符串，比如abc，那么结果将是abc2。add过滤器的源代码如下：

def add(value, arg):
“”“Add the arg to the value.”""
try:
return int(value) + int(arg)
except (ValueError, TypeError):
try:
return value + arg
except Exception:
return ‘’
cut
移除值中所有指定的字符串。类似于python中的replace(args,"")。示例代码如下：

{{ value|cut:" " }}
以上示例将会移除value中所有的空格字符。cut过滤器的源代码如下：

def cut(value, arg):
“”“Remove all values of arg from the given string.”""
safe = isinstance(value, SafeData)
value = value.replace(arg, ‘’)
if safe and arg != ‘;’:
return mark_safe(value)
return value
date
将一个日期按照指定的格式，格式化成字符串。示例代码如下：

数据

context = {
    "birthday": datetime.now()
}

模版

{{ birthday|date:"Y/m/d" }}
那么将会输出2018/02/01。其中Y代表的是四位数字的年份，m代表的是两位数字的月份，d代表的是两位数字的日。
还有更多时间格式化的方式。见下表。

格式字符 描述 示例
Y 四位数字的年份 2018
m 两位数字的月份 01-12
n 月份，1-9前面没有0前缀 1-12
d 两位数字的天 01-31
j 天，但是1-9前面没有0前缀 1-31
g 小时，12小时格式的，1-9前面没有0前缀 1-12
h 小时，12小时格式的，1-9前面有0前缀 01-12
G 小时，24小时格式的，1-9前面没有0前缀 1-23
H 小时，24小时格式的，1-9前面有0前缀 01-23
i 分钟，1-9前面有0前缀 00-59
s 秒，1-9前面有0前缀 00-59

default
如果值被评估为False。比如[]，""，None，{}等这些在if判断中为False的值，都会使用default过滤器提供的默认值。示例代码如下：

{{ value|default:"nothing" }}
如果value是等于一个空的字符串。比如""，那么以上代码将会输出nothing。

default_if_none
如果值是None，那么将会使用default_if_none提供的默认值。这个和default有区别，default是所有被评估为False的都会使用默认值。而default_if_none则只有这个值是等于None的时候才会使用默认值。示例代码如下：

{{ value|default_if_none:"nothing" }}
如果value是等于""也即空字符串，那么以上会输出空字符串。如果value是一个None值，以上代码才会输出nothing。

first
返回列表/元组/字符串中的第一个元素。示例代码如下：

{{ value|first }}
如果value是等于[‘a’,‘b’,‘c’]，那么输出将会是a。

`last``
返回列表/元组/字符串中的最后一个元素。示例代码如下：

`{{ value|last }}
如果value是等于[‘a’,‘b’,‘c’]，那么输出将会是c。

floatformat
使用四舍五入的方式格式化一个浮点类型。如果这个过滤器没有传递任何参数。那么只会在小数点后保留一个小数，如果小数后面全是0，那么只会保留整数。当然也可以传递一个参数，标识具体要保留几个小数。

如果没有传递参数：

| value | 模版代码 | 输出 | | — | — | — | | 34.23234 | {{ value|floatformat }} | 34.2 | | 34.000 | {{ value|floatformat }} | 34 | | 34.260 | {{ value|floatformat }} | 34.3 |

如果传递参数：

| value | 模版代码 | 输出 | | — | — | — | | 34.23234 | {{value|floatformat:3}} | 34.232 | | 34.0000 | {{value|floatformat:3}} | 34.000 | | 34.26000 | {{value|floatformat:3}} | 34.260 |

join
类似与Python中的join，将列表/元组/字符串用指定的字符进行拼接。示例代码如下：

{{ value|join:"/" }}
如果value是等于[‘a’,‘b’,‘c’]，那么以上代码将输出a/b/c。

length
获取一个列表/元组/字符串/字典的长度。示例代码如下：

{{ value|length }}
如果value是等于[‘a’,‘b’,‘c’]，那么以上代码将输出3。如果value为None，那么以上将返回0。

lower
将值中所有的字符全部转换成小写。示例代码如下：

{{ value|lower }}
如果value是等于Hello World。那么以上代码将输出hello world。

upper
类似于lower，只不过是将指定的字符串全部转换成大写。

random
在被给的列表/字符串/元组中随机的选择一个值。示例代码如下：

{{ value|random }}
如果value是等于[‘a’,‘b’,‘c’]，那么以上代码会在列表中随机选择一个。

safe
标记一个字符串是安全的。也即会关掉这个字符串的自动转义。示例代码如下：

{{value|safe}}
如果value是一个不包含任何特殊字符的字符串，比如这种，那么以上代码就会把字符串正常的输入。如果value是一串html代码，那么以上代码将会把这个html代码渲染到浏览器中。

slice
类似于Python中的切片操作。示例代码如下：

{{ some_list|slice:"2:" }}
以上代码将会给some_list从2开始做切片操作。

stringtags
删除字符串中所有的html标签。示例代码如下：

{{ value|striptags }}
如果value是hello world，那么以上代码将会输出hello world。

truncatechars
如果给定的字符串长度超过了过滤器指定的长度。那么就会进行切割，并且会拼接三个点来作为省略号。示例代码如下：

{{ value|truncatechars:5 }}
如果value是等于北京欢迎您~，那么输出的结果是北京…。可能你会想，为什么不会北京欢迎您…呢。因为三个点也占了三个字符，所以北京+三个点的字符长度就是5。

truncatechars_html
类似于truncatechars，只不过是不会切割html标签。示例代码如下：

{{ value|truncatechars:5 }}

如果value是等于北京欢迎您~，那么输出将是

北京…

自定义模版过滤器

虽然DTL给我们内置了许多好用的过滤器。但是有些时候还是不能满足我们的需求。因此Django给我们提供了一个接口，可以让我们自定义过滤器，实现自己的需求。

模版过滤器必须要放在app中，并且这个app必须要在INSTALLED_APPS中进行安装。然后再在这个app下面创建一个Python包叫做templatetags。再在这个包下面创建一个python文件。比如app的名字叫做book，那么项目结构如下：

- book
    - views.py
    - urls.py
    - models.py
    - templatetags
        - my_filter.py

在创建了存储过滤器的文件后，接下来就是在这个文件中写过滤器了。过滤器实际上就是python中的一个函数，只不过是把这个函数注册到模板库中，以后在模板中就可以使用这个函数了。但是这个函数的参数有限制，第一个参数必须是这个过滤器需要处理的值，第二个参数可有可无，如果有，那么就意味着在模板中可以传递参数。并且过滤器的函数最多只能有两个参数。在写完过滤器后，再使用django.template.Library对象注册进去。示例代码如下：

from django import template

创建模板库对象

register = template.Library()

过滤器函数

def mycut(value,mystr):
    return value.replace(mystr)

将函数注册到模板库中

register.filter("mycut",mycut)

以后想要在模板中使用这个过滤器，就要在模板中load一下这个过滤器所在的模块的名字（也就是这个python文件的名字）。示例代码如下：

{% load my_filter %}

自定义时间计算过滤器：
有时候经常会在朋友圈、微博中可以看到一条信息发表的时间，并不是具体的时间，而是距离现在多久。比如刚刚，1分钟前等。这个功能DTL是没有内置这样的过滤器的，因此我们可以自定义一个这样的过滤器。示例代码如下：

time_filter.py文件

from datetime import datetime
from django import template

register = template.Library()

def time_since(value):
    """
    time距离现在的时间间隔
    1. 如果时间间隔小于1分钟以内，那么就显示“刚刚”
    2. 如果是大于1分钟小于1小时，那么就显示“xx分钟前”
    3. 如果是大于1小时小于24小时，那么就显示“xx小时前”
    4. 如果是大于24小时小于30天以内，那么就显示“xx天前”
    5. 否则就是显示具体的时间 2017/10/20 16:15
    """
    if isinstance(value,datetime):
        now = datetime.now()
        timestamp = (now - value).total_seconds()
        if timestamp < 60:
            return "刚刚"
        elif timestamp >= 60 and timestamp < 60*60:
            minutes = int(timestamp / 60)
            return "%s分钟前" % minutes
        elif timestamp >= 60*60 and timestamp < 60*60*24:
            hours = int(timestamp / (60*60))
            return "%s小时前" % hours
        elif timestamp >= 60*60*24 and timestamp < 60*60*24*30:
            days = int(timestamp / (60*60*24))
            return "%s天前" % days
        else:
            return value.strftime("%Y/%m/%d %H:%M")
    else:
        return value

register.filter("time_since",time_since)

在模版中使用的示例代码如下：

{% load time_filter %}
...
{% value|time_since %}
...

为了更加方便的将函数注册到模版库中当作过滤器。也可以使用装饰器来将一个函数包装成过滤器。示例代码如下：

from django import template
register = template.Library()

@register.filter(name='mycut')
def mycut(value,mystr):
    return value.replace(mystr,"")