0

0

Django自定义过滤器怎么写_模板中|符号调用的文本处理函数

P粉602998670

P粉602998670

发布时间:2026-03-13 13:15:11

|

675人浏览过

|

来源于php中文网

原创

必须手动注册自定义过滤器:在应用的templatetags/目录下创建Python文件,以@register.filter装饰函数,确保应用已加入INSTALLED_APPS;过滤器仅接受value和可选arg两个参数,返回值需为字符串或安全类型。

django自定义过滤器怎么写_模板中|符号调用的文本处理函数

怎么注册自定义过滤器到 Django 模板

必须手动注册,Django 不会自动发现 templatetags 目录下的函数。漏掉注册步骤,模板里用 |my_filter 会静默失败(不报错,但没效果)。

实操建议:

  • 在应用目录下建 templatetags/ 子目录(含 __init__.py
  • 新建 Python 文件如 text_extras.py,开头必须写 from django import template + register = template.Library()
  • 每个过滤器函数前加 @register.filter 装饰器(不能漏 @,也不能写成 @register.simple_tag
  • 确保该应用已添加到 INSTALLED_APPS(否则 load text_extras 会报 Invalid template library

过滤器函数的参数和返回值怎么写才安全

Django 过滤器只接受**一个或两个参数**:第一个是待处理对象(value),第二个是可选参数(arg)。多于两个参数会直接报 TypeError;返回值必须是字符串或能被模板安全转义的类型(否则可能触发 SafeText 问题)。

常见错误现象:|truncatechars:10:True 报错 —— 因为 truncatechars 是内置过滤器,支持两个参数,但自定义过滤器默认只认一个额外参数(即 arg),想支持多个得用 @register.filter(needs_autoescape=True) 配合手动处理,一般不推荐。

示例(安全写法):

@register.filter
def ellipsize(value, length=15):
    if not isinstance(value, str):
        return value
    if len(value) <= length:
        return value
    return value[:length] + '…'

注意:ellipsize 在模板中调用为 {{ post.title|ellipsize:20 }}length 是唯一允许的额外参数。

为什么模板里 load 了还是提示 “Invalid filter”

最常见原因是路径或命名冲突:Django 要求 templatetags 必须在某个已注册的 app 内,且 load 语句中的名字必须和 Python 文件名完全一致(不含 .py)。

使用场景:你在 blog/templatetags/text_extras.py 里写了过滤器,那模板里必须写 {% load text_extras %},而不是 {% load blog.text_extras %}{% load text_extras.py %}

Nanonets
Nanonets

基于AI的自学习OCR文档处理,自动捕获文档数据

下载

容易踩的坑:

  • 文件名含下划线但 load 时用了中划线(text-extras ❌)
  • Python 文件里有语法错误,导致整个模块导入失败(此时 load 会报错,但错误信息不提示具体哪行)
  • 过滤器函数名和内置过滤器重名(如叫 default),Django 会优先用内置的,你的函数被忽略
  • 开发时改了过滤器逻辑但没重启 Django 开发服务器(runserver 缓存了模板标签模块)

要不要对输入做 escape?什么时候关 autoescape

默认情况下,Django 会对过滤器返回值再做一次 HTML 转义。如果你的过滤器本意就是输出 HTML(比如把 Markdown 转成带 <p> 的片段),就必须显式声明 @register.filter(is_safe=True),否则尖括号会被变成

但更关键的是:如果返回值已经含 HTML 标签,又没标 is_safe=True,结果就是页面显示源码而非渲染效果;反之,若你处理的是纯文本却标了 is_safe=True,可能引发 XSS。

实操建议:

  • 纯文本处理(截断、大小写、替换)→ 不用管 is_safe,保持默认即可
  • 返回 HTML 字符串(如 <strong>xxx</strong>)→ 加 @register.filter(is_safe=True)
  • 不确定是否安全?用 mark_safe() 包裹返回值(但仅限你 100% 确认内容可信)

性能影响很小,但安全边界必须卡准 —— 模板层的 autoescape 是最后一道防线,别绕过它除非真有必要。

复杂点在于:同一个过滤器在不同上下文中可能需要不同 escape 行为,这时候就得拆成两个函数,或者加个布尔参数控制(但别让参数逻辑变重,模板调用越简单越好)。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

166

2026.02.04

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1204

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

193

2025.07.29

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 教程
Django 教程

共28课时 | 5万人学习

Django DRF 源码解析
Django DRF 源码解析

共21课时 | 1.5万人学习

Django参考手册
Django参考手册

共0课时 | 0.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号