Django内置过滤器列表与自定义simple_tag及filter实现指南

闻溪
闻溪
发布时间:2026-10-13| 5人浏览过
原创

本文全面汇总Django内置模板过滤器,涵盖字符串处理、日期格式化及数据转换等常用功能。重点详解如何创建自定义模板标签,区分simple_tag与filter的使用场景,特别是解决simple_tag无法在if语句中使用的限制。通过完整代码示例,展示从创建templatetags目录到在HTML模板中调用自定义逻辑的全过程,帮助开发者灵活扩展Django模板功能。

Django 内置过滤器汇总

Django 提供了丰富的内置模板过滤器,用于在模板中对变量进行格式化处理。

常用内置过滤器示例

过滤器 描述 示例
upper 以大写方式输出 {{ user.name | upper }}
add 给value加上一个数值 {{ user.age | add:”5” }}
addslashes 单引号加上转义号  
capfirst 第一个字母大写 {{ ‘good'| capfirst }} 返回”Good”
center 输出指定长度的字符串,把变量居中 {{ “abcd”| center:”50” }}
cut 删除指定字符串 {{ “You are not a Englishman” | cut:”not” }}
date 格式化日期  
default 如果值不存在,则使用默认值代替 {{ value | default:”(N/A)” }}
default_if_none 如果值为None, 则使用默认值代替  
dictsort 按某字段排序,变量必须是一个dictionary {% for moment in moments | dictsort:”id” %}
dictsortreversed 按某字段倒序排序,变量必须是dictionary  
divisibleby 判断是否可以被数字整除 {{ 224 | divisibleby:2 }} 返回 True
escape 按HTML转义,比如将”<”转换为”&lt”  
filesizeformat 增加数字的可读性,转换结果为13KB,89MB,3Bytes等 {{ 1024 | filesizeformat }} 返回 1.0KB
first 返回列表的第1个元素,变量必须是一个列表  
floatformat 转换为指定精度的小数,默认保留1位小数 {{ 3.1415926 | floatformat:3 }} 返回 3.142  四舍五入
get_digit 从个位数开始截取指定位置的数字 {{ 123456 | get_digit:'1'}}
join 用指定分隔符连接列表 {{ [‘abc','45'] | join:'*' }} 返回 abc*45
length 返回列表中元素的个数或字符串长度  
length_is 检查列表,字符串长度是否符合指定的值 {{ ‘hello'| length_is:'3' }}
linebreaks 用<p>或<br>标签包裹变量 {{ “Hi\n\nDavid”|linebreaks }} 返回<p>Hi</p><p>David</p>
linebreaksbr 用<br/>标签代替换行符  
linenumbers 为变量中的每一行加上行号  
ljust 输出指定长度的字符串,变量左对齐 {{‘ab'|ljust:5}}返回 ‘ab   '
lower 字符串变小写  
make_list 将字符串转换为列表  
pluralize 根据数字确定是否输出英文复数符号  
random 返回列表的随机一项  
removetags 删除字符串中指定的HTML标记 {{value | removetags: “h1 h2”}}
rjust 输出指定长度的字符串,变量右对齐  
slice 切片操作, 返回列表 {{[3,9,1] | slice:':2'}} 返回 [3,9]
{{ 'asdikfjhihgie' | slice:':5' }} 返回 ‘asdik'
slugify 在字符串中留下减号和下划线,其它符号删除,空格用减号替换 {{ '5-2=3and5 2=3' | slugify }} 返回 5-23and5-23
stringformat 字符串格式化,语法同python  
time 返回日期的时间部分  
timesince 以“到现在为止过了多长时间”显示时间变量 结果可能为 45days, 3 hours
timeuntil 以“从现在开始到时间变量”还有多长时间显示时间变量  
title 每个单词首字母大写  
truncatewords 将字符串转换为省略表达方式 {{ 'This is a pen' | truncatewords:2 }}返回 This is ...
truncatewords_html 同上,但保留其中的HTML标签 {{ '<p>This is a pen<;' | truncatewords:2 }}返回 <p>This is ...<;
urlencode 将字符串中的特殊字符转换为url兼容表达方式 {{ ‘http://www.aaa.com/foo?a=b&b=c' | urlencode}}
urlize 将变量字符串中的url由纯文本变为链接  
wordcount 返回变量字符串中的单词数  
yesno 将布尔变量转换为字符串yes, no 或maybe {{ True | yesno }}
{{ False | yesno }}
{{ None | yesno }} 返回 yes no maybe

自定义模板标签开发

除了内置过滤器,开发者还可以根据需求编写自定义过滤器。

首先,需要在应用目录下创建一个名为 templatetags 的 Python 包。

接着,在该包下创建一个 Python 文件,文件名可以任意指定,例如 my_tags.py。

使用 @register.simple_tag 装饰器定义的标签称为 simple_tag。需要注意的是,simple_tag 不能在模板的 if 判断语句中直接使用。

simple_tag 分页实现示例


from django import template
from django.utils.html import format_html
import datetime

register = template.Library()

@register.simple_tag
def page_cut(current_page, loop_page):
 #分页: 固定显示前后5页
 differ = abs(current_page - loop_page)
 if differ < 5:
  li = '''<li class=""><a href="?page=%s" rel="external nofollow" >%s<span class="sr-only">(current)</span></a></li>''' % (loop_page, loop_page)
  return format_html(li)
 else:
  #这里一定要返回一个空字符串,否则在前端会显示一系列的None
  return ''

若需要在模板中进行逻辑判断或更复杂的处理,可以自定义过滤器函数,使用 @register.filter 装饰器。

之所以需要自定义过滤器,正是因为 simple_tag 存在不能在 if 语句中使用的限制。

自定义过滤器函数最多接受两个参数:第一个是变量本身的值,第二个是可选的选项值。

filter 日期颜色判断示例


from django import template
from django.utils.html import format_html
import datetime

register = template.Library()

@register.filter
def time_color(exp_date):
 #给一个月内到期的html标签加上class属性
 startdate = datetime.datetime.now().date()
 enddate = startdate + datetime.timedelta(30)
 if (enddate - exp_date).days > 0 and (enddate - exp_date).days <= 30:
  td = '''<td class="%s">%s</td>''' % ('exp_date', exp_date)
  return format_html(td)
 elif (enddate - exp_date).days > 30:
  td = '''<td class="outof">%s</td>''' % (exp_date)
  return format_html(td)
 else:
  td = '''<td>%s</td>''' % (exp_date)
  return format_html(td)

模板中的引用与使用

第二步是在 HTML 模板中引用自定义标签或过滤器。

在模板文件的开头,必须使用 {% load %} 标签导入刚才创建的 Python 文件。

{% load my_page %}

导入后,即可在模板中像使用内置过滤器一样使用自定义功能。

HTML 模板调用示例


<tbody>
  {% for project in projects_list %}
  <tr>
   <td><a href="{% url 'projects_detail' project.id %}" rel="external nofollow" >{{ project.com_name }}</a></td>
   <td>{{ project.name}}</td>
   <td>{{ project.domain }}</td>
   <td>{{ project.get_status_display }}</td>
   {{ project.exp_date|time_color }}
   <td>{{ project.ftp }}</td>
  </tr>
  {% endfor %}
 </tbody>

以上内容涵盖了 Django 过滤器的基本用法及自定义开发的完整流程,希望对您的开发工作有所帮助。

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。