Python Django模板之模板过滤器与自定义模板过滤器示例

什么是模板过滤器？

模板过滤器是Django模板语言中的一种特殊的模板标签，用于对模板变量进行处理和转换。使用模板过滤器可以在模板渲染时对变量进行格式化、编码、截断等操作，从而更好的展示页面内容。

模板过滤器通常在模板变量后使用，使用竖线“|”隔开，例如：{{variable|filter}}。

Django默认提供了一些常用的模板过滤器，如date、cut、truncatechars等。同时也支持自定义模板过滤器来满足不同的需求。

常用的模板过滤器

下面是一些常用的Django模板过滤器示例：

• default：若值为False、空字符串或None，则使用给出的默认值。
• upper：将字符转换为大写。
• lower：将字符转换为小写。
• date：将日期格式化为字符串。
• time：将时间格式化为字符串。
• length：获取字符串的长度。
• join：将列表合并成字符串。

详细的模板过滤器列表可以参考Django官方文档。

自定义模板过滤器示例

在Django中，可以自定义模板过滤器来处理一些特殊的需求。下面我们以计算两个数字之和为例。

首先需要在Django项目的一个模块下创建一个名为templatetags的子目录，然后在该子目录下创建一个Python文件，例如my_filters.py。

from django import template

register = template.Library()

@register.filter(name='addition')
def addition(value, arg):
    try:
        arg = int(arg)
    except ValueError:
        return ''
    return int(value) + arg

解释下上述代码：
- 首先导入了template和register两个模块。
- 然后创建了一个名为addition的过滤器，并将其注册到Django模板系统中。
- 过滤器的实现方式是将传入的两个参数均转换为整型，然后将它们相加，并返回结果。

接下来在模板中使用自定义的过滤器：

{% load my_filters %}

{{ num1 }} + {{ num2 }} = {{ num1|addition:num2 }}

这里使用了{% load my_filters %}模板标签，以加载自定义的模板过滤器。然后在{{num1|addition:num2}}中使用了addition自定义过滤器来计算num1和num2的值。

更多示例

接下来再看一个示例，将一段HTML代码以缩进的方式输出：

from django import template

register = template.Library()

@register.filter(name='indent_html')
def indent_html(value):
    result = ""
    for line in value.split("\n"):
        result += "    " + line + "\n"
    return result

上面的代码定义了一个名为indent_html的过滤器，使用split函数拆分HTML代码的每一行，然后在开头添加四个空格，并返回拼接起来的字符串。

在模板中的使用如下：

{% load my_filters %}

<pre>
{% filter indent_html %}
    <div>
        <span>Hello World!</span>
    </div>
{% endfilter %}
</pre>

上述代码中使用了{% filter %}标签来实现自定义过滤器的调用，将HTML代码传入过滤器中，就会输出已经缩进的代码。

参考文章：
- Django Template Filters and Custom Filters
- Django 官方文档 - Template system