详解django中自定义标签和过滤器

(编辑：jimmy 日期: 2024/11/20 浏览：3 次 )

想要实现自定义标签和过滤器需要进行准备工作：

准备(必需)工作：

1 在某个app下创建一个名为templatetags(必需，且包名不可变)的包。假设我们在名为polls的app下创建了一个templatetags的包，并在该包下创建了一个名为mytags的文件。那么目录结构看起来应该就像这样：

polls/
  __init__.py
  models.py
  templatetags/
    __init__.py
    mytags.py
  views.py

2 settings文件中的INSTALLD_APPS内必须含有该app。接下来，我们需要确认settings文件中的INSTALLED_APPS变量中已经有了polls

INSTALLED_APPS = (
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
  'polls',
)

3 接下来在mytags文件中写入如下几行

from django import template

register = template.Library()

4 在模板中使用{% load %} 标签装载自定义标签或者装饰器

{% load mytags %}

自定义过滤器：

1 自定义过滤器实际上就是写一个函数

2 django会将过滤器前的值传入该函数

3 函数完成后，需要进行登记register

因为第二步django已经帮我们完成，所以我们实际上只需要自己完成第一步和第三步

实例：写一个自动省略多余字符串的过滤器

1 定义一个 truncate_chars 函数

# 若字符串长度大于30，则省略之后的内容，否则原样输出该字符串。参数value就是过滤器前的值
def truncate_chars(value):
  if value.__len__() > 30:
    return '%s......'% value[0:30]
  else:
    return value

2 register该函数

# 登记
register.filter('truncate_chars',truncate_chars)
def truncate_chars(value):
  if value.__len__() > 30:
    return '%s......'% value[0:30]
  else:
    return value

Library.filter(name,function,is_safe=False,needs_autoescape=False,excepts_localtime=False)函数默认需要两个参数，name是装饰器的名称(字符串类型)，function是函数名。后面三个参数可以参考官方文档。我们也可以通过装饰器进行登记

@register.filter(name='truncate_filter')
def truncate_chars(value):
  if value.__len__() > 30:
    return '%s......'% value[0:30]
  else:
    return value

如果没有使用name参数，django默认会将函数名作为name参数的值，所以下面的代码和上面的代码作用相同。

@register.filter
def truncate_chars(value):
  if value.__len__() > 30:
    return '%s......'% value[0:30]
  else:
    return value

3 测试模板文件内容

{% load mytags %}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
</head>
<body>
{{ 'alskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdffalskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdff'|truncate_chars }}
</body>
</html>

4 浏览器显示结果

自定义标签

自定义标签相对于自定义过滤器来说要复杂很多，因为自定义标签可以做任何事情！

自定义标签分为很多类型

1 简单标签 Simple tags

2 内含标签 Inclusion tags

3 分配标签 Assignment tags

一简单标签

import datetime
from django import template

register = template.Library()

@register.simple_tag
def current_time(format_string):
  return datetime.datetime.now().strftime(format_string)

Library.simple_tag(takes_context=True) takes_context=True参数可以让我们访问模板的当前环境上下文，即将当前环境上下文中的参数和值作为字典传入函数中的一个名为context的参数

@register.simple_tag(takes_context=True)
def current_time(context, format_string):
  timezone = context['timezone']
  return your_get_current_time_method(timezone, format_string)

当使用take_context=True时，函数的第一个参数必需为context。也可以使用name参数对函数进行重命名。

二内含标签

这种类型的标签可以被其他模板进行渲染，然后将渲染结果输出

Library.inclusion_tag()支持take_context=True，用法类似Library.simple_tag()

from django import template
register = template.Library()

@register.inclusion_tag('result.html')
def test():
  a=['first','second','third']
  return {'choices':a}

result.html 内容

<ul>
{% for choice in choices %}
  <li> {{ choice }} </li>
{% endfor %}
</ul>

test.html内容

{% load mytags %}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
</head>
<body>
{% test %}
</body>
</html>

view函数：

def test(request):
  return render(request,'test.html')

当访问http://127.0.0.1:8000/test/时，浏览器显示：

三分配标签

类似于简单标签，但并不会输出结果，可以使用 as 关键字将结果赋给一个参数。

@register.assignment_tag
def get_current_time(format_string):
  return datetime.datetime.now().strftime(format_string)

{% get_current_time "%Y-%m-%d %I:%M %p" as the_time %}
<p>The time is {{ the_time }}.</p>

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

上一篇：基于Python的关键字监控及告警
下一篇：Python中装饰器兼容加括号和不加括号的写法详解