命令行命令说明
Tag库(0.5)

模板(Template)

0.4 版本说明

更新说明

从0.4版本开始，uliweb的模板由原来的 web2py 的基础上改造来的，改为基于 tornado 的模板系统。当然 tornado的模板用法与uliweb的还是有不少差异，因此在它的源码上进行了修改。新的模板最大的变化主要是生成 过程，原来uliweb的模板解析与生成是一体化的，所以速度慢。在使用了 wheezy.web 提供的性能测试代码比较 之后非常明显。通过学习tornado等其它的模板示例，发现，它们之所以快，就是因为模板的解析与生成是分离的， 所以解析的时间在根本没有计算，只计算了生成的代码执行的时间，所以当然快了。不过我也没有直接把原来的uliweb 的模板改造成解析与执行分离的模式（其实也是可以做到的），而是基于tornado进行了改造。并且象tornado的模板 会带有一个Loader的类，用来装载模板，还可以实现模板的缓存。不过tornado的缓存机制当文件发生变化时不能 自动更新，要重启服务器。而我改造之后，实现了对依赖文件的时间变化的检查，从而自动更新缓存。当然，也可以 通过配置来关掉自动检查或缓存的机制。实现了解析与执行的分离还有一个好处就是可以在命令行下直接打印出模板 编译后的python代码，非常方便。

不兼容部分说明：

  1. {{super}} 功能取消
  2. extend include 后面不能使用变量，只能是字符串
  3. {{=}} {{<<}} 后面的 = 和 << 前面不能有空格
  4. out 对象消失，但是为了兼容仍然可能使用 out.write 和 out.xml ，不过建议改为： out_write 和 out_write(escape(x)) 的形式
  5. 自定义 tag 实现进行了调整， use link 作为内置的机制，但是具体的处理还是要通过 template APP 来支持。
  6. template_plugins 中的 call 函数不再传入 app, var, env 变量，因此将不能对这些对象进行修改。但 目前还是兼容了以前的用法
  7. 根据新的 tag 定义的要求重新编写了 rbac APP 中的 role 和 permission tag

对 tornado 模板的改造(不能说我的改造就是合理的，但是一是为了兼容，二是为了让用户迁移到新的模板上时代价小)：

  1. 实现了对缓存的模板进行依赖检查的功能，如extend, include的其它模板文件的变化，会重新刷新变化的模板及被依赖 的模板。原tornado则没有这个机制。
  2. 缓存使用了简单的 LRU 算法，并且可以控制个数，以避免内存占用过多
  3. 实现了多行解析，及缩近重排。tornado主要以单行python代码解析为主，所以多行python代码解析上是有问题的。 uliweb的新模板为了兼容，实现了多行与单行的同时支持，缺省启用多行模式，它会在最后对代码的缩近进行重新 处理
  4. 实现了对 def 块的支持
  5. 去除了一些与uliweb不同的功能，如：import , from, raw 等标签的解析

迁移模板到0.4的建议

虽然升级到 0.4 已经尽量做到向前兼容，但是还是会存在原来的模板在升级之后执行出错的问题，下面是建议的方法：

  1. 在0.4中添加了 validatetemplate 命令，可以用来对 模板进行语法检查，比如下面是实际运行的一个例子(因为太长，输出上稍微做了点加工)：

    FAILED .../RiskPointView/list.html 'return' outside function (list.html, line 585)
FAILED .../GenericView/add.html Can't find template layout.
FAILED .../timeglider.html Missing {{ end }} block for block on line .../timeglider.html:86
FAILED .../TaskInfo/addnontsk.html Empty block tag ({{ }}) on line .../TaskInfo/addnontsk.html:55
FAILED .../WorkorderView/view.html Can't find template workload_layout.html.

    如果模板编译不正确，会抛出错误。

  2. 根据出错文件及提示进行错误的修复。分别针对上面的5种错误类型进行分析(可能还有其它的错误)：

    • 对于错误1，多半是由于缩近不正确，如：过多的 {{pass}} 。所以可以打印出模板编译后的源码进行分析：

      uliweb find -t templateilfe --source

      也可以再添加 --comment 查看更详细的源码信息。

      根据 Python 的语法来查找缩近不正确的位置，从而进行问题修复。

    • 对于错误2，因为在0.4之前， extend 和 include 后面的模板名可以是变量，在0.4中取消这一功能，目的是为了实现 编译和执行分离，从而提高效率。而这里正好使用的是变量，所以要改为真正的模板文件名字符串。

      同时 0.4 中对于动态添加父模板也有了一定的支持(include 还是不支持变量)，比如在调用 template_file(template, vars) 时 可以传入 layout="xxxx" 的参数。这样，如果 template 本身在开头没有写 {{extend "xxx"}} 的标签，会 自动向 template 的头添加 {{extend "xxx"}} 的文本，并进行编译，从而实现动态修改父模板的功能。如果 template 已经包含了 {{extend}} 的信息，则 layout 参数将不会生效。

      因此 0.4 是通过动态生成模板内容的方式来实现对动态模板继承的支持。

    • 对于错误3，这是因为 {{block}} 之类的块标签没有写结束的 {{end}} 造成了，补充上就可以的。
    • 对于错误4，0.4中不再允许有空的标签，删除即可。
    • 对于错误5，引用的外部模板不存在，请检查是不是这个模板已经过时或父模板丢失。

特点

  • 简单，易学
  • 可以嵌入Python代码
  • 不用过分关心Python代码的缩近，只要注意块结束时加pass，模板会自动对缩近进行重排
  • Python代码与HTML可以交叉使用
  • 支持模板的继承
  • 支持类django的block的功能
  • 提供一些方便的内置方法
  • 支持环境的扩展(可以扩展可以直接在模板中使用的对象和方法)
  • 先编译成Python代码，然后再执行

基本语法

Uliweb的模板的语法很简单，只有以下几种类型的标记：

  • {{= result}} 这是用来输出的标记。其中result可以是变量也可以是一个函数调用，它会自动对输出的内容进行转义
  • {{<< result}} 这是用来输出非转义的内容，与上面相反。
  • {{ ... }} 只使用{{}}的话表示里面为Python代码，可以是任何的Python代码，如： import之类的。如果是块语句，需要在块结束时使用pass。
  • {{extend "template"}} 其中template必需用引号引起来，表示字符串。
  • {{include "template"}} 其中template必需用引号引起来，表示字符串。
  • {{block blockname}}{{end}} 用于定义一个块。在子模板中，对于要覆盖的block需要进行定义，则生成的结果将用子模板中的block定义替换父模板的。
  • {{super}} 0.4中不再支持。
  • {{# ... }} 单行注释

  • {{## ... ##}} 片段注释。其中可以包含模板标签。(0.1.6増加) 如:

    {{##
{{=name}}
##}}
  • #uliweb-template-tag:begin,end 单独占一行，并且要写在最开始化，用来定义模板中的标签字符串，如，把 begin 和end改为 {% %}
  • out_write 用于在模板代码片段中输出文本，如果是在HTML片段中可以使用 {{=}} 或 {{<<}} 来输出。 此函数缺省不转义，如果要输出转换字符串，可以 out_write(escape(x))

模板环境

Uliweb的模板在运行时也象view一样会运行在一个环境中，在这个环境中，有一些对象和方法是在内置环境中定义的， 也有一些是在Uliweb的框架环境中定义的对象或方法。内置的环境你无法扩展，但是框架环境允许你扩展，方法很象 view的扩展方式，如在任何一个有效的app的settings.py中可以定义:

def prepare_template_env(sender, env):
    from uliweb.utils.textconvert import text2html
    env['text2html'] = text2html

然后在 settings.ini 中进行配置：

[BINDS]
yourapp.prepare_default_env = 'prepare_default_env', 'yourapp.prepare_default_env'

经过上面的处理，你就可以直接在模板中使用text2html这个方法了。

上面的 yourapp.prepare_default_env 是用来定义一个名字，主要目的是可以方便替换。 prepare_default_env 是对应的信号名，表示准备环境变量的信号。 yourapp.prepare_default_env 是上面方法的路径。

目前已经有一些缺省的对象和方法可以直接用在模板中，它们目前与view是一样的，因此你可以参考 视图 文档进行了解。

内置环境

Uliweb的模板本身已经定义了一些方法可以直接使用。

  • escape() 可以用来转换HTML的特殊符号，主要是 <>& 。
  • out_write() 在代码片段中向模板输出内容

编码

模板缺省是使用utf-8编码进行处理。如果你传入unicode字符串，将自动转为utf-8编码。如果不 是unicode，则不做处理。建议全部使用utf-8编码。

模板标签的设置

缺省情况下， Uliweb的模板使用 {{ 和 }} 来包括模板变量及模板中的语句，但是在特殊情况下，可能与某些 JS框架的标签冲突，所以可以在模板中动态设置，如：

#uliweb-template-tag:[[,]]

它采用注释的方式，需要写在第一行开头。表示使用 [[ 和 ]] 作为模板的标签。

这种设置方法只影响当前模板，对于 extend 和 include 的模板不会影响。

参数配置

在Uliweb中使用模板时有一些配置项可以在配置文件中进行覆盖，缺省定义的配置参数为：

[TEMPLATE]
namespace = {}
cache = True
use_tmp = False
tmp_dir = 'tmp/templates_temp'
begin_tag = '{{'
end_tag = '}}'
debug = False
check_modified_time = True
multilines = True

分别解释如下：

namespace

用于定义预设在模板中可以使用的对象，目前没有太多应用。

cache, check_modified_time

是否启用模板对象缓存。缺省是启用。使用模板缓存时，模板会先检查是否当前模板已经在缓存中存在，如果存在，则 不再进行模板的编译处理，否则进行编译并保存在缓存中。在检查时，还会用到 check_modified_time 。即 缓存有两种模式，一种是只编译一次，如果以后手工修改了模板也不再检查，适合于性能要求高的场合。另一种是每次 都检查模板文件的修改时间是否有变化，如果这个模板文件还使用了 extend 或 include 则还要检查相关的 其它的模板文件，如果有变化，则重新编译。它会比前一种稍慢，但是修改模板后就会生效，比较方便。如果设置为 False，则表示不缓存模板，模板每次都会编译，效率低。请注意使用。使用缓存会占用内存空间。

use_tmp

是否将编译后的模板生成的 python 源码保存在临时目录下。目前没有实现。

tmp_dir

与 use_tmp 联用，但目前没有实现。

begin_tag, end_tag

模板标签字符串，缺省为 {{ 和 }} 。不建议进行修改，可以参照上面在模板标签的设置方法进行处理。

debug

是否启用模板调试，建议只在开发状态下使用。缺省为False。它是一个内部参数，在调试状态下时，它会用 GLOBAL/DEBUG_TEMPLATE 来进行赋值，详情参见下面的模板的块调试说明。

multilines

原来的tornado的模板不支持多行的Python代码行，在改造后对其实现了支持，缺省为启用。如果不想使用，可以设为 False。但是要注意功能的兼容性。

用法

简单地变量输出

{{= "hello"}}
{{= title}}

如果使用了变量，则要么由view进行传入，要么在模板的其它地方进行定义，如：

{{title="hello"}}
{{= title}}

HTML代码直接输出

{{<< html}}

Python代码示例

{{import os
out_write("<h1>Hello</h1>")
}}

模板继承

父模板 (layout.html)

<html>
<head>
<title>Title</title>
</head>
<body>
{{block main}}{{end}}
</body>
</html>

子模板 (index.html)

{{extend "layout.html"}}
{{block main}}
<p>This is child template.</p>
{{end}}

包括其它的模板

<html>
<head>
<title>Title</title>
</head>
<body>
{{include "child.html"}}
</body>
</html>

子模板的特殊说明

子模板要求从某个父模板来继承( {{extend "layout.html"}} )，在其中除 extend 外，主要是用来覆盖父模板中 的 block ，同时它支持将 block 定义在 include 模板中，如：

{{extend "layout.html"}}
{{include "inc_block.html"}}

其中在 inc_block.html 中覆盖了 layout.html 中定义的块。

模板注释

{{# This is a comment line}}
{{# This is another comment line}}

可以在每行模板代码前使用 # 标识当前行为注释行，其用法同 Python 的注释行

{{##
{{=name}}
##}}

使用 {{## 和 ##}} 可以注释一个片段，其中可以含有模板标签，这些标签将被 忽略。

模板自引用(0.1.4)

假设我们有一个全局性的 layout.html 模板，许多模板都要从它继承以获得最基础的布局信 息等。如果，我们有一个优化要在全局生效，那么我们可能直接想到去修改 layout.html 模板，这的确是一个办法。但是如果这个 layout.html 是一个可以复用的公共模板，它可 能不由你来维护或者它的实现比较通用，如果对其修改会造成不通用，那么直接修改这个 模板可能不是一个好办法。在0.1.4版本中提供了对同名模板的自引用处理机制，它可以用 在 extend 和 include 中。Uliweb 在处理模板时会根据App的定义顺序来查找模 板。因为模板是定义在不同的app中，因此会有同名模板出现。同时这也正是Uliweb中模板 替換的机制。因此，针对上面的问题，我们可能想在自已的App中定义一个同名的模板，但是 这样只会替換原来的模板。因此我们其实需要的是可以从同名模板的上一个模板继承的机制。 例如：A, B两个App，B定义在A之后，它们都有一个同名的layout.html模板，所以在模板 搜索时，会先找到B/layout.html。在0.1.4中，如果我们在B的layout.html中输入:

{{extend "layout.html"}}

即和自身的名字相同，在这种情况下，Uliweb会使用A/layout.html作为父模板来继承。这 样，我们就可以象正确的模板继承一样对同名的模板实现继承的处理了。

{{include}} 模板时，对应的模板也可以有类似的处理机制。

模板的块调试(0.2.2)

Uliweb的模板在结构变得复杂时，了解哪些块是在哪里定义的就变成比较困难的问题。uliweb 提供命令行和运行时对块信息的调试输出。在命令行可以：

uliweb find -t index.html --tree --blocks --with-filename

可以输出指定模板的继承和包含使用情况。还可以输出其中使用到的block定义，包括每个block 所在的模板文件名。

在运行时，可以打开：

[GLOBAL]
DEBUG = True
DEBUG_TEMPLATE = True

注意， DEBUG 同时要设置为True。建议设置在 local_settings.ini 中。这样输出的页面就会有类似：

<!-- BLOCK title (apps/theme/templates/theme/skeleton.html) -->
<!-- END title -->

这样的输出。不过要注意只用它来进行调试，不然有些地方可能会破块页面或其它非HTML 输出的正确性。

uliweb.contrib.template App

Uliweb为了方便使用，同时还提供了 uliweb.contrib.template 这个app，具体的功能描述见 uliweb.contrib.template 。

命令行

在 命令行 的文档中有详细的关于模板相关的操作，主要是集中在 find -t template_file 中，再配合以不同的 参数。

问题描述

在模板中定义多行文本的限制

目前模板中不特别支持定义多行的字符串，因为它是按行来处理，并且不作特殊的语法判断的。 比如:

{{t = """
<html>
<head>
<script>
if tag == 'a':

</script>
"""}}

因为其中有 if 语句，所以会被模板识别为Python的 if 语句，会造成后面的代 码缩近而产生问题。因此如果多行字符串存在特殊的 if, for 之类的会引发 缩近的关键字时，可能会引发问题。

变量定义

新的实现方式是通过定义一个内部函数，所以外部传入的变量将作为全局变量来使用。但这样的话，如果在函数内部 你向一个与传入变量名同名的变量赋值，做造成提示局部变量在被定义前使用。类似于下面的代码：

a = 1
def f():
    b = a
    a = 3

在执行f()时会抛出： UnboundLocalError: local variable 'a' referenced before assignment 所以为避免这种错误，模板中出现的赋值不要与传入的变量名相同。同时导入模块也存在类似的问题。

命令行命令说明
Tag库(0.5)