Django自定义模版标签

Django提供了以下函数,可以轻松地创建自己的模板标签:

  • simple_tag:处理数据并返回字符串
  • inclusion_tag:处理数据并返回呈现的模板

模板标签必须存在于Django应用程序中。

在博客应用程序目录中,创建一个新目录,将其命名为templatetags,并向其中添加一个空的__init__.py文件。在同一文件夹中创建另一个文件,并将其命名为blog_tags.py。命名文件的方式很重要。您将使用此模块的名称来加载模板中的标记。

首先创建一个简单的标记来检索博客中发布的文章总数。

编辑刚刚创建的blog_tags.py文件

python 复制代码
from django import template
from ..models import Post


register = template.Library()

@register.simple_tag
def total_posts():
    return Post.published.count()
  • total_posts()是一个简单的模板标记,它返回到目前为止发布的文章的数量。
  • 使用@register.simple_tag 装饰器将函数注册为简单标记。
  • Django将使用函数名作为标签名。
  • 如果希望使用不同的名称注册它,可以通过指定name属性来实现,比如@register.simple_tag(name='my_tag')。

📌添加新的模板标记模块后,您将需要重新启动Django开发服务器,以便在模板中使用新的标签和过滤器。

在使用自定义模板标签之前,必须使用{% load %}标签使它们在模板中可用。

打开blog/templates/base.html模板,在顶部添加{% load blog_tags %}来加载你的模板标签模块。然后,使用创建的标记来显示您的帖子总数。只需将{% total_posts %}添加到模板中。

html 复制代码
{% load blog_tags %}
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}{% endblock %}</title>
    <link href="{% static 'css/blog.css' %}" rel="stylesheet">
</head>
<body>
    <div id="content">
        {% block content %}
        {% endblock %}
    </div>
    <div id="sidebar">
        <h2>My blog</h2>
            <p>This is my blog.I've written {% total_posts %} posts so far.</p>
    </div>
</body>
</html>

现在创建另一个标记,在博客的侧边栏中显示最新的文章。

使用包含(模版)标记。使用包含标记,可以用模板标记返回的上下文变量呈现模板。
编辑blog_tags.py文件并添加以下代码:

python 复制代码
@register.inclusion_tag('blog/post/latest_posts.html')
def show_latest_posts(count=5):
    latest_posts = Post.published.order_by('-publish')[:count]
    return { 'latest_posts':latest_posts}

使用blog/post/latest_posts.html指定必须用返回值呈现的模板。

模板标记将接受一个可选的count参数,默认值为5。该参数允许指定要显示的帖子数量。

📌该函数返回一个变量字典,而不是一个简单的值。包含标签必须返回一个值的字典。

现在,在templates/blog/post/下创建一个新的模板文件,并将其命名为latest_posts.html。

python 复制代码
<ul>
    {% for post in latest_posts %}
    <li>
        <a href="{{ post.get_absolute_url }}">{{ post.title}}</a>
    </li>
    {% endfor %}
</ul>

使用模板标记返回的latest_posts变量显示了一个无序的帖子列表。

编辑blog/base.html模板

html 复制代码
    <div id="sidebar">
        <h2>My blog</h2>
        <p>This is my blog.I've written {% total_posts %} posts so far.</p>
        <h3>Latest posts</h3>
        {% show_latest_posts 3 %}

    </div>

并添加新的模板标记以显示最后三篇文章。

最后,创建一个标签来显示评论最多的帖子,它将结果存储在一个可以重用的变量中,而不是直接输出结果。

编辑blog_tags.py文件

python 复制代码
from django import template
from ..models import Post
from django.db.models import Count

register = template.Library()

@register.simple_tag
def total_posts():
    return Post.published.count()

@register.inclusion_tag('blog/post/latest_posts.html')
def show_latest_posts(count=5):
    latest_posts = Post.published.order_by('-publish')[:count]
    return { 'latest_posts':latest_posts}

@register.simple_tag
def get_most_commented_posts(count=5):
    return Post.published.annotate(
        total_comments=Count('comments')
    ).order_by('-total_comments')[:count]
  • 使用annotate()函数构建QuerySet来聚合每篇文章的评论总数。
  • 使用Count聚合函数在计算字段total_comments中存储每条评论的数量
  • 按计算字段降序排列QuerySet。我们还提供了一个可选的count变量来限制返回的对象总数。

编辑blog/base.html模板

html 复制代码
{% load blog_tags %}
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}{% endblock %}</title>
    <link href="{% static 'css/blog.css' %}" rel="stylesheet">
</head>
<body>
    <div id="content">
        {% block content %}
        {% endblock %}
    </div>
    <div id="sidebar">
        <h2>My blog</h2>
        <p>This is my blog.I've written {% total_posts %} posts so far.</p>
        <h3>Latest posts</h3>
        {% show_latest_posts 3 %}
        <h3>Most commented posts</h3>
        {% get_most_commented_posts as most_commented_posts %}
        <ul>
            {% for post in most_commented_posts %}
            <li>
                <a href="{{ post.get_absolute_url }}">{{ post.title }}</a>
            </li>
            {% endfor %}
        </ul>
    </div>
</body>
</html>
  • 使用{% get_most_commentted_posts as most_commentted_posts %}将模板标记的结果存储在一个名为most_commentted_posts的新变量中。
  • 然后,使用无序列表显示返回的帖子。

关于Django模版的更多信息模板 | Django 文档 | Django (djangoproject.com)

相关推荐
凤枭香39 分钟前
Python OpenCV 傅里叶变换
开发语言·图像处理·python·opencv
测试杂货铺1 小时前
外包干了2年,快要废了。。
自动化测试·软件测试·python·功能测试·测试工具·面试·职场和发展
艾派森1 小时前
大数据分析案例-基于随机森林算法的智能手机价格预测模型
人工智能·python·随机森林·机器学习·数据挖掘
小码的头发丝、1 小时前
Django中ListView 和 DetailView类的区别
数据库·python·django
Chef_Chen2 小时前
从0开始机器学习--Day17--神经网络反向传播作业
python·神经网络·机器学习
知识的宝藏2 小时前
Django中间件应该怎么使用
中间件·django
千澜空2 小时前
celery在django项目中实现并发任务和定时任务
python·django·celery·定时任务·异步任务
斯凯利.瑞恩2 小时前
Python决策树、随机森林、朴素贝叶斯、KNN(K-最近邻居)分类分析银行拉新活动挖掘潜在贷款客户附数据代码
python·决策树·随机森林
yannan201903133 小时前
【算法】(Python)动态规划
python·算法·动态规划
竹笋常青3 小时前
《流星落凡尘》
django·numpy