Django模板语言-Filters（过滤器）

Filters（过滤器）

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

过滤器的语法： {{ value|filter_name:参数 }}

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

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

注意事项：

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

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

---

1. default

   # 如果一个变量是false或者为空，使用给定的默认值。 否则，使用变量的值。
   
   {{ value|default:"nothing"}}
   
   # 如果value没有传值或者值为空的话就显示nothing
   # 注：TEMPLATES的OPTIONS可以增加一个选项：string_if_invalid：'找不到'，在没有传值的情况下会显示string_if_invalid设置的值，如果传值了但是值为空，那么还是显示default的值
   # ================= TEMPLATES设置 ====================
   

   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':'找不到',
           },
       },
   ]

2. length

   # 返回值的长度，作用于字符串和列表。
   
   {{ value|length }}
   
   # 返回value的长度，如 value=['a', 'b', 'c', 'd']的话，就显示4.

3. filesizeformat

   # 将值格式化为一个 “人类可读的” 文件尺寸 （例如 '13 KB', '4.1 MB', '102 bytes', 等等）。例如：
   
   {{ value|filesizeformat }}
   
   # 如果 value 是 123456789，输出将会是 117.7 MB。

4. slice

   # 切片,跟列表操作类似。前包后不包
   
   {{value|slice:"2:-1"}}

5. date

   # datetime类型，时间格式化
   
   {{ value|date:"Y-m-d H:i:s"}}

   可用的参数：

   格式化字符	描述	示例输出
   a	'a.m.'或'p.m.'（请注意，这与PHP的输出略有不同，因为这包括符合Associated Press风格的期间）	'a.m.'
   A	'AM'或'PM'。	'AM'
   b	月，文字，3个字母，小写。	'jan'
   B	未实现。
   c	ISO 8601格式。 （注意：与其他格式化程序不同，例如“Z”，“O”或“r”，如果值为naive datetime，则“c”格式化程序不会添加时区偏移量（请参阅datetime.tzinfo） 。	2008-01-02T10:30:00.000123+02:00或2008-01-02T10:30:00.000123如果datetime是天真的
   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）。 对于更常见的年份格式，请参见Y。	'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

6. safe

   #Django的模板中会对HTML标签和JS等语法标签进行自动转义，原因显而易见，这样是为了安全。但是有的时候我们可能不希望这些HTML元素被转义，比如我们做一个内容管理系统，后台添加的文章中是经过修饰的，这些修饰可能是通过一个类似于FCKeditor编辑加注了HTML修饰符的文本，如果自动转义的话显示的就是保护HTML标签的源文件。为了在Django中关闭HTML的自动转义有两种方式，如果是一个单独的变量我们可以通过过滤器“|safe”的方式告诉Django这段代码是安全的不必转义。
   
   #比如：
   
   value = "<a href='#'>点我</a>"
   
   {{ value|safe}}

7. truncatechars

   # 如果字符串字符多于指定的字符数量，那么会被截断。截断的字符串将以可翻译的省略号序列（“...”）结尾。
   
   # 参数：截断的字符数
   
   {{ value|truncatechars:9}}
   
   # 注意：...占三个字符，如果传入9，那么最后显示6个字符+...

8. truncatewords

   # 在一定数量的字后截断字符串。
   
   {{ value|truncatewords:9}}
   
   # 注意：这个函数，是专门为英语文章准备的。根据空格分割字符串，来判断字符数量。

9. cut

   # 移除value中所有的与给出的变量相同的字符串
   
   {{ value|cut:' ' }}
   
   # 如果value为'i love you'，那么将输出'iloveyou'.

10. join

    # 跟Python的''.join(list)类似
    
    lst = ['a','b','c','d']
    
    {{ lst|join:' - ' }}
    
    a - b - c - d

11. timesince

    # 将日期格式设为自该日期起的时间（例如，“4天，6小时”）。
    
    # 采用一个可选参数，它是一个包含用作比较点的日期的变量（不带参数，比较点为现在）。 例如，如果blog_date是表示2006年6月1日午夜的日期实例，并且comment_date是2006年6月1日08:00的日期实例，则以下将返回“8小时”：
    
    {{ blog_date|timesince:comment_date }}
    
    # 分钟是所使用的最小单位，对于相对于比较点的未来的任何日期，将返回“0分钟”。
    
    
    # 用于判断，传入的时间，是在当前时间的几分钟前

12. 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 }}
    
    
    # 用于判断传入时间，是当前时间的几分钟后

13. 自定义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()
    
    # name用于给函数起别名，在模板中调用时可以用这个别名。如果不写name那么默认使用函数名
    @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 }}