大数跨境

Jinja模板入门

Jinja模板入门 Python程序员
2017-02-07
0
导读:对于之前没有接触过模板语言的人来说,这样的语言本质上包括一些变量和编程逻辑,并在被解释(或渲染成HTML)时被真实值替换。这些变量和/或逻辑被放在标签或定界符之间。

Python部落(python.freelycode.com)组织翻译,禁止转载,欢迎转发。

Flask和强大的Jinja模板语言一起打包发布。

如果你需要文章中的链接,请看:https://python.freelycode.com/contribution/detail/629

对于之前没有接触过模板语言的人来说,这样的语言本质上包括一些变量和编程逻辑,并在被解释(或渲染成HTML)时被真实值替换。这些变量和/或逻辑被放在标签或定界符之间。比如,Jinja模板使用 {% ... %} 来放置表达式或逻辑(比如循环),而 {{ ... }} 被用来向最终用户输出表达式或变量的结果。后面这个标签再被渲染时被一个或多个值替换,并展示给用户。

Jinja模板只是HTML文件。一般放在Flask项目的“/templates”目录里。如果你熟悉字符串格式化或插入的话,模板语言也是类似的逻辑——只是扩大到了整个HTML页面。

快速示例

确保在运行这些示例之前已安装Jinja——pip install jinja2

注意向用户渲染的实际输出落在标签之间。

Flask示例

代码可以在这里找到。

创建如下项目结构:

激活一个virtualenv,然后安装flask:

向 run.py 添加下面的代码:

这里我们建立路径 / ,它会通过函数 render_template() 来渲染模板 template.html。这个函数必须有一个模板名。你还可以向模板传入关键字参数,像示例中一样——my_string 和 my_list。

添加模板:

将其在templates目录内存为 template.html。注意模板标签。你能在运行程序之前猜到输出结果吗?

运行:

你应该看到:

值得注意的时Jinja只支持少量的控制结构—— if 语句和 for 循环是两个主要的结构。其语法和Python类似,不同的是不需要冒号,并且代码块的结尾用 endif 和 endfor 代替了空白符。你也可以在你的控制器和视图里完成逻辑再用模板标签把每个值传递给模板。然而,在模板本身完成这样的逻辑往往更简单。

模板继承

模板往往会利用继承,它包括一个定义了随后所有子模板基本结构的基模板。你可以用标签 {% extends %} 和 {% block %} 实现继承。

使用情况很简单:随着你的应用程序的增长,你持续添加新的模板,你需要保持公共代码(比如说HTML的导航栏,Javascript类库,CSS样式等)的同步,这会是个大工程。使用了继承,我们可以把那些公共的部分移动到基模板,这样一来我们创建或编辑这样的代码一次,所有的子模板都会继承这个代码。

你应该尽可能地把重复的代码添加至基模板以节省你未来的时间,这远远比最初的时间投入有价值。

让我们向示例中添加继承。

创建基(父)模板:

将其保存为 layout.html。

你注意到标签 {% block %} 了吗?这定义了一个子模板可以填入的块(或区域)。将来,这会通知模板引擎一个子模板可能会覆写这个模板的块。

把这些想象成会被子模板代码填充的占位符。

让我们开始吧。

更新 template.html:

所以,{% extends %} 标签通知模板引擎这个模板“拓展了”另一个模板,layout.html。换句话说,这在模板之间建立链接。

运行之。你应该看到:

一个普遍使用的情况就是添加一个导航栏。

再在基模板的 <body> 标签下添加下面的代码:

现在所有从基模板延伸的子模板都会有同样的导航栏。从Java哲学拿来的话:“编写一次,到处运行”。

超级块

如果你需要从基模板渲染一个块,使用超级块:

在基模板添加一个页脚:

更新后的代码:

运行程序。你可以看到页脚成了基模板的一部分:

现在,向 template.html 添加超级块:

在浏览器里检查:

超级块用于基模板和子模板都共享的公共代码,比如说 <title> ,两个模板都共享标题的一部分,你只需要传入另一部分。heading也一样。

比如:

基模板

子模板

再来看看:

看看从子模板移除 {% block page %}Home{% endblock %} 会发生什么。

挑战:试试加上超级块用同样的方法更新 <title>。需要的话就查看的我的代码。

除了硬编码模板名,让我们把它变成动态的。

在 template.html 里更新这两个代码片段:

和

现在我们需要在控制器 run.py 里向我们的模板传入一个 title 变量。

测试。

宏

Jinja中,我们可以用宏去抽象被反复使用的公共代码片段以免作无用功。比如,在导航栏高亮最近页面的链接(活动链接)很普遍。此外,我们需要用 if/elif/else 语句来决定活动链接。使用了宏,我们可以把这样的代码抽象到一个单独的文件。

在“templates”目录里添加一个 macros.html 文件:

这里我们使用Flask的请求对象——它默认是Jinja的一部分,来检查请求的端点,再给那个端点指派 active 类。

再基模板中用 nav navbar-nav 类更新无序列表:

还有,确保再模板顶部添加import:{% from "macros.html" import nav_link with context %}。

注意我们怎样调用 nav-link 宏和向其传进两个参数的——端点(来自我们的控制器)和我们想显示的文本。

最后,向控制器添加三个新的端点:

刷新页面。看看顶部的链接。最近的页面被高亮了吗?

自定义过滤器

Jinja使用过滤器来更改变量,大多数情况用于格式化。

比如:

这会将 num 变量四舍五入。所以如果我们将参数 num=46.99 传给模板,就会输出 47.0。

所以说,你指定一个变量,然后是管道符(|),再跟上一个过滤器。在这里查看Jinja已包括的过滤器。有的情况下,你可以在括号里指定可选的参数。

例如:

这会加入一个由逗号分隔的列表。

检验一下。把下行添进 template.html

现在,除了内置的过滤器,我们还可以构建自己的。

来添加一个我们自己的过滤器。常见的例子就是一个自定义日期时间过滤器。

将下面的代码添加到控制器里 app = Flask(__name__) 的后面:

我们用 @app.template_filter() 装饰器把 datetimefilter() 函数注册为一个过滤器。

装饰器默认的名字就是函数的名字;当然你也可以自定义:向函数传入一个参数——比如: @app.template_filter(formatdate)。

接下来,我们将这个过滤器加入到Jinja环境中,使其可访问。现在就可以用了。

将以下代码加到子模板:

最后,向我们的模板传入日期时间:

测试。

总结

一切就是这样。源码在这里。


英文原文:https://realpython.com/blog/python/primer-on-jinja-templating/
译者:♂GHOST NINJA⊕


【声明】内容源于网络
0
0
Python程序员
1234
内容 2525
粉丝 0
Python程序员 1234
总阅读0
粉丝0
内容2.5k