Odoo 13开发者文档：QWeb

本文来自Odoo 13官方文档之开发者文档系列文章

以上会产生的结果：

如 condition为 true, 但使用：

会产生如下结果：

数据输出

QWeb有一个主输出指令，它自动对其内容进行HTML转义，来在显示用户所提供的内容时降低 XSS 风险： esc.

esc 接收一个表达式，运行它并打印出内容：

通过将value 设置为 42 来进行渲染并产生结果：

还有另一个输出指令 raw ，它的行为和 esc 相同，但不对输出进行HTML转义。它可用于显示单独的构建标记 (e.g. 通过函数) 或已清洗的用户提供标记。

条件判断

QWeb拥有一个条件指令 if，它运行给定为属性值的表达式：

如果条件为true的话会渲染元素：

但如果条件为false，它会从结果中删除：

条件渲染应用于指令的所有者，不必一定为 <t>：

将给出与前例相同的结果。

还存在额外的分支指令 t-elif 和 t-else ：

循环

QWeb拥有遍历指令foreach，它接收一个表达式，返回待遍历的集合以及第二个用于对遍历的“当前项”提供名称的参数 t-as ：

将会渲染为：

类似条件，foreach 应用于带有指令属性的元素，并且

等价于前例。

foreach 可对数组 (当前项为当前值)或映射(当前项为当前键)进行遍历。.仍支持对整数的遍历（等价于遍历一个包含0到所提供整数（不含）的数组）但已淘汰。

除通过t-as传递名称乐， foreach还对不同数据点提供一些其它变量：

$as_all (淘汰)

所进行遍历的对象

这个变量仅在JavaScript QWeb中可用，在 Python中不可用。

$as_value

当前遍历值，和列表与整型的 $as 相同，但对于映射它提供了值 (其中 $as提供了键)

$as_index

当前迭代索引 (遍历中索引为0的第一项)

$as_size

如果可用时为集合的大小

$as_first

当前项是否为遍历的第一项 (等价于 $as_index == 0)

$as_last

当前项是否为遍历的最后一项(等价于 $as_index + 1 == $as_size)，要求遍历的大小可用

$as_parity (淘汰)

 为"even" 或 "odd"，当前遍历回合索引的奇偶性

$as_even (淘汰)

一个用于表明当前遍历回合为偶数索引的布尔标记

$as_odd (淘汰)

一个用于表明当前遍历回合为奇数索引的布尔标记

这些提供的额外变量及 foreach中创建的新变量仅在foreach的作用域中可用。若变量存在于foreach的上下文之外， foreach末尾的值会拷贝到全局上下文中

属性

QWeb可补时计算属性并对输出节点设置计算的结果。这通过 t-att (属性)指令完成，存在3种不同形式：

t-att-$name

创建名为 $name 的属性，运行属性值并将结果设置为属性的值：

<div t-att-a="42"/>

1	<div t-att-a="42"/>

将会被渲染为：

<div a="42"></div>

1	<div a="42"></div>

t-attf-$name

与前述相同，但参数是 格式字符串而不仅仅是一个表达式，通常用于混合字面量及非字面量字符串 (e.g. 类)：

<t t-foreach="[1, 2, 3]" t-as="item"> <li t-attf-class="row {{ (item_index % 2 === 0) ? 'even' : 'odd' }}"> <t t-esc="item"/> </li> </t>

1 2 3 4 5

<t t-foreach="[1, 2, 3]" t-as="item">     <li t-attf-class="row {{ (item_index % 2 === 0) ? 'even' : 'odd' }}">         <t t-esc="item"/>     </li> </t>

将会被渲染为：

<li class="row even">1</li> <li class="row odd">2</li> <li class="row even">3</li>

1 2 3

<li class="row even">1</li> <li class="row odd">2</li> <li class="row even">3</li>

t-att=mapping

如果参数是一个映射，第个 (key, value) 对生成一个新属性及其值：

<div t-att="{'a': 1, 'b': 2}"/>

1	<div t-att="{'a': 1, 'b': 2}"/>

会被渲染为：

<div a="1" b="2"></div>

1	<div a="1" b="2"></div>

t-att=pair

如果参数是一个值对 (两个元素的元组或数组)，值对的第一项是属性的名称，第二项是其值：

<div t-att="['a', 'b']"/>

1	<div t-att="['a', 'b']"/>

会被渲染为：

<div a="b"></div>

1	<div a="b"></div>

设置变量

QWeb允许在模板内创建变量，来存储（memoize）一个运算 (多次使用它)，提供一个更清晰名称的数据， …

这通过set指令完成，它接收待创建变量的名称。设置的值通过两种方式提供：

• 一个包含表达式的 t-value 属性，会设置其运行的结果：
  <t t-set="foo" t-value="2 + 1"/> <t t-esc="foo"/>

  1 2	<t t-set="foo" t-value="2 + 1"/> <t t-esc="foo"/>

  以上将打印 3

• 如果没有 t-value 属性，节点的内容体会进行渲染并设置为变量的值：

  <t t-set="foo"> <li>ok</li> </t> <t t-esc="foo"/>

  1 2 3 4

  <t t-set="foo">     <li>ok</li> </t> <t t-esc="foo"/>

  将会生成 <li>ok</li> (因我们使用了 esc 指令内容会进行转义)

  使用这一运算的结果是raw 指令的一个显著用例。

调用子模板

QWeb模板可用于顶层渲染，但它们也可在其它模板之内 (来避免复制或对部分模板给定) 使用 t-call 指令：

若定义other_template为下面的内容，通过父级执行上下文调用命名模板：

上面的调用会被渲染为 <p/> (无内容)，但：

会被渲染为 <p>1</p>.

但这在 t-call之外的可见性存在问题。此外，call 指令体内的内容会在运行子模板之前调用，并可更改本地内容：

call 指令体可任意复杂 (不仅仅是 set 指令)，并且其渲染形式将在所调用模板为魔法 0 变量之内可用：

被调用为：

会产生结果：

Python

独家指令

资源包

“智能记录”字段模式化

t-field 指令仅在对“智能”记录（browse方法的结果）执行字段访问(a.b) 时才可使用。它可以自动根据字段类型格式化，并且在网站的富文本版本中集成。

t-options 可用于自定义字段，最常见的选项是 widget，其它选项独立于字段或组件。

调试

t-debug

使用PDB的set_trace API调用调试器。参数应为模块名，对其调用set_trace 方法：

<t t-debug="pdb"/>

1	<t t-debug="pdb"/>

等价于 importlib.import_module("pdb").set_trace()

帮助函数

基于请求

QWeb的大部分Python端使用在控制器（HTTP请求时）中进行，其中存储在数据库中的模板 (作为 视图) 可通过调用 odoo.http.HttpRequest.render()来进行渲染：

这会自动创建一个Response 对象，它可在控制器中返回(或进行一步自定义在适配)。

基于视图

比上述帮助函数更深层次的是ir.ui.view中的render方法：

Javascript

独家指令

定义模板

t-name 指令仅可放在模板文件（文档根目标的直接后代）的顶层：

它不接收其它参数，便可与<t>元素或任意其它元素共同使用。 通过 <t> 元素时， <t> 应包含一个子元素。

模板名是一个任意字符串，虽然关联了多个模板 (e.g. 调用了子模板)，可自定义使用点击分隔名称来表明层级关系。

模板继承

模板继承用于在原处更改已有模板，e.g. 向由其它模块创建的模板添加信息。

模板继承通过t-extend 指令执行，它接收模板名称来修改为参数。

在 t-extend 与 t-name 进行合并时，会创建带有给定名称的新模板。在这种情况下所扩展的模板未进行修改，而是由指令定义了如何新建模板。

在这两种情况下修改由任意数量的 t-jquery 子指令执行：

t-jquery指令接收一个 CSS选择器。该选择器用于所继承的模板来选择上下文节点来应用所指定的 t-operation ：

append

节点的内容体添加到上下文节点的结束处 (在上下文节点最一个子元素之后)

prepend

节点的内容体前置到上下文节点 (在上下文节点的第一个子元素之前插入)

before

节点的内容体插入到上下文节点为之前

after

节点的内容体插入到上下文节点为之后

inner

节点的内容体替换上下文节点的子元素

replace

节点的内容体用于替换上下文节点本身

attributes

节点的内容体可为任意数量的attribute 元素，每个都带有name 属性和一些文本内容，上下文节点的命令属性将设置为指定值(如已存在则替换否则进行添加)

No operation

如未指定t-operation ，模板体会解析为 javascript代码并以 this通过上下文节点执行

⚠️警告

虽然比其它操作强大得多，但这一模式更难调试、更难维护，推荐避免使用它。

调试

javascript QWeb实现提供了一些调试钩子：

t-log

接收表达式参数，在渲染期间运行表达式并通过console.log在结果中进行记录：

<t t-set="foo" t-value="42"/> <t t-log="foo"/>

1 2	<t t-set="foo" t-value="42"/> <t t-log="foo"/>

将在控制台中打印出print 42

t-debug

在模板渲染时触发调试器断点：

<t t-if="a_test"> <t t-debug=""> </t>

1 2 3

<t t-if="a_test">     <t t-debug=""> </t>

如调试为活跃状态则停止执行 (具体的情况取决于浏览器及其开发工具)

t-js

节点内容体为在模板渲染时执行的javascript代码。接收一个 context 参数，渲染上下文所使用的名称在 t-js的内容体中可以获取到：

<t t-set="foo" t-value="42"/> <t t-js="ctx"> console.log("Foo is", ctx.foo); </t>

1 2 3 4

<t t-set="foo" t-value="42"/> <t t-js="ctx">     console.log("Foo is", ctx.foo); </t>

帮助对象

API