构建模块¶
Danger
本教程已过时。我们建议改为阅读 服务器框架 101。
Warning
本教程要求 已安装 Odoo
启动/停止 Odoo 服务器¶
Odoo 采用客户端/服务器架构,客户端是通过 RPC 访问 Odoo 服务器的网页浏览器。
业务逻辑和扩展通常在服务器端完成,不过也可以向客户端添加支持性的客户端功能(例如交互式地图等新的数据呈现方式)。
要启动服务器,只需在 shell 中调用 odoo-bin 命令,必要时加上文件的完整路径:
odoo-bin
在终端中按两次 Ctrl-C,或终止相应的操作系统进程,即可停止服务器。
构建一个 Odoo 模块¶
服务器端和客户端扩展都打包为 模块,可有选择地加载到 数据库 中。
Odoo 模块既可以向 Odoo 系统添加全新的业务逻辑,也可以修改和扩展现有业务逻辑:可以创建一个模块,将您所在国家的会计规则加入 Odoo 的通用会计支持,而下一个模块则添加对巴士车队实时可视化的支持。
因此,Odoo 中的一切都始于模块,也终于模块。
模块的组成¶
一个 Odoo 模块可以包含多种元素:
模块结构¶
每个模块都是 模块目录 中的一个目录。模块目录通过 --addons-path 选项指定。
Tip
大多数命令行选项也可通过 配置文件 设置
Odoo 模块由其 清单 声明。
模块同时也是一个 Python 包 ,包含一个 __init__.py 文件,其中含有对模块内各个 Python 文件的导入指令。
例如,如果模块只有一个 mymodule.py 文件,__init__.py 可能包含:
from . import mymodule
Odoo 提供了帮助搭建新模块的机制,odoo-bin 有一个子命令 scaffold 用于创建空模块:
$ odoo-bin scaffold <module name> <where to put it>
该命令会为您的模块创建一个子目录,并自动为模块创建一系列标准文件。其中大部分文件只包含注释代码或 XML。本教程将陆续讲解这些文件的大部分用法。
Exercise
模块创建
使用上面的命令行创建一个空模块 Open Academy,并在 Odoo 中安装它。
对象关系映射¶
Odoo 的一个关键组件是 ORM 层。该层避免了手工编写大部分 SQL ,并提供了扩展性和安全服务2。
业务对象声明为继承 Model 的 Python 类,这会将它们集成到自动持久化系统中。
模型可以通过在定义时设置若干属性来进行配置。最重要的属性是 _name ,它是必需的,定义了模型在 Odoo 系统中的名称。以下是一个模型的最小完整定义:
from odoo import models
class MinimalModel(models.Model):
_name = 'test.model'
模型字段¶
字段用于定义模型可以存储什么内容以及存储在哪里。字段定义为模型类上的属性:
from odoo import models, fields
class LessMinimalModel(models.Model):
_name = 'test.model2'
name = fields.Char()
通用属性¶
与模型本身一样,字段也可以通过将配置属性作为参数传入来进行配置:
name = fields.Char(required=True)
有些属性可用于所有字段,以下是最常用的几种:
string(unicode,默认值:字段名称)字段在界面中的标签(用户可见)。
required(bool,默认值:False)若为
True,该字段不能为空,必须设有默认值,或者在创建记录时始终提供值。help(unicode,默认值:'')长文本说明,在界面中为用户提供帮助提示。
index(bool,默认值:False)请求 Odoo 在该列上创建 数据库索引 。
简单字段¶
字段分为两大类:”simple”(简单)字段是直接存储在模型表中的原子值;”relational”(关系)字段用于关联记录(同一模型或不同模型的记录)。
简单字段的示例有 Boolean 、Date 、Char 。
保留字段¶
Odoo 会在所有模型中创建一些字段1。这些字段由系统管理,不应写入。如有需要可以读取:
id(Id)记录在其模型中的唯一标识符。
create_date(Datetime)记录的创建日期。
create_uid(Many2one)创建该记录的用户。
write_date(Datetime)记录的最后修改日期。
write_uid(Many2one)最后修改该记录的用户。
特殊字段¶
默认情况下,出于各种显示和搜索行为,Odoo 还要求所有模型都拥有一个 name 字段。用于这些目的的字段可通过设置 _rec_name 来更改。
Exercise
定义一个模型
在 openacademy 模块中定义一个新的数据模型 Course 。课程具有标题和描述。课程必须有标题。
数据文件¶
Odoo 是一个高度数据驱动的系统。尽管行为是通过 Python 代码定制的,但模块的价值有一部分在于它在加载时所设置的数据。
Tip
有些模块存在的唯一目的就是向 Odoo 添加数据
模块数据通过 数据文件 声明,即带有 <record> 元素的 XML 文件。每个 <record> 元素创建或更新一条数据库记录。
<odoo>
<record model="{model name}" id="{record identifier}">
<field name="{a field name}">{a value}</field>
</record>
</odoo>
model是该记录对应的 Odoo 模型的名称。id是一个 外部标识符 ,它允许引用该记录(无需知道其在数据库中的标识符)。<field>元素带有name属性,即字段在模型中的名称(例如description)。其内容即为该字段的值。
数据文件必须在清单文件中声明才会被加载,可以声明在 'data' 列表(始终加载)或 'demo' 列表(仅在演示模式下加载)中。
Exercise
定义演示数据
创建演示数据,用几个演示课程填充 Courses 模型。
基础视图¶
视图定义了模型记录的显示方式。每种视图类型代表一种展示形式(记录列表、聚合图表等)。视图既可以通过类型进行通用请求(例如 合作伙伴列表 ),也可以通过 id 进行特定请求。对于通用请求,将使用类型正确且优先级最低的视图(因此每种类型中优先级最低的视图就是该类型的默认视图)。
视图继承 允许修改在其他地方声明的视图(添加或移除内容)。
通用视图声明¶
视图声明为模型 ir.ui.view 的一条记录。视图类型由 arch 字段的根元素决定:
<record model="ir.ui.view" id="view_id">
<field name="name">view.name</field>
<field name="model">object_name</field>
<field name="priority" eval="16"/>
<field name="arch" type="xml">
<!-- view content: <form>, <list>, <graph>, ... -->
</field>
</record>
Danger
视图的内容是 XML。
因此 arch 字段必须声明为 type="xml" 才能被正确解析。
列表视图¶
列表视图(也称列表视图)以表格形式显示记录。
其根元素为 <list> 。最简单的列表视图形式只是列出要在表格中显示的所有字段(每个字段作为一列):
<list string="Idea list">
<field name="name"/>
<field name="inventor_id"/>
</list>
表单视图¶
表单用于创建和编辑单条记录。
其根元素为 <form> 。它们由高级结构元素(组、笔记本)和交互元素(按钮和字段)组成:
<form string="Idea form">
<group colspan="4">
<group colspan="2" col="2">
<separator string="General stuff" colspan="2"/>
<field name="name"/>
<field name="inventor_id"/>
</group>
<group colspan="2" col="2">
<separator string="Dates" colspan="2"/>
<field name="active"/>
<field name="invent_date" readonly="1"/>
</group>
<notebook colspan="4">
<page string="Description">
<field name="description" nolabel="1"/>
</page>
</notebook>
<field name="state"/>
</group>
</form>
Exercise
使用 XML 自定义表单视图
为 Course 对象创建您自己的表单视图。显示的数据应为:课程的名称和描述。
Exercise
笔记本
在 Course 表单视图中,将描述字段放在一个选项卡下,以便以后更容易添加包含附加信息的其他选项卡。
表单视图也可以使用普通 HTML 来实现更灵活的布局:
<form string="Idea Form">
<header>
<button string="Confirm" type="object" name="action_confirm"
invisible="state != 'draft'" class="oe_highlight" />
<button string="Mark as done" type="object" name="action_done"
invisible="state != 'confirmed'" class="oe_highlight"/>
<button string="Reset to draft" type="object" name="action_draft"
invisible="state not in ['confirmed', 'done']" />
<field name="state" widget="statusbar"/>
</header>
<sheet>
<div class="oe_title">
<label for="name" class="oe_edit_only" string="Idea Name" />
<h1><field name="name" /></h1>
</div>
<separator string="General" colspan="2" />
<group colspan="2" col="2">
<field name="description" placeholder="Idea description..." />
</group>
</sheet>
</form>
搜索视图¶
搜索视图用于自定义与列表视图(以及其他聚合视图)关联的搜索字段。其根元素为 <search> ,由定义可搜索字段的若干字段组成:
<search>
<field name="name"/>
<field name="inventor_id"/>
</search>
如果该模型没有搜索视图,Odoo 会自动生成一个,但只允许搜索 name 字段。
Exercise
搜索课程
允许根据课程的标题或描述进行搜索。
模型之间的关系¶
一个模型的记录可能与另一个模型的记录相关联。例如,销售订单记录与包含客户数据的客户记录相关联;它还与其销售订单行记录相关联。
Exercise
创建会话模型
对于 Open Academy 模块,我们为 会话 建立一个模型:会话是某门课程在特定时间面向特定听众的一次授课。
为 会话 创建一个模型。会话具有名称、开始日期、时长和座位数。添加一个动作和一个菜单项来显示它们。通过菜单项让新模型可见。
关联字段¶
关系字段用于关联记录,可以是同一模型内的记录(层级结构),也可以是不同模型之间的记录。
关系字段的类型有:
Many2one(other_model, ondelete='set null')指向另一个对象的简单链接:
print(foo.other_id.name)
更多内容
One2many(other_model, related_field)一种虚拟关系,是
Many2one的反向。One2many表现为一个记录容器,访问它会得到一个(可能为空的)记录集合:for other in foo.other_ids: print(other.name)
Danger
由于
One2many是一种虚拟关系,other_model中 必须 存在一个Many2one字段,且其名称 必须 为related_fieldMany2many(other_model)双向多对多关系,任意一侧的记录可以与另一侧任意数量的记录相关联。它表现为一个记录容器,访问它同样会得到一个可能为空的记录集合:
for other in foo.other_ids: print(other.name)
Exercise
多对一关系
使用多对一(many2one),修改 Course 和 Session 模型以反映它们与其他模型的关系:
课程有一个 负责人 用户;该字段的值是内置模型
res.users的一条记录。会话有一位 讲师 ;该字段的值是内置模型
res.partner的一条记录。会话与一个 课程 相关联;该字段的值是模型
openacademy.course的一条记录,且为必填。调整视图。
Exercise
反向 one2many 关系
使用反向关联字段 one2many,修改模型以体现课程与课时之间的关系。
Exercise
多重 many2many 关系
使用关联字段 many2many,修改 Session 模型,将每个课时关联到一组 参与者 。参与者将由业务伙伴记录表示,因此我们将关联到内置模型 res.partner 。请相应地调整视图。
继承¶
模型继承¶
Odoo 提供两种 继承 机制,用于以模块化的方式扩展现有模型。
第一种继承机制允许一个模块修改另一个模块中定义的模型的行为:
为模型添加字段,
覆盖模型上字段的定义,
为模型添加约束,
为模型添加方法,
覆盖模型上的现有方法。
第二种继承机制(委托)允许将模型中的每条记录链接到父模型中的一条记录,并提供对父记录字段的透明访问。
更多内容
_inherit_inherits
视图继承¶
Odoo 提供了视图继承机制,而不是直接(通过覆盖)修改现有视图:子 “扩展” 视图应用在根视图之上,可以在其父视图中添加或移除内容。
扩展视图使用 inherit_id 字段引用其父视图,并且其 arch 字段不再包含单个视图,而是由任意数量的 xpath 元素组成,用于选取并修改其父视图的内容:
<!-- improved idea categories list -->
<record id="idea_category_list2" model="ir.ui.view">
<field name="name">id.category.list2</field>
<field name="model">idea.category</field>
<field name="inherit_id" ref="id_category_list"/>
<field name="arch" type="xml">
<!-- find field description and add the field
idea_ids after it -->
<xpath expr="//field[@name='description']" position="after">
<field name="idea_ids" string="Number of ideas"/>
</xpath>
</field>
</record>
exprXPath 表达式,用于在父视图中选取单个元素。如果匹配不到元素或匹配到多个元素,则会引发错误
position要应用于匹配元素的操作:
inside将
xpath的主体追加到匹配元素的末尾replace用
xpath的主体替换匹配元素,新主体中出现的任何$0节点都会被替换为原始元素before将
xpath的主体作为兄弟元素插入到匹配元素之前after将
xpaths的主体作为兄弟元素插入到匹配元素之后attributes使用
xpath主体中特殊的attribute元素修改匹配元素的属性
Tip
当匹配单个元素时,position 属性可以直接设置在要查找的元素上。下面两种继承方式将得到相同的结果。
<xpath expr="//field[@name='description']" position="after"> <field name="idea_ids" /> </xpath> <field name="description" position="after"> <field name="idea_ids" /> </field>
Exercise
修改现有内容
使用模型继承,修改现有的 Partner 模型,添加
instructor布尔字段,以及一个对应课时-业务伙伴关系的 many2many 字段使用视图继承,在业务伙伴表单视图中显示这些字段
域¶
在 Odoo 中,搜索域 是对记录条件进行编码的值。域是用于选取模型记录子集的条件列表。每个条件是一个三元组,包含字段名、运算符和值。
例如,在 Product 模型上使用时,以下域会选取所有单价高于 1000 的 服务 ::
[('product_type', '=', 'service'), ('unit_price', '>', 1000)]
默认情况下,条件之间以隐式 AND 组合。逻辑运算符 & (AND)、| (OR)和 ! (NOT)可用于显式组合条件。它们以前缀方式使用(运算符插入在其参数之前,而不是参数之间)。例如,要选取 “是服务 OR 单价 NOT 在 1000 到 2000 之间” 的产品 ::
['|',
('product_type', '=', 'service'),
'!', '&',
('unit_price', '>=', 1000),
('unit_price', '<', 2000)]
可以为关联字段添加 domain 参数,以便在客户端界面中选取记录时限制该关系可用的有效记录。
Exercise
关联字段上的域
在为 Session 选择讲师时,应该只能看到讲师( instructor 设置为 True 的业务伙伴)。
Exercise
更复杂的域
新建业务伙伴类别 Teacher / Level 1 和 Teacher / Level 2 。课时的讲师可以是讲师,也可以是教师(任何级别)。
计算字段与默认值¶
到目前为止,字段都是直接存储在数据库中并直接从数据库中读取的。字段也可以是 计算 的。在这种情况下,字段的值不是从数据库中读取的,而是通过调用模型的方法即时计算得到的。
要创建计算字段,请创建一个字段并将其属性 compute 设置为某个方法的名称。计算方法只需为 self 中的每条记录设置要计算字段的值。
Danger
self 是一个集合
对象 self 是一个 recordset (记录集),即记录的有序集合。它支持对集合的标准 Python 操作,例如 len(self) 和 iter(self),以及额外的集合操作,例如 recs1 + recs2 。
迭代 self 会逐个给出记录,其中每条记录本身就是一个大小为 1 的集合。可以使用点号表示法访问/赋值单条记录上的字段,例如 record.name 。
import random
from odoo import models, fields, api
class ComputedModel(models.Model):
_name = 'test.computed'
name = fields.Char(compute='_compute_name')
def _compute_name(self):
for record in self:
record.name = str(random.randint(1, 1e6))
依赖项¶
计算字段的值通常取决于所计算记录上其他字段的值。ORM 要求开发者在计算方法上使用装饰器 depends() 指定这些依赖项。ORM 会使用给定的依赖项,在其任一依赖项被修改时触发字段的重算 ::
from odoo import models, fields, api
class ComputedModel(models.Model):
_name = 'test.computed'
name = fields.Char(compute='_compute_name')
value = fields.Integer()
@api.depends('value')
def _compute_name(self):
for record in self:
record.name = "Record with value %s" % record.value
Exercise
计算字段
向 Session 模型添加已占座位的百分比
在列表视图和表单视图中显示该字段
以进度条形式显示该字段
默认值¶
任何字段都可以指定默认值。在字段定义中添加选项 default=X,其中 X 可以是 Python 字面值(布尔值、整数、浮点数、字符串),也可以是接受记录集并返回一个值的函数 ::
name = fields.Char(default="Unknown")
user_id = fields.Many2one('res.users', default=lambda self: self.env.user)
Note
对象 self.env 提供对请求参数以及其他有用内容的访问:
self.env.cr或self._cr是数据库 游标 对象;它用于查询数据库
self.env.uid或self._uid是当前用户的数据库 id
self.env.user是当前用户的记录
self.env.context或self._context是上下文字典
self.env.ref(xml_id)返回与 XML id 对应的记录
self.env[model_name]返回给定模型的实例
Exercise
活动对象 – 默认值
将 start_date 的默认值定义为今天(参见
Date)。在 Session 类中添加字段
active,并将课时默认设置为活动状态。
Onchange¶
“onchange” 机制为客户端界面提供了一种方式:只要用户在字段中填写了值,就可以更新表单,而无需向数据库保存任何内容。
例如,假设一个模型有三个字段 amount、unit_price 和 price,并且您希望在修改其他任一字段时更新表单上的价格。为实现这一点,请定义一个方法,其中 self 表示表单视图中的记录,并用 onchange() 装饰该方法,以指定应在哪个字段上触发。您对 self 所做的任何修改都会反映到表单上。
<!-- content of form view -->
<field name="amount"/>
<field name="unit_price"/>
<field name="price" readonly="1"/>
# onchange handler
@api.onchange('amount', 'unit_price')
def _onchange_price(self):
# set auto-changing field
self.price = self.amount * self.unit_price
# Can optionally return a warning and domains
return {
'warning': {
'title': "Something bad happened",
'message': "It was very bad indeed",
}
}
对于计算字段,带值的 onchange 行为是内置的,这一点可以在 Session 表单中尝试看到:更改座位数或参与者人数,taken_seats 进度条就会自动更新。
Exercise
警告
添加一个显式的 onchange 来警告无效的值,例如座位数为负数,或参与者多于座位数。
模型约束¶
Odoo 提供两种设置自动验证不变量的方式:Python 约束 和 SQL 约束 。
Python 约束定义为一个用 constrains() 装饰的方法,并在记录集上调用。装饰器指定了约束涉及哪些字段,因此当其中任一字段被修改时,约束会被自动求值。如果不满足其不变量,该方法应引发异常 ::
from odoo.exceptions import ValidationError
@api.constrains('age')
def _check_something(self):
for record in self:
if record.age > 20:
raise ValidationError("Your record is too old: %s" % record.age)
# all records passed the test, don't return anything
Exercise
添加 Python 约束
添加一个约束,检查讲师不在其自己课时的参与者之列。
SQL 约束通过模型属性 _sql_constraints 定义。该属性赋值为一个由字符串三元组 (name, sql_definition, message) 组成的列表,其中 name 是有效的 SQL 约束名称,sql_definition 是 table_constraint 表达式,message 是错误消息。
Exercise
练习 6 - 添加复制选项
由于我们为 Course 名称的唯一性添加了约束,因此无法再使用 “duplicate” 功能( )。
重新实现您自己的 “copy” 方法,允许复制 Course 对象,并将原名称改为 “Copy of [original name]”。
高级视图¶
列表视图¶
列表视图可以接受一些补充属性,以进一步自定义其行为:
decoration-{$name}允许根据相应记录的属性更改行文本的样式。
取值为 Python 表达式。对每条记录,表达式会以记录的属性作为上下文值进行求值,如果结果为
true,则将相应样式应用于该行。以下是上下文中可用的其他一些值:uid:当前用户的 id,today:当前本地日期,格式为YYYY-MM-DD的字符串,now:与today相同,但还包含当前时间。该值的格式为YYYY-MM-DD hh:mm:ss。
{$name}可以是bf(font-weight: bold)、it(font-style: italic),或任何 bootstrap contextual color (danger、info、muted、primary、success或warning)。<list string="Idea Categories" decoration-info="state=='draft'" decoration-danger="state=='trashed'"> <field name="name"/> <field name="state"/> </list>
editable"top"或"bottom"。使列表视图可以就地编辑(而不必经过表单视图),该值是新行出现的位置。
Exercise
列表着色
修改 Session 列表视图,使持续时间少于 5 天的课时显示为蓝色,持续时间多于 15 天的课时显示为红色。
日历¶
将记录显示为日历事件。其根元素为 <calendar> ,最常见的属性有:
color用于 颜色分段 的字段名称。颜色会自动分配给事件,但同一颜色分段中的事件(
@color字段值相同的记录)将被赋予相同的颜色。date_start保存事件开始日期/时间的记录字段
date_stop(可选)保存事件结束日期/时间的记录字段
string用于定义每个日历事件标签的记录字段
<calendar string="Ideas" date_start="invent_date" color="inventor_id">
<field name="name"/>
</calendar>
Exercise
日历视图
为 Session 模型添加日历视图,使用户能够查看与 Open Academy 关联的事件。
搜索视图¶
搜索视图的 <field> 元素可以带有 @filter_domain,用于覆盖针对给定字段搜索时生成的域。在给定的域中,self 表示用户输入的值。在下面的示例中,它用于同时在 name 和 description 两个字段上进行搜索。
搜索视图还可以包含 <filter> 元素,它们充当预定义搜索的开关。过滤器必须具有以下属性之一:
domain将给定的域添加到当前搜索中
context为当前搜索添加一些上下文;使用键
group_by按给定字段名对结果进行分组
<search string="Ideas">
<field name="name"/>
<field name="description" string="Name and description"
filter_domain="['|', ('name', 'ilike', self), ('description', 'ilike', self)]"/>
<field name="inventor_id"/>
<field name="country_id" widget="selection"/>
<filter name="my_ideas" string="My Ideas"
domain="[('inventor_id', '=', uid)]"/>
<group string="Group By">
<filter name="group_by_inventor" string="Inventor"
context="{'group_by': 'inventor_id'}"/>
</group>
</search>
要在动作中使用非默认的搜索视图,应使用动作记录的 search_view_id 字段进行链接。
动作还可以通过其 context 字段为搜索字段设置默认值:形式为 search_default_field_name 的上下文键将使用提供的值初始化 field_name 。搜索过滤器必须有一个可选的 @name 才能具有默认值,并表现为布尔值(它们只能默认启用)。
Exercise
搜索视图
在课程搜索视图中添加一个按钮,用于筛选当前用户为负责人的课程。使其默认选中。
添加一个按钮,按负责用户对课程进行分组。
甘特图¶
Warning
甘特图视图需要 web_gantt 模块,该模块包含在 企业版 中。
水平条形图,通常用于显示项目规划和进度,其根元素为 <gantt> 。
<gantt string="Ideas"
date_start="invent_date"
date_stop="date_finished"
progress="progress"
default_group_by="inventor_id" />
Exercise
甘特图
添加一个甘特图,使用户能够查看与 Open Academy 模块关联的课时排期。课时应按讲师分组。
图形视图¶
图形视图允许对模型进行汇总概览和分析,其根元素为 <graph> 。
Note
数据透视视图(元素 <pivot> )是一种多维表格,允许选择过滤器和维度,以便在转向更图形化的概览之前获得正确的汇总数据集。数据透视视图与图形视图共享相同的内容定义。
图形视图有 4 种显示模式,默认模式通过 @type 属性选择。
- 条形图(默认)
条形图,第一个维度用于定义水平轴上的分组,其他维度定义每个分组内的汇总条形。
默认情况下条形并排显示,可以通过在
<graph>上使用@stacked="True"使其堆叠显示- Line
二维折线图
- Pie
二维饼图
图表视图包含带有必填 @type 属性的 <field>,该属性可取以下值:
row默认)该字段默认应进行聚合
measure该字段应进行聚合而不是用于分组
<graph string="Total idea score by Inventor">
<field name="inventor_id"/>
<field name="score" type="measure"/>
</graph>
Warning
图表视图对数据库中的值执行聚合,因此不适用于非存储型计算字段。
Exercise
图表视图
在 Session 对象中添加一个图表视图,以柱状图的形式显示每门课程的参与者人数。
看板¶
用于组织任务、生产流程等……其根元素为 <kanban>。
看板视图显示一组卡片,可按列分组。每张卡片代表一条记录,每一列代表一个聚合字段的值。
例如,项目任务可以按阶段组织(每一列是一个阶段),或按负责人组织(每一列是一个用户),等等。
看板视图将每张卡片的结构定义为表单元素(包括基础 HTML)与 QWeb 模板 的混合。
Exercise
看板视图
添加一个看板视图,按课程显示课时(列即为课程)。
安全¶
必须配置访问控制机制,以实现一致的安全策略。
基于群组的访问控制机制¶
群组作为 res.groups 模型上的普通记录创建,并通过菜单定义授予菜单访问权限。然而,即使没有菜单,对象仍可能被间接访问,因此必须为群组定义实际的对象级权限(读取、写入、创建、删除)。这些权限通常通过模块内的 CSV 文件插入。还可以使用字段的 groups 属性来限制对视图或对象上特定字段的访问。
访问权限¶
访问权限定义为 ir.model.access 模型的记录。每条访问权限关联到一个模型、一个群组(或无群组表示全局访问),以及一组权限:读取、写入、创建、删除。这类访问权限通常由以其模型命名的 CSV 文件创建:ir.model.access.csv。
id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink
access_idea_idea,idea.idea,model_idea_idea,base.group_user,1,1,1,0
access_idea_vote,idea.vote,model_idea_vote,base.group_user,1,1,1,0
Exercise
通过 Odoo 界面添加访问控制
创建一个新用户 “John Smith”。然后创建一个群组 “OpenAcademy / Session Read”,使其对 Session 模型具有读取权限。
Exercise
通过模块中的数据文件添加访问控制
使用数据文件,
创建一个群组 OpenAcademy / Manager ,对所有 OpenAcademy 模型拥有完全访问权限
让所有用户都能读取 Session 和 Course
记录规则¶
记录规则将访问权限限制到给定模型的部分记录。规则是 ir.rule 模型的一条记录,它关联到一个模型、多个群组(多对多字段)、限制适用的权限,以及一个域。域指定访问权限限于哪些记录。
下面是一个防止删除状态不为 cancel 的线索的规则示例。请注意,字段 groups 的值必须遵循与 ORM 的 write() 方法相同的约定。
<record id="delete_cancelled_only" model="ir.rule">
<field name="name">Only cancelled leads may be deleted</field>
<field name="model_id" ref="crm.model_crm_lead"/>
<field name="groups" eval="[(4, ref('sales_team.group_sale_manager'))]"/>
<field name="perm_read" eval="0"/>
<field name="perm_write" eval="0"/>
<field name="perm_create" eval="0"/>
<field name="perm_unlink" eval="1" />
<field name="domain_force">[('state','=','cancel')]</field>
</record>
Exercise
记录规则
为 Course 模型和群组 “OpenAcademy / Manager” 添加一条记录规则,将 write 和 unlink 访问限制为课程的负责人。如果课程没有负责人,该群组的所有用户都必须能够修改它。
向导¶
向导通过动态表单描述与用户(或对话框)的交互会话。向导只是一个继承自 TransientModel 类而非 Model 的模型。TransientModel 类继承自 Model 并复用其所有现有机制,但有以下特殊之处:
向导记录不是持久性的;它们会在一段时间后自动从数据库中删除。这就是它们被称为 瞬态 的原因。
向导记录可以通过关联字段(多对一或多对多)引用普通记录或向导记录,但普通记录 不能 通过多对一字段引用向导记录。
我们想创建一个向导,允许用户为特定课时创建参与者,或一次为多个课时创建参与者。
Exercise
定义向导
创建一个向导模型,它与 Session 模型有多对一关系,与 Partner 模型有多对多关系。
启动向导¶
向导只是 target 字段设为 new 的 窗口动作,它会在单独的对话框中打开视图(通常是 表单)。该动作可以通过菜单项触发,但更常见的是通过按钮触发。
启动向导的另一种方式是通过列表或表单视图的 菜单。这是通过动作的 binding_model_id 字段实现的。设置该字段会使动作出现在其 “绑定” 到的模型的视图上。
<record id="launch_the_wizard" model="ir.actions.act_window">
<field name="name">Launch the Wizard</field>
<field name="res_model">wizard.model.name</field>
<field name="view_mode">form</field>
<field name="target">new</field>
<field name="binding_model_id" ref="model_context_model_ref"/>
</record>
Tip
虽然向导使用常规的视图和按钮,但在表单中点击任何按钮通常都会先保存表单,然后关闭对话框。由于这在向导中往往不合需要,因此提供了一个特殊属性 special="cancel",可立即关闭向导而不保存表单。
Exercise
启动向导
为向导定义一个表单视图。
添加在 Session 模型上下文中启动它的动作。
为向导中的课时字段定义默认值;使用上下文参数
self._context获取当前课时。
Exercise
登记参与者
在向导中添加按钮,并实现相应的方法,将参与者添加到给定的课时。
Exercise
将参与者登记到多个课时
修改向导模型,使参与者可以登记到多个课时。
国际化¶
每个模块都可以在 i18n 目录中提供自己的翻译,文件命名为 LANG.po,其中 LANG 是语言的区域设置代码,或语言与国家的组合(当两者不同时,例如 pt.po 或 pt_BR.po)。Odoo 会为所有启用的语言自动加载翻译。开发人员创建模块时始终使用英语,然后使用 Odoo 的 gettext POT 导出功能(,不指定语言)导出模块术语,创建模块模板 POT 文件,然后据此派生翻译后的 PO 文件。许多 IDE 都有用于编辑和合并 PO/POT 文件的插件或模式。
Tip
Odoo 生成的便携对象(PO)文件发布在 Transifex 上,使软件翻译变得容易。
|- idea/ # The module directory
|- i18n/ # Translation files
| - idea.pot # Translation Template (exported from Odoo)
| - fr.po # French translation
| - pt_BR.po # Brazilian Portuguese translation
| (...)
Tip
默认情况下,Odoo 的 POT 导出只提取 XML 文件内或 Python 代码中字段定义里的标签,但任何 Python 字符串都可以通过用 odoo._() 函数包裹(例如 _("Label"))来翻译。
Exercise
翻译模块
为您的 Odoo 安装选择第二种语言。使用 Odoo 提供的工具翻译您的模块。
报表¶
打印报表¶
Odoo 使用基于 QWeb 模板、Twitter Bootstrap 和 Wkhtmltopdf 的报表引擎。
报表由两个元素的组合构成:
一个
ir.actions.report,用于配置报表的各种基本参数(默认类型、报表生成后是否保存到数据库等……)<record id="account_invoices" model="ir.actions.report"> <field name="name">Invoices</field> <field name="model">account.invoice</field> <field name="report_type">qweb-pdf</field> <field name="report_name">account.report_invoice</field> <field name="report_file">account.report_invoice</field> <field name="attachment_use" eval="True"/> <field name="attachment">(object.state in ('open','paid')) and ('INV'+(object.number or '').replace('/','')+'.pdf')</field> <field name="binding_model_id" ref="model_account_invoice"/> <field name="binding_type">report</field> </record>
Tip
由于它基本上是一个标准动作,与 向导 一样,通常有用的做法是通过
binding_model_id字段将该报表作为 上下文项 添加到被报表模型的列表和/或表单视图中。这里我们还使用了
binding_type,使报表出现在 报表 上下文菜单而不是 动作 菜单中。这没有技术上的差异,但把元素放在合适的位置能帮助用户。用于实际报表的标准 QWeb 视图:
<t t-call="web.html_container"> <t t-foreach="docs" t-as="o"> <t t-call="web.external_layout"> <div class="page"> <h2>Report title</h2> </div> </t> </t> </t>
标准渲染上下文提供了许多元素,其中最重要的是:
docs打印报表所针对的记录
user打印报表的用户
由于报表是标准网页,因此可以通过 URL 访问,并且可以通过该 URL 操作输出参数。例如,Invoice 报表的 HTML 版本可通过 http://localhost:8069/report/html/account.report_invoice/1(如果已安装 account)访问,PDF 版本可通过 http://localhost:8069/report/pdf/account.report_invoice/1 访问。
Danger
如果您的 PDF 报表缺少样式(即文本出现了,但样式/布局与 html 版本不同),很可能是您的 wkhtmltopdf 进程无法连接到您的 Web 服务器下载样式。
如果您检查服务器日志,发现生成 PDF 报表时 CSS 样式未被下载,那么十有八九就是这个问题。
wkhtmltopdf 进程将使用 web.base.url 系统参数作为所有关联文件的 根路径,但该参数会在管理员每次登录时自动更新。如果您的服务器位于某种代理之后,则该地址可能无法访问。您可以通过添加以下系统参数之一来解决此问题:
report.url,指向您的服务器可访问的 URL(可能是http://localhost:8069或类似地址)。它仅用于此特定目的。web.base.url.freeze,设置为True时,将停止对web.base.url的自动更新。
Exercise
为 Session 模型创建报表
对于每个课时,它应显示课时名称、开始和结束时间,并列出课时的参与者。
仪表板¶
Exercise
定义仪表板
定义一个仪表板,包含您创建的图表视图、课时日历视图和课程列表视图(可切换到表单视图)。该仪表板应可通过菜单中的菜单项访问,并在选择 OpenAcademy 主菜单时自动显示在 Web 客户端中。
- 1
可以 禁用某些字段的自动创建
- 2
可以编写原生 SQL 查询,但需要小心,因为它会绕过所有 Odoo 认证和安全机制。