Flask의 템플릿 기능은 Jinja2 템플릿 엔진을 기반으로 합니다. 템플릿 파일은 현재 하위 디렉터리인 template에 저장됩니다(반드시 이 이름을 사용하십시오).
main.py 코드는 다음과 같습니다.
from flask import Flask, render_template app = Flask(__name__) @app.route('/hello') @app.route('/hello/<name>') def hello(name=None): return render_template('hello.html', name=name) if __name__ == '__main__': app.run(debug=True)
hello.html 코드는 다음과 같습니다.
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Hello Sample</title> </head> <body> {% if name %} <h1>Hello {{ name }} !</h1> {% else %} <h1>Hello World!</h1> {% endif %} </body> </html>
템플릿 표현식은 모두 "{{ }}" 구분 기호에 포함됩니다. 또한 제어 문은 모두 "{% %}" 구분 기호에 포함됩니다. 또한 지원합니다. 주석은 구분 기호 "{# #}"에 포함되며 블록 주석도 지원됩니다.
표현식
일반적으로 여러 유형의 표현식이 있습니다.
가장 일반적으로 사용되는 표현식은 Flask가 렌더링될 때 전달되는 변수입니다. 위 예제
의 "name"과 같은 템플릿은 따옴표로 묶인 문자열 {{ "Hello" }}와 같은 기본 Python 유형일 수도 있습니다. 또는 숫자 값, 목록, 튜플, 사전, 부울. 기본형을 직접 표시하는 것은 의미가 없습니다. 일반적으로
연산은 다른 표현과 함께 사용됩니다. {{ 2 + 3 }} 등의 산술 연산, {{ 2 > 1 }} 등의 논리 연산 포함
필터링 테스터 "|"와 테스터 "is"입니다. 이는 나중에 소개될 예정입니다.
함수 호출(예: {{ current_time() }}); 배열 첨자 작업(예: {{ arr[1] }}
"in" 연산자(예: {{ 1 in [1,2,3] }}
문자열 연결 연산자 "~", 기능은 동일함) Python에서와 같이 "+"(예: {{ "Hello " ~ name ~ "!" }}
"if" 키워드, 예: {{ 'Hi, %s' %) 이름이면 이름 }}. 여기서 "if"는 조건부 제어문이 아닙니다.
제어문
Jinja2의 제어문은 주로 조건 제어문 if와 루프 제어문 for와 유사합니다. 파이썬. 이전 섹션에서 템플릿 코드를 변경할 수 있습니다.
{% if name and name == 'admin' %} <h1>This is admin console</h1> {% elif name %} <h1>Welcome {{ name }}!</h1> {% else %} <h1>Please login</h1> {% endif %}
위는 조건 제어문의 예입니다. if 제어문은 "를 사용해야 합니다. {% endif %} "를 종료합니다. 템플릿에서는 코드에서처럼 들여쓰기에 의존하여 코드 블록의 끝을 결정할 수 없습니다. 루프 예제를 다시 살펴보겠습니다. 먼저 Python 코드에서 "hello" 함수를 변경하고 두 개의 목록을 템플릿에 전달하도록 하겠습니다.
def hello(name=None): return render_template('hello.html', name=name, digits=[1,2,3,4,5], users=[{'name':'John'}, {'name':'Tom', 'hidden':True}, {'name':'Lisa'} {'name':'Bob'}])
템플릿은 다음과 같습니다.
{% if name and name == 'admin' %} <h1>Helle admin</h1> {% elif name %} <h1>"Hello" ~ {{ name }} ~ "!"</h1> {% else %} <h1>Hello World!</h1> {% endif %} {% for digit in digits %} {{ digit }} {% endfor %}
if 문과 동일합니다. for 제어문은 "{% endfor %}"로 끝나야 합니다. 페이지에서 각 요소 사이에 공백이 있습니다. 공백을 원하지 않으면 "for" 문 끝과 "endfor" 문 시작 부분에 "-" 기호를 추가하세요. 예를 들면
{% for digit in digits -%} {{ digit }} {%- endfor %}
"12345"라는 숫자가 함께 표시되는 것을 볼 수 있습니다. 복잡한 루프 예를 다시 살펴보겠습니다.
<dl> {% for user in users if not user.hidden %} {% if loop.first %} <p>User List:</p> {% endif %} <p class="{{ loop.cycle('odd', 'even') }}"> <dt>User No. {{ loop.index }}</dt> <dd>{{ user.name }}</dd> </p> {% if loop.last %} <dir>Total Users: {{ loop.length }}</dir> {% endif %} {% else %} <li>No users found</li> {% endfor %} </dl>
여기에는 세 가지 지식 포인트가 있습니다. 우선 for 루프는 순회할 "사용자" 목록이 비어 있거나 None인 경우 else 문을 지원합니다.
두 번째로 for 문 뒤에 if 키워드를 사용하여 루프의 항목을 필터링합니다. 이 예에서는 숨겨진 속성이 True인 모든 사용자가 필터링됩니다.
또한 Jinja2에 내장된 루프 변수는 for 루프에서 액세스할 수 있습니다. 이 예에서는 첫 번째 항목 앞에 제목을 표시하고, 마지막 항목 뒤에는 총 개수와 각 항목의 일련번호를 표시합니다. 또한 홀수 및 짝수 항목에 대한 HTML p 요소는 다른 클래스를 갖습니다. 다음 CSS 스타일을 추가하면 얼룩말 교차를 볼 수 있습니다.
<style type="text/css"> .odd { background-color: #BDF; } </style>
Jinja2의 루프 내장 변수에는 주로 다음이 포함됩니다.
1 2 3 4 5 6 7 8 9 10 11 12 |
from flask import Flask, render_template
앱 = 플라스크(__name__)
@앱.경로('/hello') @앱.경로(' /hello/8a11bc632ea32a57b3e3693c7987c420') def hello(이름=없음): 반환 render_template('hello.html', 이름=이름)
if __name__ == '__main__': 앱.실행(디버그=맞다) |
另外,如果你启用了”jinja2.ext.loopcontrols”扩展的话,你还可以在循环中使用”{% break %}”和”{% continue %}”来控制循环执行。
其它常用语句:
忽略模板语法
有时候,我们在页面上就是要显示”{{ }}”这样的符号怎么办?Jinja2提供了”raw”语句来忽略所有模板语法。
{% raw %} <ul> {% for item in items %} <li>{{ item }}</li> {% endfor %} </ul> {% endraw %}
自动转义
我们将本文一开始的Flask代码”hello()”方法改动下:
@app.route('/hello') @app.route('/hello/<name>') def hello(name=None): if name is None: name = '<em>World</em>' return render_template('hello.html', name=name)
此时,访问”http://www.php.cn/:5000/hello”,页面上会显示”Welcome 907fae80ddef53131f3292ee4f81644bWorldd1c6776b927dc33c5d9114750b586338!”,也就是这个HTML标签”907fae80ddef53131f3292ee4f81644b”被自动转义了。Flask会对”.html”, “.htm”, “.xml”, “.xhtml”这四种类型的模板文件开启HTML格式自动转义。这样也可以防止HTML语法注入。如果我们不想被转义怎么办?
{% autoescape false %} <h1>Hello {{ name }}!</h1> {% endautoescape %}
将”autoescape”开关设为”false”即可,反之,设为”true”即开启自动转义。使用”autoescape”开关前要启用”jinja2.ext.autoescape”扩展,在Flask框架中,这个扩展默认已启用。
赋值
使用”set”关键字给变量赋值:
{% set items = [[1,2],[3,4,5]] %}
with语句
类似于Python中的”with”关键字,它可以限制with语句块内对象的作用域:
{% with foo = 1 %} {% set bar = 2 %} {{ foo + bar }} {% endwith %} {# foo and bar are not visible here #}
使用”with”关键字前要启用”jinja2.ext.with_”扩展,在Flask框架中,这个扩展默认已启用。
执行表达式
{% with arr = ['Sunny'] %} {{ arr.append('Rainy') }} {{ arr }} {% endwith %}
看上面这段代码,我们想执行列表的”append”操作,这时使用”{{ arr.append(‘Rainy') }}”页面会输出”None”,换成”{% %}”来执行,程序会报错,因为这是个表达式,不是语句。那怎么办?我们可以启用”jinja2.ext.do”扩展。然后在模板中执行”do”语句即可:
{% with arr = ['Sunny'] %} {% do arr.append('Rainy') %} {{ arr }} {% endwith %}
上下文环境
Flask每个请求都有生命周期,在生命周期内请求有其上下文环境Request Context。作为在请求中渲染的模板,自然也在请求的生命周期内,所以Flask应用中的模板可以使用到请求上下文中的环境变量,及一些辅助函数。本文就会介绍下这些变量和函数。
标准上下文变量和函数
请求对象request
request对象可以用来获取请求的方法”request.method”,表单”request.form”,请求的参数”request.args”,请求地址”request.url”等。它本身是一个字典。在模板中,你一样可以获取这些内容,只要用表达式符号”{{ }}”括起来即可。
<p>{{ request.url }}</p>
在没有请求上下文的环境中,这个对象不可用。
会话对象session
session对象可以用来获取当前会话中保存的状态,它本身是一个字典。在模板中,你可以用表达式符号”{{ }}”来获取这个对象。
Flask代码如下,别忘了设置会话密钥哦:
@app.route('/') def index(): session['user'] = 'guest' return render_template('hello.html') app.secret_key = '123456'
模板代码:
<p>User: {{ session.user }}</p>
在没有请求上下文的环境中,这个对象不可用。
全局对象g
全局变量g,用来保存请求中会用到全局内容,比如数据库连接。模板中也可以访问。
Flask代码:
@app.route('/') def index(): g.db = 'mysql' return render_template('hello.html')
模板代码:
<p>DB: {{ g.db }}</p>
g对象是保存在应用上下文环境中的,也只在一个请求生命周期内有效。在没有应用上下文的环境中,这个对象不可用。
Flask配置对象config
导入的配置信息,就保存在”app.config”对象中。这个配置对象在模板中也可以访问。
<p>Host: {{ config.DEBUG }}</p>
“config”是全局对象,离开了请求生命周期也可以访问。
url_for()函数
url_for()函数可以用来快速获取及构建URL,Flask也将此函数引入到了模板中,比如下面的代码,就可以获取静态目录下的”style.css”文件。
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
该函数是全局的,离开了请求生命周期也可以调用。
get_flashed_messages()函数
get_flashed_messages()函数是用来获取消息闪现的。这也是一个全局可使用的函数。
自定义上下文变量和函数
自定义变量
除了Flask提供的标准上下文变量和函数,我们还可以自己定义。下面我们就来先定义一个上下文变量,在Flask应用代码中,加入下面的函数:
from flask import current_app @app.context_processor def appinfo(): return dict(appname=current_app.name)
函数返回的是一个字典,里面有一个属性”appname”,值为当前应用的名称。我们曾经介绍过,这里的”current_app”对象是一个定义在应用上下文中的代理。函数用”@app.context_processor”装饰器修饰,它是一个上下文处理器,它的作用是在模板被渲染前运行其所修饰的函数,并将函数返回的字典导入到模板上下文环境中,与模板上下文合并。然后,在模板中”appname”就如同上节介绍的”request”, “session”一样,成为了可访问的上下文对象。我们可以在模板中将其输出:
<p>Current App is: {{ appname }}</p>
自定义函数
同理我们可以自定义上下文函数,只需将上例中返回字典的属性指向一个函数即可,下面我们就来定义一个上下文函数来获取系统当前时间:
import time @app.context_processor def get_current_time(): def get_time(timeFormat="%b %d, %Y - %H:%M:%S"): return time.strftime(timeFormat) return dict(current_time=get_time)
我们可以试下在模板中将其输出:
<p>Current Time is: {{ current_time() }}</p> <p>Current Day is: {{ current_time("%Y-%m-%d") }}</p>
上下文处理器可以修饰多个函数,也就是我们可以定义多个上下文环境变量和函数。
完整实例:
flask代码:
from flask import Flask, render_template, session, g, current_app import time app = Flask(__name__) @app.route('/') def index(): session['user'] = 'guest' g.db = 'mysql' return render_template('hello-2.html') @app.context_processor def appinfo(): return dict(appname=current_app.name) @app.context_processor def get_current_time(): def get_time(timeFormat="%b %d, %Y - %H:%M:%S"): return time.strftime(timeFormat) return dict(current_time=get_time) app.secret_key = '123456' if __name__ == '__main__': app.run(debug=True)
模板代码:
Hello Sample <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">Hello World!
Request URL: {{ request.url }}
<p>User: {{ session.user }}</p> <p>DB: {{ g.db }}</p> <p>Host: {{ config.DEBUG }}</p> <p>Current App is: {{ appname }}</p> <p>Current Time is: {{ current_time() }}</p> <p>Current Day is: {{ current_time("%Y-%m-%d") }}</p> {% with messages = get_flashed_messages() %} {% if messages %} {% for message in messages %} Flash Message: {{ message }} {% endfor %} {% endif %} {% endwith %}
更多Python的Flask框架中的Jinja2模板引擎相关文章请关注PHP中文网!