Django模板语法与Jinja2语法规则总结

前言

梳理模板语法,其中包括Django模板语法和jinja2语法。其实,Jinja2是Python下一个被广泛应用的模版引擎,它的设计思想来源于Django的模板引擎,并扩展了其语法和一系列强大的功能。所以两者很多地方的语法规则是相同的,例如变量声明、内置的过滤器、以及一些控制结构等。当然,二者也存在差异,例如for循环控制结构的一些常用属性名,差异的地方我会在文档中指出。Flask框架是使用 Jinja2 这个模板引擎来渲染模

Django使用jinja2模板

  • 安装jinja2库
  pip install jinja2
  • 在应用目录下添加jinja2_env.py设定环境变量
  from django.contrib.staticfiles.storage import staticfiles_storage
  from django.urls import reverse

  from jinja2 import Environment


  def environment(**options):
      env = Environment(**options)
      env.globals.update({
          'static': staticfiles_storage.url,
          'url': reverse,
          })
      return env 
  • 配置项目settings.py文件
  TEMPLATES = [ 
      { 
          #'BACKEND': 'django.template.backends.django.DjangoTemplates',
          # 修改默认的模板渲染引擎,并定引擎为jinja2 
          'BACKEND': 'django.template.backends.jinja2.Jinja2',
          'DIRS': [os.path.join(BASE_DIR, 'templates')],
          #这是配置可以去app下的子目录的找模板(子目录的templates)
          'APP_DIRS': True,
          'OPTIONS': {
              'context_processors': [
                  'django.template.context_processors.debug',
                  'django.template.context_processors.request',
                  'django.contrib.auth.context_processors.auth',
                  'django.contrib.messages.context_processors.messages',
              ],
              #Django自定义模板过滤器添加
              #'libraries': {
              #    'my_inclusion': 'templatetags.my_inclusion',
              # },
              #jinja2环境配置,配置环境,上边创建的py文件
              'environment': 'learning_logs.jinja2_env.environment',
          },
      }, 
  ]

变量、执行逻辑、注释

Django模板中三种特殊符号:{{ }}、{% %}、{# #}

{{ }}表示变量,在模板渲染的时候替换成值; {% %}表示逻辑相关的操作; {# #}表示注释

{{ 变量名 }} 变量名由字母数字和下划线组成。 点(.)在模板语言中有特殊的含义,用来获取对象的相应属性值。 根据标准规范,当模板系统遇到一个(.)时,会按照如下的顺序去查询: 在字典中查询,属性或者方法,数字索引

{# 取l中的第一个参数 #}
{{ l.0 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取对象的name属性 #}
{{ person_list.0.name }}
{# .操作只能调用不带参数的方法 #}
{{ person_list.0.dream }}

django模板语法多行注释

{% comment  '展示多行注释如何使用' %}
多行注释
{% endcomment %}

过滤器 filter

Django过滤器部分,用来修改变量的显示结果。

语法:

{{ value|filter_name:参数 }}
{# ':'左右没有空格没有空格没有空格 #}
  • 常用的过滤器有

default  

  {{ value|default:"nothing"}}

如果value值没传的话就显示nothing

注:TEMPLATES的OPTIONS可以增加一个选项:string_if_invalid:'找不到',可以替代default的的作用。

filesizeformat

将值格式化为一个 “人类可读的” 文件尺寸 (例如 '13 KB', '4.1 MB', '102 bytes', 等等)。例如:

  {{ value|filesizeformat }}

如果 value 是 123456789,输出将会是 117.7 MB。

add

给变量加参数

  {{ value|add:"2" }}

value是数字4,则输出结果为6。

  {{ first|add:second }}

如果first是 [1,.2,3] ,second是 [4,5,6] ,那输出结果是 [1,2,3,4,5,6] 。

lower

小写

  {{ value|lower }}

upper

大写

  {{ value|upper}}

title

标题

  {{ value|title }}

ljust

左对齐

  {{ value|ljust:"10" }}

rjust

右对齐

  {{ value|rjust:"10" }}

center

居中

  {{ value|center:"15" }}

length

  {{ value|length }}

返回value的长度,如 value=['a', 'b', 'c', 'd']的话,就显示4.

slice  

切片

  {{value|slice:"2:-1"}}

first

取第一个元素

  {{ value|first }}

last

取最后一个元素

  {{ value|last }}

join

使用字符串拼接列表。同python的str.join(list)。

  {{ value|join:" // " }}

truncatechars

如果字符串字符多于指定的字符数量,那么会被截断。截断的字符串将以可翻译的省略号序列(“...”)结尾。

参数:截断的字符数

  {{ value|truncatechars:9}}

date

日期格式化

  {{ value|date:"Y-m-d H:i:s"}}

可格式化输出的字符:标准文档

safe

Django的模板中会对HTML标签和JS等语法标签进行自动转义,原因显而易见,这样是为了安全。但是有的时候我们可能不希望这些HTML元素被转义,比如我们做一个内容管理系统,后台添加的文章中是经过修饰的,这些修饰可能是通过一个类似于FCKeditor编辑加注了HTML修饰符的文本,如果自动转义的话显示的就是保护HTML标签的源文件。为了在Django中关闭HTML的自动转义有两种方式,如果是一个单独的变量我们可以通过过滤器“|safe”的方式告诉Django这段代码是安全的不必转义。

比如:

value = "\<a href='#'>点我\</a>"

  {{ value|safe}}

jinja2过滤器

  • 过滤器的使用方式

使用方式:

过滤器的使用方式为:变量名 | 过滤器。

  {{variable | filter_name(*args)}}

如果没有任何参数传给过滤器,则可以把括号省略掉

  {{variable | filter_name}}

在 jinja2 中,过滤器是可以支持链式调用的。

  {{ "hello world" | reverse | upper }}
  • 常用的内建过滤器

1.字符串操作

safe:禁用转义

<p>{{ '<em>hello</em>' | safe }}</p>

capitalize:把变量值的首字母转成大写,其余字母转小写

  <p>{{ 'hello' | capitalize }}</p>

lower:把值转成小写

  <p>{{ 'HELLO' | lower }}</p>

upper:把值转成大写

  <p>{{ 'hello' | upper }}</p>

title:把值中的每个单词的首字母都转成大写

  <p>{{ 'hello' | title }}</p>

reverse:字符串反转

  <p>{{ 'olleh' | reverse }}</p>

format:格式化输出

  <p>{{ '%s is %d' | format('name',17) }}</p>

striptags:渲染之前把值中所有的HTML标签都删掉

  <p>{{ '<em>hello</em>' | striptags }}</p>

truncate: 字符串截断

  <p>{{ 'hello every one' | truncate(9)}}</p>

2.列表操作

first:取第一个元素

  <p>{{ [1,2,3,4,5,6] | first }}</p>

last:取最后一个元素

  <p>{{ [1,2,3,4,5,6] | last }}</p>

length:获取列表长度

  <p>{{ [1,2,3,4,5,6] | length }}</p>

sum:列表求和

  <p>{{ [1,2,3,4,5,6] | sum }}</p>

sort:列表排序

  <p>{{ [6,2,3,1,5,4] | sort }}</p>

控制结构

if 控制结构

{% if daxin.safe %}
    daxin is safe.
{% elif daxin.dead %}
    daxin is dead
{% else %}
    daxin is okay
{% endif %}

for控制结构

  • 通用部分
<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>
  • Django部分
{% for item in 列表 %}
    {{forloop.counter}}  {# 表示当前是第几次循环,从1开始 #}
    {{forloop.counter0}}  {# 表示当前是第几次循环,从0开始 #}
{% endfor %}

{% for item in 列表 %}
    {{forloop.counter}}  {# 表示当前是第几次循环,从1开始 #}
    {{forloop.counter0}}  {# 表示当前是第几次循环,从0开始 #}
{% empty %} 
    {# 列表为空或不存在时执行此逻辑 #}
{% endfor %}

一些Django模板语法的拓展

forloop.counter     当前循环的索引值(从1开始)
forloop.counter0    当前循环的索引值(从0开始)
forloop.revcounter  当前循环的倒序索引值(到1结束)
forloop.revcounter0     当前循环的倒序索引值(到0结束)
forloop.first   当前循环是不是第一次循环(布尔值)
forloop.last    当前循环是不是最后一次循环(布尔值)
forloop.parentloop  本层循环的外层循环
  • jinja2部分
{% for item in 列表 %}
    {{loop.index}}  {# 表示当前是第几次循环,从1开始 #}
    {{loop.index0}}  {# 表示当前是第几次循环,从0开始 #}
{% endfor %}

一些jinja2语法的拓展

loop.index  当前循环迭代的次数(从 1 开始)
loop.index0     当前循环迭代的次数(从 0 开始)
loop.revindex   到循环结束需要迭代的次数(从 1 开始)
loop.revindex0  到循环结束需要迭代的次数(从 0 开始)
loop.first  如果是第一次迭代,为 True 。
loop.last   如果是最后一次迭代,为 True 。
loop.length     序列中的项目数。
loop.cycle  在一串序列间期取值的辅助函数。

with结构(二者通用)

{% with total=business.employees.count %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

Django模板语法

{% trans "Title" as title %}
{% block content %}{{ title }}{% endblock %}

jinja2宏定义

宏类似常规编程语言中的函数。它们用于把常用行为作为可重用的函数,取代 手动重复的工作。 例子:

{% macro input(name, value='', type='text', size=20) -%}
    <input type="{{ type }}" name="{{ name }}" value="{{
        value|e }}" size="{{ size }}">
{%- endmacro %}

在命名空间中,宏之后可以像函数一样调用:

<p>{{ input('username') }}</p>
<p>{{ input('password', type='password') }}</p>

如果宏在不同的模板中定义,你需要首先使用 import

{% from 'base/macro/submit.macro' import test %}

自定义过滤器

django中自定义过滤器

  • 配置settings
TEMPLATES = [ 
    { 
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        #这是配置可以去app下的子目录的找模板(子目录的templates)
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
            #Django自定义模板过滤器添加
            'libraries': {
                # '调用名': '对应文件路径'
               'my_inclusion': 'templatetags.my_inclusion',
            },
        },
    }, 
]
  • 在指定文件下完成代码
from django import template
register = template.Library()

@register.filter
def fill(value, arg):
    return value.replace(" ", arg)

@register.filter(name="addSB")
def add_sb(value):
    return "{} SB".format(value)

@register.simple_tag(name="plus")
def plus(a, b, c):
    return "{} + {} + {}".format(a, b, c)

@register.inclusion_tag('result.html')
def show_results(n):
    n = 1 if n < 1 else int(n)
    data = ["第{}项".format(i) for i in range(1, n+1)]
    return {"data": data}
  • inclusion_tag准备调用的result.html
<ul>
  {% for choice in data %}
    <li>{{ choice }}</li>
  {% endfor %}
</ul>
  • 模板调用
{# 先导入我们自定义filter那个文件 #}
{% load my_inclusion %}

{# 使用我们自定义的filter #}
{{ somevariable|fill:"__" }}
{{ d.name|addSB }}

{# simple tag #}
{% plus "1" "2" "abc" %}

{# inclusion_tag #}
{% show_results 10 %}

jinja2 在flask中的自定义过滤器

例如创建一个可以让列表反转的过滤器

1.方法一

def do_listreverse(li):
    li.reverse()
    return li
app.add_template_filter(do_listreverse,"listreverse")    #listreverse是过滤器的名称

2.方法二(最常用这种)

@app.template_filter("listreverse")
def do_listreverse(li):
    li.reverse()
    return li

模板的母板、继承、块、组建等

  • 母板,块

通过在母板中使用{% block xxx %}来定义"块"。

在子页面中通过定义母板中的block名来对应替换母板中相应的内容。

注意:我们通常会在母板中定义页面专用的CSS块和JS块,方便子页面替换。

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Title</title>
  {% block page-css %}

  {% endblock %}
</head>
<body>

<h1>这是母板的标题</h1>

{% block page-main %}

{% endblock %}
<h1>母板底部内容</h1>
{% block page-js %}

{% endblock %}
</body>
</html>
  • 继承母板

下面的代码是对母板的继承和块实现

{% extends 'layouts.html' %}
{% block page-main %}
{# {{ super() }}  jinja2 语法中类似与类对基类的调用 #}
  <p>世情薄</p>
  <p>人情恶</p>
  <p>雨送黄昏花易落</p>
{% endblock %}
  • 组件
{% include 'navbar.html' %}
  • 静态文件相关
{% load static %}
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />

{% load static %}
<script src="{% static "mytest.js" %}"></script>

{% load static %}
{% static "images/hi.jpg" as myphoto %}
<img src="{{ myphoto }}"></img>

{% load static %}
<img src="{% get_static_prefix %}images/hi.jpg" alt="Hi!" />

{% load static %}
{% get_static_prefix as STATIC_PREFIX %}

<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi!" />
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" alt="Hello!" /

感言

无疑,这又是一篇踩在前人肩膀上的博文,让我们对那些无私分享自己对技术探索结果的小伙伴们致以崇高的敬意。

引用链接:https://www.cnblogs.com/wasayezi/p/8693843.html

引用链接:https://www.cnblogs.com/maple-shaw/articles/9333821.html

引用链接:https://blog.csdn.net/qq_19268039/article/details/83245311

引用链接:https://www.cnblogs.com/chichung/p/9898017.html

引用链接:https://www.cnblogs.com/linuxhui/p/5804380.html

引用链接:https://www.cnblogs.com/chichung/p/9775099.html

版权声明:除特别注明外,本站所有文章均为王晨曦个人站点原创

转载请注明:出处来自王晨曦个人站点 » Django模板语法与Jinja2语法规则总结

点赞

发表评论

电子邮件地址不会被公开。 必填项已用*标注

  1. visathy 说道:

    https://buytadalafshop.com/ - Cialis

  2. doxosse 说道:

    http://buypropeciaon.com/ - cheap propecia 10mg

  3. Levitra Caratteristiche In Farmacia

  4. antimaNib 说道:

    http://buystromectolon.com/ - where can i buy stromectol

  5. Cialis 说道:

    Cialis 5 Mg Effetto