odoo模块构造
1.odoo模块由manifest定义，每个模块同时也是一个python包，通过init文件进行导入，可以通过odoo内置命令生成一个简单的模块
odoo-bin scaffold <module name> <where to put it>
2.数据模型
odoo的数据模型通过继承一个Model的类定义，__name字段定义数据模型名称，例：
from odoo import models
class MinimalModel(models.Model):
_name = 'test.model'
3.数据字段
- odoo数据字段通过定义model的属性来实现
from odoo import models, fields
class LessMinimalModel(models.Model):
_name = 'test.model2'
name = fields.Char()
- 字段也可以添加属性
name=field.Char(required=True) - 通用属性：
string (unicode, default: field's name) 定义用户在界面看到的名字
required (bool, default: False) 是否为必选字段
help (unicode, default: '') 用于用户界面提示
index (bool, default: False) 数据库索引 - 保留字段
id (Id) 数据表主键
create_date (Datetime) 创建时间
create_uid (Many2one) 创建人id
write_date (Datetime) 最近修改时间
write_uid (Many2one) 最近修改人id - 特殊字段
odoo所有表默认有一个name字段
4.数据文件
模块数据通过xml文件定义，每个<record>对应创建或更新一条数据表数据
<odoo>
<data>
<record model="{model name}" id="{record identifier}">
<field name="{a field name}">{a value}</field>
</record>
</data>
</odoo>
model是模型名称，id是模型ID，field name是字段名字，value是值
数据文件需要通过manifest文件的进行导入，定义在data里代表总是导入，定义在demo里表示只在演示模式下才导入
5.菜单和响应动作
菜单可以通过menuitem来定义
<record model="ir.actions.act_window" id="action_list_ideas">
<field name="name">Ideas</field>
<field name="res_model">idea.idea</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="menu_ideas" parent="menu_root" name="Ideas" sequence="10"
action="action_list_ideas"/>
注意：action必须在菜单之前定义，xml文件是顺序加载的
视图
- 基本视图是以模型的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>, <tree>, <graph>, ... -->
</field>
</record>
- 列表（以列表形式展示数据）
<tree string="Idea list">
<field name="name"/>
<field name="inventor_id"/>
</tree>
- 表单(用于编辑和新增数据）
<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>
- 多tab表单
<sheet>
<group>
<field name="name"/>
</group>
<notebook>
<page string="Description">
<field name="description"/>
</page>
<page string="About">
This is an example of notebooks
</page>
</notebook>
</sheet>
- 表单视图也支持原始html
<form string="Idea Form">
<header>
<button string="Confirm" type="object" name="action_confirm"
states="draft" class="oe_highlight" />
<button string="Mark as done" type="object" name="action_done"
states="confirmed" class="oe_highlight"/>
<button string="Reset to draft" type="object" name="action_draft"
states="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元素来决定搜索时使用的字段
<record model="ir.ui.view" id="course_search_view">
<field name="name">course.search</field>
<field name="model">openacademy.course</field>
<field name="arch" type="xml">
<search>
<field name="name"/>
<field name="description"/>
</search>
</field>
</record>
数据模型之间关联
一个开放学院可以对应有多项开设的课程，多个会议，会议有名字、开始时间、持续时间等属性
class Courses(models.Model):
_name = 'academy.courses'
name = fields.Char(string="Title", required=True)
description = fields.Text()
class Session(models.Model):
_name = 'academy.session'
name = fields.Char(required=True)
start_date = fields.Date()
duration = fields.Float(digits=(6, 2), help="Duration in days")
seats = fields.Integer(string="Number of seats")
view.xml
<!-- session form view -->
<record model="ir.ui.view" id="session_form_view">
<field name="name">session.form</field>
<field name="model">openacademy.session</field>
<field name="arch" type="xml">
<form string="Session Form">
<sheet>
<group>
<field name="name"/>
<field name="start_date"/>
<field name="duration"/>
<field name="seats"/>
</group>
</sheet>
</form>
</field>
</record>
<record model="ir.actions.act_window" id="session_list_action">
<field name="name">Sessions</field>
<field name="res_model">openacademy.session</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
</record>
<!-- top level menu: no parent -->
<menuitem id="main_openacademy_menu" name="Open Academy"/>
<!-- A first level in the left side menu is needed
before using action= attribute -->
<menuitem id="openacademy_menu" name="Open Academy"
parent="main_openacademy_menu"/>
<menuitem id="session_menu" name="Sessions"
parent="openacademy_menu"
action="session_list_action"/>
其中digits=(6, 2) 是浮点数的定义
数据模型之间通过字段关联
1.多对一
Many2one(other_model, ondelete='set null')
使用：print foo.other_id.name
2.一对多
One2many(other_model, related_field)
一对多是虚拟的关系(一对多定义时必须保证有对应的多对一关系存在，且related_field要一致)，使用的时候以集合的方式
for other in foo.other_ids:
print other.name
3.多对多
Many2many(other_model)，以集合的方式读取数据
for other in foo.other_ids:
print other.name
实例：
#models.py
class Courses(models.Model):
_name = 'academy.courses'
name = fields.Char(string="Title", required=True)
description = fields.Text()
responsible_id = fields.Many2one('res.users',
ondelete='set null', string="Responsible", index=True)
class Session(models.Model):
_name = 'academy.session'
name = fields.Char(required=True)
start_date = fields.Date()
duration = fields.Float(digits=(6, 2), help="Duration in days")
seats = fields.Integer(string="Number of seats")
instructor_id = fields.Many2one('res.partner', string="Instructor")
course_id = fields.Many2one('openacademy.course',
ondelete='cascade', string="Course", required=True)
#view.xml
<!-- course表单视图 -->
<record model="ir.ui.view" id="course_form_view">
<field name="name">courses.form</field>
<field name="model">openacademy.courses</field>
<field name="arch" type="xml">
<form string="Course Form">
<sheet>
<group>
<field name="name"/>
<field name="responsible_id"/>
</group>
<notebook>
<page string="Description">
<field name="description"/>
</page>
<page string="About">
This is an example of notebooks
</page>
</notebook>
</sheet>
</form>
</field>
</record>
<!-- 课程视图 -->
<record model="ir.ui.view" id="course_search_view">
<field name="name">courses.search</field>
<field name="model">openacademy.courses</field>
<field name="arch" type="xml">
<search>
<field name="name"/>
<field name="description"/>
</search>
</field>
</record>
<record model="ir.ui.view" id="course_tree_view">
<field name="name">courses.tree</field>
<field name="model">openacademy.courses</field>
<field name="arch" type="xml">
<tree string="Course Tree">
<field name="name"/>
<field name="responsible_id"/>
</tree>
</field>
</record>
<!-- session 表单视图 -->
<record model="ir.ui.view" id="session_form_view">
<field name="name">session.form</field>
<field name="model">openacademy.session</field>
<field name="arch" type="xml">
<form string="Session Form">
<sheet>
<group>
<group string="General">
<field name="course_id"/>
<field name="name"/>
<field name="instructor_id"/>
</group>
<group string="Schedule">
<field name="start_date"/>
<field name="duration"/>
<field name="seats"/>
</group>
</group>
</sheet>
</form>
</field>
</record>
<!-- session tree/list view -->
<record model="ir.ui.view" id="session_tree_view">
<field name="name">session.tree</field>
<field name="model">openacademy.session</field>
<field name="arch" type="xml">
<tree string="Session Tree">
<field name="name"/>
<field name="course_id"/>
</tree>
</field>
</record>
<!-- session 列表视图，点击二级菜单进入 -->
<record model="ir.actions.act_window" id="session_list_action">
<field name="name">Sessions</field>
<field name="res_model">openacademy.session</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
</record>
<!--顶级菜单 -->
<menuitem id="main_openacademy_menu" name="Open Academy"/>
<!-- 一级菜单 -->
<menuitem id="openacademy_menu" name="Open Academy"
parent="main_openacademy_menu"/>
<!-- 二级菜单 链接到 session_list record -->
<menuitem id="session_menu" name="Sessions"
parent="openacademy_menu"
action="session_list_action"/>
重启odoo，搜索academy并安装，进入academy试试效果
继承
1.模型继承
odoo提供两种继承机制：
- 在模块内直接修改在其他模块中定义的model如：添加字段、重写字段定义、添加约束条件、添加函数方法、重写已定义方法
- 使用代理机制，子模型可以访问父模型的属性，且可以自定义其他属性
2.视图继承
odoo提供视图继续用于在原有视图上进行扩展，通过inherit_id字段来关联父级视图，在arch元素里通过添加xpath元素来引入父级视图内容,例：
<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>
expr属性用于指定从父视图中选择使用的元素
position指定该元素的的使用inside表示添加到匹配到的元素后
replace表示替换匹配到的元素
before表示添加到匹配的元素前，与其同级
after表示同级添加到匹配到的元素后
attributes用于改变匹配元素的attribute属性
实例：
使用模型继承给partner模型添加一个instructor字段，一个多对多的session-partner关系，使用视图继承在partner表单视图中展示
1.创建models/partner.py并在init里导入
2.创建views/partner.xml并在manifest加载
#models/__init__.py
from . import models
from . import partner
#__manifest__.py
'data': [
'security/ir.model.access.csv',
'views/views.xml',
'views/partner.xml',
]
#models/partner.py
# -*- coding: utf-8 -*-
from odoo import fields, models
class Partner(models.Model):
_inherit = 'res.partner'
# Add a new column to the res.partner model, by default partners are not
# instructors
instructor = fields.Boolean("Instructor", default=False)
session_ids = fields.Many2many('openacademy.session',
string="Attended Sessions", readonly=True)
#views/partner.xml
<?xml version="1.0" encoding="UTF-8"?>
<odoo>
<data>
<!-- 在原来视图基础上添加instructor字段 -->
<record model="ir.ui.view" id="partner_instructor_form_view">
<field name="name">partner.instructor</field>
<field name="model">res.partner</field>
<field name="inherit_id" ref="base.view_partner_form"/>
<field name="arch" type="xml">
<notebook position="inside">
<page string="Sessions">
<group>
<field name="instructor"/>
<field name="session_ids"/>
</group>
</page>
</notebook>
</field>
</record>
<record model="ir.actions.act_window" id="contact_list_action">
<field name="name">Contacts</field>
<field name="res_model">res.partner</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="configuration_menu" name="Configuration"
parent="main_openacademy_menu"/>
<menuitem id="contact_menu" name="Contacts"
parent="configuration_menu"
action="contact_list_action"/>
</data>
</odoo>
需要先卸载再重装模块上面的例子才能正确运行。
3.domain表达式
domain表达式类似于三元表达式，对数据进行筛选
[('product_type', '=', 'service'), ('unit_price', '>', 1000)] 此表达式筛选出产品类型为service而且价格大于1000的记录
& ,|, ! 罗辑运算符可用于多表达式联接，但它是写在domain表达式之前的而不是在两个表达式之间
['|',
('product_type', '=', 'service'),
'!', '&',
('unit_price', '>=', 1000),
('unit_price', '<', 2000)]
上面表达式筛选出产品类型为service或价格不在1000-2000之间的记录
domain表达式可作用于关联字段，用来控制显示在客户端的数据
#models.py
#在session模型中对instructor_id进行限制，只有instructor被设置为true的才显示
instructor_id = fields.Many2one('res.partner', string="Instructor",
domain=[('instructor', '=', True)])
# instructor为true或者partner分类为teacher（teacher LV1，teacher LV2）
instructor_id = fields.Many2one('res.partner', string="Instructor",
domain=['|', ('instructor', '=', True),
('category_id.name', 'ilike', "Teacher")])
#partner.xml
<record model="ir.actions.act_window" id="contact_cat_list_action">
<field name="name">Contact Tags</field>
<field name="res_model">res.partner.category</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="contact_cat_menu" name="Contact Tags"
parent="configuration_menu"
action="contact_cat_list_action"/>
<record model="res.partner.category" id="teacher1">
<field name="name">Teacher / Level 1</field>
</record>
<record model="res.partner.category" id="teacher2">
<field name="name">Teacher / Level 2</field>
</record>
重启进入，instructor栏目只会显示筛选过后的记录了
数据模型自定义字段
1.实时计算字段
odoo模型不仅可以使用数据库的字段，还可以通过函数实时计算 定义字段，在model里self是一个集合，可以使用循环来读取，每一个循环得到单条记录
import random
from odoo import models, fields, api
class ComputedModel(models.Model):
_name = 'test.computed'
name = fields.Char(compute='_compute_name')
@api.multi
def _compute_name(self):
for record in self:
record.name = str(random.randint(1, 1e6))
实时函数调用的字段往往依赖于其他字段，odoo提供depends装饰器用于声明，可以为ORM提供一个触发器:@api.depends('seats', 'attendee_ids')
实例：为session模型添加一个上座率字段并用加载条显示
#models.py 添加
taken_seats = fields.Float(string="Taken seats", compute='_taken_seats')
@api.depends('seats', 'attendee_ids')
def _taken_seats(self):
for r in self:
if not r.seats:
r.taken_seats = 0.0
else:
r.taken_seats = 100.0 * len(r.attendee_ids) / r.seats
#views.xml
#在session的form和tree view里添加field元素
<field name="taken_seats" widget="progressbar"/>
2.默认值字段
定义字段时可使用default=x选项，x可以是特定的值或者通过计算得来
name = fields.Char(default="Unknown")
user_id = fields.Many2one('res.users', default=lambda self: self.env.user)
self.env提供了很多有用的特性
self.env.cr 或 self._cr -- 当前数据库查询游标
self.env.uid 或 self._uid -- 当前用户在数据库中id
self.env.user -- 当前用户在数据库中的记录
self.env.context 或 self._context -- 当前上下文dictionary
self.env.ref(xml_id) -- 当前数据对应XML
self.env[model_name] -- 返回给定model的实例
实例：
start_date = fields.Date(default=fields.Date.today)
active = fields.Boolean(default=True)
onchange
odoo有一个onchange机制，不需要保存数据到数据库就可以实时更新用户界面上的显示
例：
# models.py
# 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",
}
}
#监听座位数的改变，实时校验数值是否有误，输入错误数据时会弹框报错
@api.onchange('seats', 'attendee_ids')
def _verify_valid_seats(self):
if self.seats < 0:
return {
'warning': {
'title': "Incorrect 'seats' value",
'message': "The number of available seats may not be negative",
},
}
if self.seats < len(self.attendee_ids):
return {
'warning': {
'title': "Too many attendees",
'message': "Increase seats or remove excess attendees",
},
}
模型约束
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
- sql约束使用的是模型的_sql_constraints属性，里面是一个校验列表，每一个元素有三个子元素，(name, sql_definition, message)，name是自定义的约束名称、sql_definition是一个sql表达式、message是校验失败时返回的错误消息
_sql_constraints = [
('name_description_check',
'CHECK(name != description)',
"The title of the course should not be the description"),
('name_unique',
'UNIQUE(name)',
"The course title must be unique"),
]
内容发布自http://www.dingyii.cn，转载请注明出处
