在Django框架中自定义模板过滤器的方法

在 Django 里，自定义过滤器本质上就是一个普通的 Python 函数，它接受一到两个参数。来看下面这张图，它帮你直观理解这个结构：  具体来说，这两个参数分别是： - 变量的值（也就是模板中管道符前面的那个对象） - 参数的值——可以提供一个默认值，也可以完全留空不传 举个例子，在模板里写 `{{ var|foo:"bar" }}`，这里的 `foo` 过滤器就会收到两个东西：变量 `var` 的值，以及字符串参数 `"bar"`。 过滤器函数必须始终返回一个值，而且不能抛异常——它们应该优雅地失败。如果遇到错误，最好的做法是返回原始输入或者一个空字符串，这样比让页面崩掉有意义得多。 下面看几个具体的过滤器定义例子： ```python def cut(value, arg): "Removes all values of arg from the given string" return value.replace(arg, '') ``` 这个 `cut` 过滤器会把字符串中所有匹配 `arg` 的子串删掉。怎么用呢？比如模板里这样写： ```python {{ somevariable|cut:" " }} ``` 就会把 `somevariable` 里的所有空格去掉。 大多数过滤器其实并不需要额外参数。下面这个 `lower` 过滤器就没有参数： ```python def lower(value): # Only one argument. "Converts a string into all lowercase" return value.lower() ``` 定义好过滤器之后，接下来要用 `Library` 实例把它注册到 Django 的模板系统中，这样模板才能识别它： ```python register.filter('cut', cut) register.filter('lower', lower) ``` `Library.filter()` 方法接收两个参数： - 过滤器名称（一个字符串） - 过滤器函数本身 如果你用的是 Python 2.4 或更新的版本，还可以用装饰器语法来注册，更简洁： ```python @register.filter(name='cut') def cut(value, arg): return value.replace(arg, '') @register.filter def lower(value): return value.lower() ``` 注意第二个例子没写 `name` 参数——这时 Django 就会自动把函数名当作过滤器的名字，也就是 `lower`。 最后，一个完整的模板库实例大概长这样，它只包含一个 `cut` 过滤器： ```python from django import template register = template.Library() @register.filter(name='cut') def cut(value, arg): return value.replace(arg, '') ``` 把这段代码放到一个 Python 文件里（比如 `templatetags/my_filters.py`），然后在模板顶部 `{% load my_filters %}`，就能愉快地使用 `cut` 过滤器了。整个过程其实没多少弯弯绕绕，理解了这个模式，自定义过滤器就手到擒来。