Flask开发系列之模板

Flask开发系列之模板

本文对《FlaskWeb开发：基于python的Web应用开发实战》模板一节做的总结。

Jinja2模板引擎

模板

模板是一个包含响应文本的文件，其中包含用占位变量表示的动态部分，其具体值只在请求的上下文中才能知道。使用真实值替代变量，再返回最终得到的响应字符串，这一过程成为渲染。

Jinja2模板引擎

官网地址

Jinja2是纯python编写的模板引擎，它和Django类似提供non-XML语法，除此之外还支持内联表达式和一个可选的沙箱环境。Jinja2遵守BSD开源协议。

Flask渲染模板使用的是Jinja2模板引擎，所以需要安装Jinja2，pip install Jinja2。

 

渲染模板

from flask import Flask,render_template

app = Flask(__name__)
@app.route('/')
def index():
    return render_template('index.html')

@app.route('/user/', methods=['GET'])
def reponse(name):
    print(name)
    return render_template('user.html', name=name)

if __name__ == '__main__':
    app.run(debug=True)
    # Flask提供的render_template函数把Jinja2模板引擎集成到了程序中。
    # render_template函数的第一个参数是模板的文件名。
    # 随后的参数都是键值对，表示模板中变量对应的真实值。

 

变量

模板中使用的{{ name }}结构表示一个变量，它是一种特殊的占位符，告诉模块引擎这个位置的值从渲染模板时使用的数据中获取。

Jinja2 能识别所有类型的变量，甚至是一些复杂的类型，例如列表、字典和对象。示例：

A value from a dictionary:{{ mydict['key']}}.
A value from a list:{{ mylist[3]}}.
A value from a list,with a variable index:{{ mylist[myintvar] }}.
A value from an object's method: {{ myobj.somemethod() }}.

Jinja2变量过滤器

过滤器名添加在变量之后，中间使用竖线分隔。

hello, {{ name|capitalize }}

完整过滤器列表

常用过滤器：

过滤器名	说明
safe	渲染值时不转义
capitalize	把值得首字母转换成大写，其他字母转换成小写
lower	把值转换成小写形式
upper	把值转换成大写形式
title	把值中每个单词的首字母都换成大写
trim	把值的首位空格去掉
striptags	渲染之前把值中所有的HTML标签都删掉

 

 

控制结构

条件控制结构

{% if user %}
    Hello,{{ user }}!
{% else %}
    Hello, Stranger!
{% endif %}
 

渲染一组元素

    {% for comment in comments %}
        
{{ comment }}

    {% endfor %}

宏

{{% macro render_comment(comment)%}}
    
{{ comment }}

{{ endmacro }}
 

    {% for comment in comments %}
        {{ render_comment(comment) }}
    {% endfor %}

 
为了重复使用宏，保存在单独文件中，再在需要的模板中导入。
{% import 'macro.html' as macros %}

    {% for comment in comments%}
        {{ macros.render_comment(comment)}}
    {% endfor%}

复用代码片段

{% include 'common.html' %}

模板继承

- 建一个名为base.html的基模板


    {% block head %}
    
    {% endblock %}


    {% block body %}
    {% endblock %}


 
- 衍生模板中修改block标签定义的元素
{% extends "base.html" %} #定义基模板
{% block title%}Index{% endblock %} #修改title块内容
{% block head %} #修改head块内容
    {{ super() }} #原来head中有内容，用super()获取原来的内容
    
{% endblock %}
{% block body %} #修改body块内容
Hello, World!

{% endblock %}

 

使用Flask-Bootstrap集成Twitter Bootstrap

Bootstrap（http://getbootstrap.com/）是 Twitter 开发的一个开源框架，它提供的用户界面组
件可用于创建整洁且具有吸引力的网页，而且这些网页还能兼容所有现代 Web 浏览器。
Bootstrap 是客户端框架，因此不会直接涉及服务器。服务器需要做的只是提供引用了
Bootstrap 层 叠 样 式 表（CSS） 和 JavaScript 文 件 的 HTML 响 应， 并 在 HTML、CSS 和
JavaScript 代码中实例化所需组件。这些操作最理想的执行场所就是模板。
要想在程序中集成 Bootstrap，显然要对模板做所有必要的改动。不过，更简单的方法是
使用一个名为 Flask-Bootstrap 的 Flask 扩展，简化集成的过程。Flask-Bootstrap 使用 pip
安装：
(venv) $ pip install flask-bootstrap

Flask 扩展一般都在创建程序实例时初始化

Flask-Bootstrap 的初始化方法

from flask.ext.bootstrap import Bootstrap
# ...
bootstrap = Bootstrap(app)

使用Flask-Bootstrap的模板

初始化 Flask-Bootstrap 之后，就可以在程序中使用一个包含所有 Bootstrap 文件的基模板。
这个模板利用 Jinja2 的模板继承机制，让程序扩展一个具有基本页面结构的基模板，其中
就有用来引入 Bootstrap 的元素。

{% extends "bootstrap/base.html" %}
 
{% block title%}Flasky{% endblock %}
 
{% block navbar %}
class="navbar navbar-inverse" role="navigation">
    
class='container'>
        
class="navbar-header">
            "button" class="navbar-toggle"
            data-toggle="collapse" data-target=".navbar-collapse">
            class="sr-only">Toggle navigation
            class='icon-bar'>
            class="icon-bar">
            class="icon-bar">
            
            class="navbar-brand" href="/">Flasky
        
        
class="navbar-collapse collapse">
            
class="nav navbar-nav">
                
"/">
            
        
    

{% endblock %}
 
{% block content %}
class="container">
    
class="page-header">
        
Hello,{{ name }}!
    

{% endblock %}
# 模板利用Bootstrap中的样式进行了修改

Jinja2 中的 extends 指令从 Flask-Bootstrap 中导入 bootstrap/base.html，从而实现模板继
承。Flask-Bootstrap 中的基模板提供了一个网页框架，引入了 Bootstrap 中的所有 CSS 和
模板 ｜ 25
JavaScript 文件。
基模板中定义了可在衍生模板中重定义的块。 block 和 endblock 指令定义的块中的内容可
添加到基模板中。
上面这个 user.html 模板定义了 3 个块，分别名为 title 、 navbar 和 content 。这些块都是
基模板提供的，可在衍生模板中重新定义。 title 块的作用很明显，其中的内容会出现在
渲染后的 HTML 文档头部，放在