在Odoo中,API装饰器用于增强模型方法的功能,使其能够适应特定的上下文或行为。下面将详细介绍Odoo中常用的API装饰器及其用法。
1. @api.model
此装饰器用于标记一个方法,使其仅依赖于模型本身,而不依赖于特定的记录集。它通常用于创建新记录或执行不涉及特定记录的操作。
from odoo import models, api
class MyModel(models.Model):
_name = 'my.model'
@api.model
def create_record(self, values):
return self.create(values)
2. @api.multi
标记方法在多条记录上操作。这是默认行为,在Odoo 13以前更常见。从Odoo 13开始,默认情况下所有方法都被视为多记录操作,因此在新版本中使用此装饰器的情况较少。
from odoo import models, api
class MyModel(models.Model):
_name = 'my.model'
@api.multi
def do_something(self):
for record in self:
# 对每条记录执行操作
pass
3. @api.one
@api.one
装饰器标记的方法按照单条记录调用,即使调用时传入多条记录,系统也会自动为每条记录分别调用一次该方法。该装饰器在Odoo 13中已弃用,不推荐使用。
# 注意: 该装饰器已在Odoo 13中弃用
from odoo import models, api
class MyModel(models.Model):
_name = 'my.model'
@api.one
def do_something(self):
# 对当前记录执行操作
pass
4. @api.depends
此装饰器用于计算字段方法,指定当哪些字段的值发生变化时,应该重新计算该字段的值。
from odoo import models, fields, api
class MyModel(models.Model):
_name = 'my.model'
name = fields.Char("Name")
description = fields.Text("Description")
full_details = fields.Char(compute='_compute_full_details')
@api.depends('name', 'description')
def _compute_full_details(self):
for record in self:
record.full_details = f"{record.name} - {record.description}"
5. @api.onchange
当在视图中更改了指定的字段值时,该装饰器标记的方法被调用,用于动态修改表单上的其他字段值。
from odoo import models, fields, api
class MyModel(models.Model):
_name = 'my.model'
name = fields.Char("Name")
description = fields.Text("Description")
@api.onchange('name')
def _onchange_name(self):
if self.name:
self.description = f"Description for {self.name}"
6. @api.constrains
用于指定一个方法作为约束条件,当指定字段的值发生变化时,该方法会被调用来检查数据的有效性。
from odoo import models, fields, api, exceptions
class MyModel(models.Model):
_name = 'my.model'
name = fields.Char("Name")
@api.constrains('name')
def _check_name(self):
for record in self:
if not record.name:
raise exceptions.ValidationError("Name cannot be empty")