Python Flask 프레임워크의 표준 템플릿 엔진인 Jinja2 사용에 대한 튜토리얼
- WBOY원래의
- 2016-08-04 08:55:461610검색
Jinja2에는 Python 2.4 이상이 필요합니다.
설치
Jinja를 팔로우하는 방법은 여러 가지가 있으며, 필요에 따라 다양한 팔로우 방법을 선택할 수 있습니다.
easy_install 또는 pip 사용:
#sudo easy_install Jinja2 #sudo pip install Jinja2
tarball에서 설치:
# 下载Jinja的安装包 # 解压缩 # sudo python setup.py install
기본 API 사용법
Jinja로 템플릿을 만드는 가장 쉬운 방법은 템플릿을 이용하는 것입니다. 그러나 실제 애플리케이션에서는 이 사용을 권장하지 않습니다.
<pre class="brush:php;toolbar:false">
>>> from Jinja2 import Template
>>> template = Template('Hello {{ name }}!')
>>> template.render(name='World')
u'Hello World!'
이 예에서는 문자열을 템플릿 콘텐츠로 사용하여 템플릿 인스턴스를 생성한 다음 "name='World'"를 매개변수로 사용하여 "렌더링 메서드"를 호출하고 콘텐츠의 'name'을 "World"로 대체합니다. 마지막으로 렌더링된 문자열인 "u'Hello World!'"
를 반환합니다.
구분 기호에는 두 가지 종류가 있습니다. {% raw %}{% ... %}{% endraw %} 및 {% raw %}{{ ... }}{% endraw %}. 첫 번째는 for 루프나 할당과 같은 명령문을 수행하는 데 사용되며, 후자는 표현식 결과를 템플릿에 출력하는 데 사용됩니다.
템플릿 정리 방법
그럼 템플릿은 우리 애플리케이션에 어떻게 적합할까요? Flask에 관심을 가져왔다면 Flask가 매우 유연하고 내용에 특별한 제한을 두지 않는다는 점을 눈치챘을 것입니다. 템플릿도 예외는 아닙니다. 또한 일반적으로 물건을 넣을 권장 장소(예: 템플릿)가 있다는 것을 알 수 있습니다. 템플릿의 경우 해당 위치는 패키지 디렉터리에 있습니다.
myapp/
__init__.py
models.py
views/
templates/
static/
run.py
requirements.txt
templates/
layout.html
index.html
about.html
profile/
layout.html
index.html
photos.html
admin/
layout.html
index.html
analytics.html
템플릿 디렉터리의 구조는 라우팅 구조와 유사합니다. myapp.com/admin/analytics 경로의 경우 템플릿은 template/admin/analytics.html입니다. 디렉토리에는 직접 렌더링되지 않는 몇 가지 추가 템플릿이 있습니다. 레이아웃.html 파일은 다른 템플릿이 상속하기 위한 것입니다.
상속
배트맨의 배경 이야기와 마찬가지로 잘 구성된 템플릿 디렉토리는 상속에 크게 의존합니다. 상위 템플릿은 일반적으로 모든 하위 템플릿이 상속받을 수 있는 공통 구조를 정의합니다. 이 예에서 레이아웃.html은 상위 템플릿이고 다른 .html 파일은 하위 템플릿입니다.
일반적으로 애플리케이션의 일반 레이아웃과 웹 사이트의 모든 부분을 정의하는 최상위 레이아웃.html이 있습니다. 위의 디렉터리를 보면 최상위 myapp/templates/layout.html과 myapp/templates/profile/layout.html 및 myapp/templates/admin/layout.html이 표시됩니다. 마지막 두 파일은 첫 번째 파일을 상속하고 수정합니다.
{# _myapp/templates/layout.html_ #}
<!DOCTYPE html>
<html lang="en">
<head>
<title>{% raw %}{% block title %}{% endblock %}{% endraw %}</title>
</head>
<body>
{% block body %}
<h1>This heading is defined in the parent.</h1>
{% endblock %}
</body>
</html>
하위 템플릿에서는 상위 템플릿을 확장하고 이러한 블록의 내용을 정의할 수 있습니다.
{# _myapp/templates/index.html_ #}
{% extends "layout.html" %}
{% block title %}Hello world!{% endblock %}
{% block body %}
{{ super() }}
<h2>This heading is defined in the child.</h2>
{% endblock %}
super() 함수를 사용하면 상위 블록의 내용을 렌더링할 수 있습니다.
매크로 생성
반복되는 코드 조각을 매크로로 추상화하여 템플릿에서 DRY(Don't Repeat Yourself) 원칙을 고수할 수 있습니다. 애플리케이션 내 탐색을 위한 HTML 작업을 하고 있다면 클래스(class="active")에 "active" 링크를 제공해야 합니다. 매크로가 없으면 활성 링크를 찾기 위해 각 링크를 확인하는 if...else 문을 여러 개 작성해야 합니다.
매크로는 코드를 모듈화하는 방법을 제공합니다. 함수처럼 작동합니다. 매크로를 사용하여 활성 링크를 표시하는 방법을 살펴보겠습니다.
{# myapp/templates/layout.html #}
{% from "macros.html" import nav_link with context %}
<!DOCTYPE html>
<html lang="en">
<head>
{% block head %}
<title>My application</title>
{% endblock %}
</head>
<body>
<ul class="nav-list">
{{ nav_link('home', 'Home') }}
{{ nav_link('about', 'About') }}
{{ nav_link('contact', 'Get in touch') }}
</ul>
{% block body %}
{% endblock %}
</body>
</html>
이제 이 템플릿에서 해야 할 일은 정의되지 않은 매크로(nav_link)를 호출하고 대상 엔드포인트(예: 대상 뷰의 함수 이름)와 표시하려는 텍스트라는 두 개의 매개변수를 전달하는 것뿐입니다.
우리가 context와 함께 지정한 import 문에서 알 수 있습니다. Jinja의 컨텍스트는 render_template() 함수에 전달된 매개변수와 Python 코드의 Jinja 환경 컨텍스트로 구성됩니다. 템플릿의 경우 템플릿이 렌더링될 때 이러한 변수를 사용할 수 있습니다.
render_template("index.html", color="red")와 같은 일부 변수는 분명히 우리에 의해 전달되지만 request, g와 같이 Flask에 의해 컨텍스트에 자동으로 포함되는 변수 및 함수도 있습니다. 그리고 세션. {% raw %}{% from ... import ... with context %}{% endraw %}라고 말하면 이러한 변수를 매크로에서도 사용할 수 있음을 Jinja에게 알립니다.
이제 템플릿에 사용되는 nav_link 매크로를 정의할 차례입니다.
{# myapp/templates/macros.html #}
{% macro nav_link(endpoint, text) %}
{% if request.endpoint.endswith(endpoint) %}
<li class="active"><a href="{{ url_for(endpoint) }}">{{text}}</a></li>
{% else %}
<li><a href="{{ url_for(endpoint) }}">{{text}}</a></li>
{% endif %}
{% endmacro %}
이제 myapp/templates/macros.html에 매크로가 정의되어 있습니다. 이 매크로에서는 Flask의 요청 개체(Jinja 컨텍스트에서 기본적으로 사용 가능)를 사용하여 nav_link에 전달된 경로의 끝점이 현재 요청인지 확인합니다. 그렇다면 현재 페이지에 있는 것이므로 활성 페이지로 표시합니다.
import y from x 문은 x에 대한 상대 경로를 사용합니다. 템플릿이 myapp/templates/user/blog.html인 경우 "../macros.html"을 사용하여 nav_link를 가져올 수 있습니다.
自定义过滤器
Jinja 过滤器是一个函数，它能够在 {% raw %}{{ ... }}{% endraw %} 中用于处理一个表达式的结果。在表达式结果输出到模板之前它就被调用。
<h2>{{ article.title|title }}</h2>
在这段代码中，title 过滤器接收 article.title 作为参数并且返回一个过滤后的标题，接着过滤后的标题将会输出到模板中。这就像 UNIX 的“管道化”一个程序到另一个程序的输出。
有很多像 title 一样的内置过滤器。请参阅 Jinja 文档中的 完整列表。
我们可以在我们的 Jinja 模板中定义自己的过滤器供使用。举例来说，我们将会实现一个简单 caps 过滤器用来大写一个字符串中所有的字母。
Jinja 已经有一个 upper 过滤器来做这样的事情，并且还有一个 capitalize 过滤器，它能用来大写第一个字母，小写其余的字母。这些也能处理 unicode 转换，但是我们会继续我们的示例，让大家目前能够知道如何自定义过滤器。
我们要在 myapp/util/filters.py 中定义我们的过滤器。这里给出一个 util 包，它里面有各种各样的模块。
# myapp/util/filters.py from .. import app @app.template_filter() def caps(text): """Convert a string to all caps.""" return text.uppercase()
在这段代码中我们使用 @app.template_filter() 装饰器注册我们的函数成一个 Jinja 过滤器。默认的过滤器名称就是函数的名称，但是你可以传入一个参数到装饰器中来改变它。
@app.template_filter('make_caps')
def caps(text):
"""Convert a string to all caps."""
return text.uppercase()
现在我们可以在模板中调用 make_caps 而不是 {% raw %}caps：{{ "hello world!"|make_caps }}{% endraw %}。
为了要让我们的过滤器在模板中可用的话，我们只需要在我们的顶层 \\_init.py\\_ 的中导入它。
# myapp/__init__.py # Make sure app has been initialized first to prevent circular imports. from .util import filters