在Django框架中自定义模板过滤器的方法
自定义过滤器就是有一个或两个参数的Python函数:
- (输入)变量的值
- 参数的值,可以是默认值或者完全留空
例如,在过滤器{{var|foo:"bar"}}中,过滤器foo会被传入变量var和默认参数bar。
过滤器函数应该总有返回值。而且不能触发异常,它们都应该静静地失败。如果出现错误,应该返回一个原始输入或者空字符串,这会更有意义。
这里是一些定义过滤器的例子:
defcut(value,arg): "Removesallvaluesofargfromthegivenstring" returnvalue.replace(arg,'')
下面是一个可以用来去掉变量值空格的过滤器例子:
{{somevariable|cut:""}}
大多数过滤器并不需要参数。下面的例子把参数从你的函数中拿掉了:
deflower(value):#Onlyoneargument. "Convertsastringintoalllowercase" returnvalue.lower()
当你定义完过滤器后,你需要用Library实例来注册它,这样就能通过Django的模板语言来使用了:
register.filter('cut',cut) register.filter('lower',lower)
Library.filter()方法需要两个参数:
- 过滤器的名称(一个字串)
- 过滤器函数本身
如果你使用的是Python2.4或者更新的版本,你可以使用装饰器register.filter():
@register.filter(name='cut') defcut(value,arg): returnvalue.replace(arg,'') @register.filter deflower(value): returnvalue.lower()
如果你想第二个例子那样不使用name参数,那么Django会把函数名当作过滤器的名字。
下面是一个完整的模板库的例子,它包含一个cut过滤器:
fromdjangoimporttemplate register=template.Library() @register.filter(name='cut') defcut(value,arg): returnvalue.replace(arg,'')