Templates

  • 配置
    有关模板的配置位于settings.py中的TEMPLATES中
    # settings.py
    TEMPLATES = [
        {
            'BACKEND': 'django.template.backends.django.DjangoTemplates',
           # 'DIRS' 定义一个Django在查找模板时应该遍历的目录列表
            'DIRS': [],
            # 'APP_DIRS' 指明Django是否应该去各app应用目录下查找模板
            'APP_DIRS': True,
            'OPTIONS': {
                # ... some options here ...
            },
        },
    ]
    

  • 使用模板(django.template.loader)
    • get_template(template_name, using=None)
      返回查找到的模板对象
    • select_template(template_name_list, using=None)
      同get_template()用法一致,只不过返回的是模板对象列表(因为参数也是列表)
    • exception TemplateDoesNotExist(msg, tried=None, backend=None, chain=None)
      当模板未能找到时,引发该异常
    • exception TemplateSyntaxError(msg)
      当被查找到的模板中存在语法错误时引发该异常
    • render(context=None, request=None)
      查找到并返回的Template对象必须实现上边的方法
    • render_to_string(template_name, context=None, request=None, using=None)
      get_template()函数和render()方法的结合

模板语言

  • 模板变量({{ variables }})

    当模板系统遇到一个 '.' 时,将会按照以下顺序进行查询

    • 查询相应的字典
    • 查询属性或者方法
    • 查询序列索引

    如果查询的结果可以被调用,Django将会进行无参数调用,并返回调用结果
    若变量不存在,模板系统将会插入string_if_invalid中设置的值(该值在settings.TEMPLATES['OPTIONS']中设置)

  • 过滤器

    • 一般形式:{{ name|lower }}
    • 链状形式:{{ text|escape|linebreaks }}
    • 包含参数:{{ bio|truncatewords:30 }}
    • 含有空格的参数必须使用引号:{{ list|join:", " }}

    Django中所有的过滤器

    • 一些常使用的过滤器
      • default({{ value|default:"nothing" }}):若变量不存在,则返回default中的参数值
      • length:返回变量的长度(适用于字符串和列表)
      • filesizeformat:将数字以文件大小的表示形式返回(即:13 KB8.8 MB等等)
  • 模板标签({% tags %})

    使用extends标签需要注意

    • {% extends %}标签必须是该模板中的第一个标签
    • {% block %}标签的使用多多益善
    • 当需要使用父模板中block里边的内容时,可以通过{{ block.super }}变量来获得(注意block.super是变量)
    • {% block %}外通过模板标签创造的变量无法在{% block %}内使用
      {% trans "Title" as title %}
      {% block content %}{{ title }}{% endblock %}
      # 上述标签将不会返回任何东西
      
    • {% endblock %}中可以选择性的添加块名,如{% endblock content %}

Automatic HTML escaping

用户可能会在变量中添加HTML标签,而使得模板展示出现错误(Cross Site Scripting(XSS)攻击)
有两种方法可以避免该问题:

  • 使用escape过滤器将传入的变量转变为无害的变量,这种方法是Django默认使用的方法(但是这种方法会escape掉所有传入的变量)
  • 利用Django的 automatic HTML escaping
关闭自动escape

有时候可能用户希望传入原生的HTML语句(即保留标签的使用等),有以下方法可以使得escape的使用关闭

  • 对于单个变量
    使用save过滤器
    This will be escaped: {{ data }}
    This will not be escaped: {{ data|safe }}
    
  • 对于模板中的块(blocks)
    使用autoescape标签
    Auto-escaping is on by default. Hello {{ name }}
    
    # 关闭autoescape(即对传入变量不做处理)
    {% autoescape off %}
        This will not be auto-escaped: {{ data }}.
    
        Nor this: {{ other_data }}
        {% autoescape on %}
            Auto-escaping applies again: {{ name }}
        {% endautoescape %}
    {% endautoescape %}
    
    autoescape标签之间中的所有内容(包括其他标签、子模板等等)都会遵循autoescape的状态
  • default过滤器
    default过滤器中的内容默认为关闭escape
    # 应该使用这种形式
    {{ data|default:"3 < 2" }}
    # 而不应该使用这种形式
    {{ data|default:"3 < 2"}}
    

自定义标签和过滤器的使用

  1. 需要确保包含自定义标签和过滤器的应用在INSTALLED_APPS
  2. 在模板中使用{% load %}标签
  3. {% load %}标签可以加载多个库
    {{ load humanize i18n }}
    

另外需要注意的是,子模板不继承父模板的{% load %}标签,因此必要时,需要在子模板中使用{% load %}标签进行重新加载


Django中内建的标签和过滤器


自定义标签和过滤器

布局

  • 在app的直接目录下创建templatetags文件夹,并将其声明为一个包(即在templatetags中创建__init__.py文件)
  • temloatetags中创建定义标签和过滤器的python文件(如poll_extras.py),并在需要用到相应标签/过滤的模板中通过{% load poll_extras %}引入(注意该app已存在于INSTALLED_APPS
  • 将相关python文件注册为可以使用的标签库
    from django import template
    
    register = template.Library()
    

自定义过滤器

过滤器函数至少需要一个参数(传入被过滤对象),此外可以选择性地使用另一个参数

def cut(value, arg):
    return value.replace(arg, '')
# 使用:{{ somevariable|cut:"0" }}
  • 注册自定义过滤器
    有两种方法注册过滤器
    • register.filter()
      # 第一个参数是过滤器使用的名称,第二个参数是过滤器使用的函数
      register.filter('cut', cut)
      
    • 装饰器
      # 若装饰器含有name参数,则该过滤器名称会被设置为name参数所指对象
      @register.filter(name='cut')
      def cut(value, arg):
          return value.replace(arg, '')
      
      # 若装饰器没有name参数,django会自动使用函数名作为过滤器名称
      @register.filter
      def lower(value):
          return value.lower()
      
  • 强制转变第一个传入的参数为字符串类型
    from django import template
    from django.template.defaultfilters import stringfilter
    
    register = template.Library()
    
    @register.filter
    # 该过滤器会将被过滤对象首先转变为字符串类型
    @stringfilter
    def lower(value):
        return value.lower()
    
  • register.filter()中的其它三个参数(全部默认为False)
    • is_safe
    • needs_autoescape
    • expects_localtime

自定义模板标签

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,393评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,790评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,391评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,703评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,613评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,003评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,507评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,158评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,300评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,256评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,274评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,984评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,569评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,662评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,899评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,268评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,840评论 2 339

推荐阅读更多精彩内容