Django自定义标签和过滤器进阶笔记

Django自定义标签与过滤器

最新推荐文章于 2025-09-11 21:03:21 发布

转载最新推荐文章于 2025-09-11 21:03:21 发布 · 100 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://my.oschina.net/liuyuantao/blog/1113950

文章标签：

#python

本文介绍了如何在Django中实现自定义标签和过滤器，包括创建目录结构、编辑标签函数、加载标签等内容，并提供了简单标签、分配标签及内含标签的使用示例。

2019独角兽企业重金招聘Python工程师标准>>>

自定义标签

想要实现自定义标签需要进行准备工作：

准备(必需)工作：

1.目录结构

在某个app下创建一个名为templatetags(必需，且包名不可变)的包。假设我们在名为polls的app下创建了一个templatetags的包，并在该包下创建了一个名为mytags的文件。那么目录结构看起来应该就像这样：

polls/
    __init__.py
    models.py
    templatetags/
        __init__.py
        mytags.py
    views.py

2.编辑自定义标签函数

接下来在mytags文件中写入如下几行（我们获取当前时间的标签）

#coding:utf-8
from django import template

register = template.Library()

class TimerNode(template.Node):
    def __init__(self,format_string):
        self.format_string= format_string

    def render(self, context):
        return datatime.now().strftime(self.format_string)

@register.tag(name="current_time")
def timer(parser,token):
    try:
        tagname,format_string=token.split_contents()
    except ValueError:
        raise TemplateSyntaxError("error tag")
    return TimerNode(format_string[1:-1])

3.加载自定义标签

在模板中使用{% load %} 标签装载自定义标签或者装饰器

{% load mytags %}
{% current_time '%Y-%m-%d %I:%M %P' %}

其实到这里，标签基本可以用，但是我们还想把标签的内容加载到渲染的上下文中，就需要修改我们的标签函数：

#coding:utf-8
from django import template

register = template.Library()

class TimerNode(template.Node):
    def __init__(self,format_string,asvar):
        self.format_string= format_string
        self.asvar=asvar

    def render(self, context):
        now = datatime.now().strftime(self.format_string)
        if self.asvar:
            context[self.asvar] = now
            return ''
        else:
            return now 

@register.tag(name="current_time")
def timer(parser,token):
    args =token.split_contents()
    asvar = None
    if len(args) == 4 and args[-2] == 'as':
        asvar = args[-1]
    else len(args) != 2:
        raise TemplateSyntaxError("error args")
    return TimerNode(args[1][1:-1],asvar)

html里面就可以使用上下文标量了

{% load mytags %}
{% current_time '%Y-%m-%d %I:%M %P' as ct %}
<h1>{{ct}}</h1>

至此，标签的使用介绍就结束了。但是我们在使用标签的时候通常会有许多通用的部分，比如赋值上下文、包含其它模版等，所以Django为我们提供了三种标签：

简单标签 Simple tags：输出渲染结果

内含标签 Inclusion tags：可以被其他模板进行渲染，然后将渲染结果输出

分配标签 Assignment tags：类似于简单标签，但并不会输出结果，可以使用 as 关键字将结果赋给一个参数

4.简单标签Simple tags

import datetime
from django import template

register = template.Library()

@register.simple_tag
def current_time(format_string):
    return datetime.datetime.now().strftime(format_string)

Library.simple_tag(takes_context=True) takes_context=True参数可以让我们访问模板的当前环境上下文，即将当前环境上下文中的参数和值作为字典传入函数中的一个名为context的参数

@register.simple_tag(takes_context=True)
def current_time(context, format_string):
    timezone = context['timezone']
    return your_get_current_time_method(timezone, format_string)

当使用take_context=True时，函数的第一个参数必需为context。也可以使用name参数对函数进行重命名。

5.分配标签Assignment tags

我们使用Django我们提供的分配标签来简化前面获取当前时间赋值到上下文的方法

#coding:utf-8
from django import template

register = template.Library()

@register.assignment_tag()
def timer(format_string):
    return datatime.now().strftime(format_string)

只需要简单的几行就实现了上下文赋值的标签，使用的方法不变

{% load mytags %}
{% timer'%Y-%m-%d %I:%M %P' as ct %}
<h1>{{ct}}</h1>

6.内含标签Inclusion tags

这种类型的标签可以被其他模板进行渲染，然后将渲染结果输出

Library.inclusion_tag()支持take_context=True，用法类似Library.simple_tag()

from django import template
register = template.Library()

@register.inclusion_tag('result.html')
def test():
    a=['first','second','third']
    return {'choices':a}

result.html 内容

<ul>
{% for choice in choices %}
    <li> {{ choice }} </li>
{% endfor %}
</ul>

test.html内容

{% load mytags %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{% test %}
</body>
</html>

自定义过滤器

第一步：自定义过滤器实际上就是写一个函数；

第二步：Django会将过滤器前的值传入该函数；

第三步：函数完成后，需要进行登记register。

因为第二步Django已经帮我们完成，所以我们实际上只需要自己完成第一步和第三步

实例：写一个自动省略多余字符串的过滤器

1.定义一个truncate_chars 函数

#  若字符串长度大于30，则省略之后的内容，否则原样输出该字符串。参数value就是过滤器前的值
def truncate_chars(value):
    if value.__len__() > 30:
        return '%s......'% value[0:30]
    else:
        return value

2.register该函数

#  登记
register.filter('truncate_chars',truncate_chars)
def truncate_chars(value):
    if value.__len__() > 30:
        return '%s......'% value[0:30]
    else:
        return value

Library.filter(name,function,is_safe=False,needs_autoescape=False,excepts_localtime=False)函数默认需要两个参数，name是装饰器的名称(字符串类型)，function是函数名。后面三个参数可以参考官方文档。我们也可以通过装饰器进行登记：

@register.filter(name='truncate_filter')
def truncate_chars(value):
    if value.__len__() > 30:
        return '%s......'% value[0:30]
    else:
        return value

如果没有使用name参数，django默认会将函数名作为name参数的值，所以下面的代码和上面的代码作用相同。

@register.filter
def truncate_chars(value):
    if value.__len__() > 30:
        return '%s......'% value[0:30]
    else:
        return value

3.测试模板文件内容

{% load mytags %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{{ 'alskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdffalskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdff'|truncate_chars }}
</body>
</html>