8、odoo模型中常用方法

ゝ一纸荒年。 2022-11-12 08:27 262阅读 0赞

### 10、Domain字段域设置 ###

[点我下载完整odoo的demo][odoo_demo]

在odoo中，通过domain来过滤数据记录，domain是一个list,里面有多个条件。条件是一个有3个元素的元组 (‘模型的字段’,’操作符’,’值’)。比如你要过滤出产品为服务类型并且价格大于1000的产品：

domain = [(‘product_type’, ‘=’, ‘service’), (‘unit_price’, ‘>’, 1000)]

*  domain作用在一个model上
    
    model.search(domain)
    
    默认的 domain是以and的方式连接2个条件
    
    也就是说上面的可以表示成：
    
        domain = [‘&’,(‘product_type’, ‘=’, ‘service’), (‘unit_price’, ‘>’, 1000)]
    
    其他逻辑符：
    
        & (AND), | (OR) and ! (NOT)
    
    来看另外一个domain：
    
        [‘|’,(‘product_type’, ‘=’, ‘service’),’!’, ‘&’,(‘unit_price’, ‘>=’, 1000), (‘unit_price’, ‘<’, 2000)]
    
    读法：先看最后一个逻辑符 后面所有的条件作为操作数, 变成

\[‘|’, (‘product\_type’, ‘=’, ‘service’), ‘!’, cond\]

```
    
    同样规则
    
    ```

\[‘|’, (‘product\_type’, ‘=’, ‘service’), cond\]

```

*  domain的另外一个作用是用在关联字段里，可以在model.py 的field里定义或在xml view的field里过滤关联字段记录。

#### 参考 ####

过滤出只是老师的res.partner记录

instructor_id = fields.Many2one(‘res.partner’, string=”Instructor”,domain=[(‘instructor’, ‘=’, True)])

注意：

domain如果是一个list，右值只能是一个字面值

如果是string(在xml里定义) 右值可以引用其他字段的值

`myproject/my_first_app/models/session.py`在session中的instructor\_id增加domain过滤条件：

# -*- coding: utf-8 -*-
    
    from odoo import models, fields, api
    
    
    class Session(models.Model):
        """ 授课、讲座 """
        _name = 'myproject.session'
    
        name = fields.Char(required=True)
        duration = fields.Float(digits=(6, 2), help='持续时间')
        course_id = fields.Many2one('myproject.course', string='课程')
        course_name = fields.Char(related='course_id.name', string='课程名称', readonly=True)
        start_date = fields.Date(string='开始时间', default=fields.Date.today)
        seats = fields.Integer(string='座位数')
        instructor_id = fields.Many2one('res.partner', string="讲师", domain=['|', ('instructor', '=', True),
                                                                            ('category_id.name', 'ilike', "Teacher")])
        attendee_ids = fields.Many2many('res.partner', string="参与者")

`myproject/my_first_app/views/res_partner_views.xml`增加一个显示记录：

<?xml version="1.0" encoding="UTF-8"?>
    <odoo>
        <data>
            <record model="ir.ui.view" id="partner_is_instructor_form_view">
                <field name="name">partner.is_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="课程">
                            <group>
                                <field name="is_instructor"/>
                            </group>
                        </page>
                    </notebook>
                </field>
            </record>
            <record model="ir.actions.act_window" id="contact_list_action">
                <field name="name">联系人</field>
                <field name="res_model">res.partner</field>
                <field name="view_mode">tree,form</field>
            </record>
            <menuitem id="configuration_menu" name="配置" parent="myproject_course_app_menu"/>
    
            <menuitem id="contact_menu" name="联系人" parent="configuration_menu" action="contact_list_action"/>
    
            <record model="ir.actions.act_window" id="contact_cat_list_action">
                <field name="name">联系人标签</field>
                <field name="res_model">res.partner.category</field>
                <field name="view_mode">tree,form</field>
            </record>
            <menuitem id="contact_cat_menu" name="联系人标签" 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>
        </data>
    </odoo>

过滤出 res.partner 是instructor 或res.partner.category\_id 包含Teacher的记录

注：odoo中如果要在xml的form中是用domain，比如过滤many2one字段，且根据另一个字段的值过滤，则另一个字段需要定义，如果不想显示，可以用invisible=True来隐藏

### 11、计算字段和默认值 ###

#### Computed fields ####

前面我们的定义的字段的值都保存在数据库中(One2many除外)  
odoo中提供一种每次引用字段值时通过方法计算出值的方式来显示字段

#### 注意 ####

当每次调用rec.name时，都调用方法来计算字段的值

self是一个rec集合(recordset),可以for循环出里面的单个记录  
单个记录可以用`.`来访问字段  
recordset还支持+号操作

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))

#### Dependencies ####

[点我下载完整odoo的demo][odoo_demo]  
依赖计算

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

通过@api.depends(‘value’)，当value值改变时会自动重新计算name, 并显示在界面上

Computed fields  
添加课程小节的上课人数百分比，并用一个进度条显示

`myproject/my_first_app/models/session.py`

`myproject/my_first_app/views/session_views.xml`增加一行：

位置如图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center]

再增加一行：

位置如图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 1]

效果如图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 2]

#### Default values ####

通过default=来设置字段的默认值

name = fields.Char(default=”Unknown”)

user\_id = fields.Many2one(‘res.users’, default=lambda self: self.env.user)

self.env使用方法

self.env.cr or self._cr 数据库指针
    self.env.uid or self._uid 当前请求用户id
    self.env.user 当前请求用户记录 可以访问self.env.user.name 等
    self.env.context or self._context 当前上下文
    self.env.ref(xml_id) 通过xml_id访问某个记录 xml_id对应ir_model_data的name字段
    self.env[model_name] 返回某个model class对象

在session中添加

start\_date 和 active 的默认值

`myproject/my_first_app/models/session.py`

class Session(models.Model):
        """ 讲座 """
        _name = 'learn.session'
        name = fields.Char(required=True)
        start_date = fields.Date(default=fields.Date.today)
        duration = fields.Float(digits=(6, 2), help="持续时间")
        seats = fields.Integer(string="Number of seats")
        active = fields.Boolean(default=True)
        instructor_id = fields.Many2one('res.partner', string="讲师", domain=['|', ('is_instructor', '=', True),
                                                                            ('category_id.name', 'ilike', "Teacher")])
        course_id = fields.Many2one('learn.course', ondelete='cascade', string="课程", required=True)
        attendee_ids = fields.Many2many('res.partner', string="参与者")
        taken_seats = fields.Float(string="参与人数百分比", 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

`myproject/my_first_app/views/learn_view.xml`增加几行：

位置如图所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 3]

更新应用后，效果如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 4]

#### 注意 ####

odoo默认的机制是会过滤掉active为False的字段,比如在tree不显示

可以用`<field name="context">{'active_test': False}</field>`禁用这种机制

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 5]

注：

compute是根据数值实时计算的

加上store=True，数值会写进数据库

页面数据初始值获取，或者进行数据处理，重写default\_get方法

如果要获取查看页面的时候的值，重写read方法，这个方法可以获取当前登录用户

tree视图中compute默认调用，

form视图中，对于新建的表单，需要使用depends来触发compute计算函数，

已有数据页面，载入时触发一次compute。但如果是store=True，只有在编辑状态下, depends

里的字段发生变化时重新计算，否则直接读数据库里的数据。

### 12、Onchange ###

Onchange提供一种在用户界面根据某些字段值改变表单其他数据的机制。

下面用一个单价x数量=总价的例子说明。首先你有一个model其中有三个字段，`amount，unit_price, price`分别代表数量，单价，总价。你想要的效果是自动计算出总价，并在form中显示出来。通过一个用onchange装饰器的方法来实现。

<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",
            }
        }

这个方法有几点需要注意

1、self是单条记录 在一个form里展示

2、方法里改变self里的字段 会更新到未保存的form里

3、通过onchange里参数字段触发更新

与上一节计算字段不同的是

1、self是单条记录，不能用在list view

2、计算字段的onchange是内置的行为

3、onchange方法里可以影响多个字段

`myproject/my_first_app/models/session.py中class Session`里面增加一个方法：

@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", }, 
                        }

根据seats和attendee\_ids改变 验证 用户输入

1 检查座位数不能为负数

2 座位数不能小于现有出席人数

*  延伸问题  
    1 onchange 是否在write方法里触发 不在用户界面操作  
    2 除了返回提示框 还可以返回domian或False  
    3 onchange 和 depends 哪个先触发  
    鼠标焦点失去时，onchange先触发。  
    4 用onchange改写上例的计算字段是否成功 以证明二者的不同

#### 注意: ####

return { 
            'warning': { 'title': "Too many attendees", 'message': "Increase seats or remove excess attendees", },
                        }

这样弹出提示框，只能用在`onchange、model、multi`装饰器的方法里

#### 一些常用装饰器简介 ####

当添加一个函数时，确保它可以处理多重数据，如通过api.multi()装饰器，可以在self上进行循环处理

@api.multi
    def my_method(self)    
    	for record in self:        
    		record.do_cool_stuff()

避免使用api.one 装饰器：这可能不会执行您的预期，并且扩展这样的方法并不像api.multi方法那么容易，因为它返回一个结果列表（按记录集ids排序）。

对于性能问题，当开发’stat按钮’（例如）时，不要在方法中执行循环search或search\_count循环api.multi。建议使用read\_group方法，只在一个请求中计算所有值。

@api.multi
    def _compute_equipment_count(self): 
        """ Count the number of equipement per category """
        equipment_data = self.env['hr.equipment'].read_group([('category_id', 'in', self.ids)], ['category_id'],
                                                         ['category_id'])
        mapped_data = dict([(m['category_id'][0], m['category_id_count']) for m in equipment_data])
        for category in self:        
            category.equipment_count = mapped_data.get(category.id, 0)

### 13、模型约束(Model constraints) ###

[点我下载完整odoo的demo][odoo_demo]  
Odoo 中提供两种 建立约束的方式

1、 python代码级别约束

2、 SQL数据库级别约束

#### python代码约束 ####

先来说说python代码级别的约束吧，因为是python代码级别，只要在model里写方法就可以实现。

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

上面的代码使用constrains装饰器对某个model的 age字段做了限制。当记录中age字段的值发生变化时， \_check\_something就会被调用。遍历所有的记录（注意这里的self是一个recordset，也就是对应多条记录），做一些条件判断，不满足就抛出ValidationError异常，反应到用户界面上弹出一个警告框，导致用户保存失败。

对课程的老师做检查，保证老师不出现在学生列表中。

myproject/my\_first\_app/models/session.py

# -*- coding: utf-8 -*-
    from odoo import models, fields, api, exceptions
    class Session(models.Model):    
    	_name = 'learn.session'

@api.constrains('instructor_id', 'attendee_ids')
        def _check_instructor_not_in_attendees(self):
            for r in self:
                if r.instructor_id and r.instructor_id in r.attendee_ids:
                    raise exceptions.ValidationError("A session's instructor can't be an attendee")

constrains参数的意思是，在这些字段发生改变时，进行检查。不会对原有的数据进行检查。

#### SQL约束 ####

因为是在数据库中的约束，所以是在python约束之后执行。当创建或更新记录时，会触发该条件，如果条件不符合，则弹出错误信息，拒绝修改。

通过 model的属性 `_sql_constraints`写入规则列表

约束规则是一个 三元 元组 格式 (name, sql\_definition, message)

name 此规则的名称

sql\_definition 是 pgsql里的约束条件 ([参考][Link 1])

message 定义报错信息

给课程的name添加唯一检查和与description不相同检查

myproject/my\_first\_app/models/course.py

如果表里以及存在冲突的数据，导致sql约束更新不了。

改写copy方法 来防止复制记录时， name相同，改写 Copy of name (x) 到 新的记录name

myproject/my\_first\_app/models/course.py

# -*- coding: utf-8 -*-
    
    from odoo import models, fields, api
    
    class Course(models.Model):
        """ 课程 """
        _name = 'myproject.course'
    
        name = fields.Char(string='课程名称', reqired=True, placeholder='填写课程名称')
        description = fields.Text(string='Description', placeholder='填写课程描述')
        sex = fields.Boolean(string='性别', default=True)
        state = fields.Selection(
            [('draft', "草稿"), ('open', "开启"), ('full', "满人"), ('cancel', "取消")], string="状态",
            help="课程状态", default="draft"
        )
        responsible_id = fields.Many2one('res.users', ondelete='set null', string="负责人", index=True)
        session_ids = fields.One2many('myproject.session', 'course_id', string="讲座")
    
        @api.multi
        def copy(self, default=None):
            default = dict(default or { })
            copied_count = self.search_count(
                [('name', '=like', u"Copy of {}%".format(self.name))])
            if not copied_count:
                new_name = u"Copy of {}".format(self.name)
            else:
                new_name = u"Copy of {} ({})".format(self.name, copied_count)
            default['name'] = new_name
            return super(Course, self).copy(default)
    
        _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"),
        ]

[点我下载完整odoo的demo][odoo_demo]

## 后记 ##

【后记】为了让大家能够轻松学编程，我创建了一个公众号【轻松学编程】，里面有让你快速学会编程的文章，当然也有一些干货提高你的编程水平，也有一些编程项目适合做一些课程设计等课题。

也可加我微信【1257309054】，拉你进群，大家一起交流学习。  
如果文章对您有帮助，请我喝杯咖啡吧！

公众号

![公众号][20200317124808234.jpg]

![赞赏码][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70]

关注我，我们一起成长~~

[odoo_demo]: https://download.csdn.net/download/lm_is_dc/16818292
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center]: /images/20221022/8300fe5eac544040bcde4035e30aa709.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221022/e5298998f8454eafba38f85acb26103e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221022/9dc9b216f6a84f9a9266c12297fdc8f9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221022/061e5d687b6645028a5443b5b8c28186.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221022/06f0c2a092484b0bbb593d77c32e9b31.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221022/d96e47fe05f6439dbd76b978c0e65183.png
[Link 1]: https://www.postgresql.org/docs/9.3/static/ddl-constraints.html%3E
[20200317124808234.jpg]: /images/20221022/eb87babb2e3745f7898d85adb69a5f38.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xtX2lzX2Rj_size_16_color_FFFFFF_t_70]: /images/20221022/d00f787900c24cf0b614f4e4ac45ee0f.png