准备(必需)工作:
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文件中写入如下几行
fromdjango importtemplate
register=template.Library()
4 在模板中使用{% load %} 标签装载自定义标签或者装饰器(注意此处最重要,一定要先load py文件,不知标签或者过滤器名)
{%load mytags %}
(1)自定义过滤器:
使用
1 自定义过滤器实际上就是写一个函数
2 django会将过滤器前的值传入该函数
3 函数完成后,需要进行登记register
因为第二步django已经帮我们完成,所以我们实际上只需要自己完成第一步和第三步
实例:写一个自动省略多余字符串的过滤器
1 定义一个 truncate_chars 函数
# 若字符串长度大于30,则省略之后的内容,否则原样输出该字符串。参数value就是过滤器前的值
deftruncate_chars(value):
ifvalue.__len__() > 30:
return'%s......'%value[0:30]
else:
return value
2 register该函数
# 登记
register.filter('truncate_chars',truncate_chars)
deftruncate_chars(value):
ifvalue.__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')
deftruncate_chars(value):
ifvalue.__len__() > 30:
return'%s......'%value[0:30]
else:
returnvalue
如果没有使用name参数,django默认会将函数名作为name参数的值,所以下面的代码和上面的代码作用相同。
@register.filter
deftruncate_chars(value):
ifvalue.__len__() > 30:
return'%s......'%value[0:30]
else:
returnvalue
3 测试模板文件内容
{% load mytags %}
<!DOCTYPE html>
<htmllang="en">
<head>
<metacharset="UTF-8">
<title>Title</title>
</head>
<body>
{{ 'alskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdffalskdjasdfasdfasdffasdfasdfasdffasdffasdffasdffasdfasdffasdff'|truncate_chars }}
</body>
</html>
4 复杂过滤器,从list中取出对象,并从对象中取出属性值
@register.filter
def get_by_list_index(obj,index):
"""
list 根据下标获得值的过滤器
:param obj:
:param index:
:return:
"""
return obj[index]
@register.filter
def get_by_obj_attr(obj,attr):
"""
获得对象的属性值
:param obj:
:param index:
:return:
"""
if hasattr(obj, attr):
return getattr(obj, attr)
html文件
{{ result_list|get_by_list_index:0|get_by_obj_attr:'id' }}
从result_list中取出下标为0的对象,并从此对象中取出id属性的值
(2)自定义标签
自定义标签相对于自定义过滤器来说要复杂很多,因为自定义标签可以做任何事情!
自定义标签分为很多类型
1 简单标签 Simple tags
2 内含标签 Inclusion tags
3 分配标签 Assignment tags
一 简单标签
importdatetime
fromdjango importtemplate
register=template.Library()
@register.simple_tag
defcurrent_time(format_string):
returndatetime.datetime.now().strftime(format_string)
Library.simple_tag(takes_context=True) takes_context=True参数可以让我们访问模板的当前环境上下文,即将当前环境上下文中的参数和值作为字典传入函数中的一个名为context的参数
@register.simple_tag(takes_context=True)
defcurrent_time(context, format_string):
timezone=context['timezone']
returnyour_get_current_time_method(timezone, format_string)
当使用take_context=True时,函数的第一个参数必需为context。也可以使用name参数对函数进行重命名。
二 内含标签
这种类型的标签可以被其他模板进行渲染,然后将渲染结果输出
Library.inclusion_tag()支持take_context=True,用法类似Library.simple_tag()
fromdjango importtemplate
register=template.Library()
@register.inclusion_tag('result.html')
deftest():
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>
<htmllang="en">
<head>
<metacharset="UTF-8">
<title>Title</title>
</head>
<body>
{% test %}
</body>
</html>
view函数:
deftest(request):
returnrender(request,'test.html')
当访问http://127.0.0.1:8000/test/时,浏览器显示:
三 分配标签
类似于简单标签,但并不会输出结果,可以使用 as 关键字将结果赋给一个参数。
@register.assignment_tag
defget_current_time(format_string):
returndatetime.datetime.now().strftime(format_string)
{% get_current_time "%Y-%m-%d %I:%M %p" as the_time %}
<p>The time is {{ the_time }}.</p>
(3)模板继承
1、命名为base.html,这个页面主要放公用部分的代码,各个子页面都可以继承这个页面的样式。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{% block title %}首页{% endblock %}</title>
{% block js %} {% endblock %}
{% block css %} {% endblock %}
</head>
<body>
{% block content %}{% endblock %}
</body>
</html>
2、编写各个子模板。
如下所示,{% extends ‘base.html’ %}作为基础模板,必须放在第一行才可以识别。
{% block %}这个标签,告诉模板引擎,子模板可以重载这些
{% include %}允许模板中包含其他模板。
注意css和js等静态文件,是和html不同的识别方式。
{% extends 'base.html' %}
<!-- 该页面不允许出现js以及css代码,content代码可直接写在本文件中,下面只是content的实例代码 -->
{% block title %}
<!-- 此处写页面标题 -->
{% endblock %}
{% block js %}
<!-- 此处填充js链接 -->
<script type="text/javascript" src="..."></script>
{% endblock %}
{% block css %}
<!-- 此处填充css链接 -->
{% endblock %}
{% block content %}
<!-- 此处填充页面主体内容 -->
{% include 'taskApp/cjjdglContent.html' %}
{% endblock %}
这种方式用起来,不仅改起来便捷,代码量也显然减少了不少。
(四)修改 admin 原生change_list.html的例子
admin的模板路径为/usr/lib64/python2.7/site-packages/django/contrib/admin/templates/admin
找到 change_list.html和change_list_results.html,复制到当前项目app的templates/admin/app名字/model的名字 ,目录下。
编辑change_list.html修改list表格的显示,我们可以找到,其实是这句话再起作用
{% result_list_siteinfo cl %}
result_list 器是是一个标签,这个标签可以在/usr/lib64/python2.7/site-packages/django/contrib/admin/templatetags/admin_list.py中找到:
@register.inclusion_tag("admin/change_list_results.html")
def result_list(cl):
"""
Displays the headers and data list together
"""
headers = list(result_headers(cl))
num_sorted_fields = 0
for h in headers:
if h['sortable'] and h['sorted']:
num_sorted_fields += 1
return {'cl': cl,
'result_hidden_fields': list(result_hidden_fields(cl)),
'result_headers': headers,
'num_sorted_fields': num_sorted_fields,
'results': list(results(cl))}
我们要修改list的显示,其实就是改这个标签,这时,我们自定义一个标签
@register.inclusion_tag("admin/app名字/model名字/change_list_results.html")
def result_list_siteinfo(cl):
"""
Displays the headers and data list together
"""
result=cl.result_list#result存储的是查询出的对象list
for r in result:
print r.id
"""
这里写你修改的代码
"""
return ""
然后change_list.html改为
{% result_list_siteinfo cl %}