第 10 章：准备好来点动作了吗？

到目前为止，我们构建模块主要靠声明字段和视图。在 上一章 中，我们借助计算字段和 onchange 引入了业务逻辑。在任何真实的业务场景中，我们都会希望把某些业务逻辑关联到动作按钮。在我们的房地产示例中，我们希望能够：

  • 取消一个房产，或将房产标记为已售出

  • 接受或拒绝一个报价

有人可能会说，我们已经可以通过手动更改状态来完成这些操作，但这并不方便。此外，我们还想添加一些额外的处理：当报价被接受时，我们要为房产设置售价和买家。

动作类型

参考：与本节主题相关的文档可以在 操作 和 错误管理 中找到。

Note

目标：在本节结束时：

  • 您应该能够取消房产或将房产标记为已售出：

取消并标记为已售出

已取消的房产不能售出，已售出的房产不能取消。为清晰起见，state 字段已添加到视图中。

  • 您应该能够接受或拒绝一个报价：

接受或拒绝报价

  • 一旦报价被接受，售价和买家就应被设置：

接受报价

在不动产模块中，我们希望将业务逻辑与一些按钮关联起来。最常见的方式是：

  • 在视图中添加一个按钮，例如添加到视图的 header 中：

<form>
    <header>
        <button name="action_do_something" type="object" string="Do Something"/>
    </header>
    <sheet>
        <field name="name"/>
    </sheet>
</form>

  • 并将该按钮关联到业务逻辑：

from odoo import fields, models

class TestAction(models.Model):
    _name = "test.action"

    name = fields.Char()

    def action_do_something(self):
        for record in self:
            record.name = "Something"
        return True

通过为按钮指定 type="object"，Odoo 框架将在给定模型上执行 name="action_do_something" 所指定的 Python 方法。

需要注意的第一个重要细节是，我们的方法名没有以下划线（_）作为前缀。这使得我们的方法成为 公开 方法，可以直接从 Odoo 界面调用（通过 RPC 调用）。到目前为止，我们创建的所有方法（compute、onchange）都是在内部调用的，因此我们使用带下划线前缀的 私有 方法。除非需要从用户界面调用，否则应始终将方法定义为私有方法。

另请注意，我们遍历了 self。始终假设方法可能在多条记录上调用；这样更有利于复用。

最后，公开方法应始终返回一些内容，以便可以通过 XML-RPC 调用。拿不准时，直接 return True 即可。

Odoo 源代码中有数百个示例。例如这个 视图中的按钮 及其 对应的 Python 方法

Exercise

取消房产，并将房产标记为已售出。

  • 在 estate.property 模型上添加 ‘取消’ 和 ‘已售出’ 按钮。已取消的房产不能设为已售出，已售出的房产也不能取消。

    预期结果参见 目标 的第一张图。

    提示：要抛出错误，可以使用 UserError 函数。Odoo 源代码中有大量示例 ;-)

  • 为 estate.property.offer 模型添加 ‘Accept’ 和 ‘Refuse’ 按钮。

    预期结果参见 目标 的第二张图。

    提示：要将图标用作按钮，请参见 这个示例。

  • 当报价被接受时，为对应房产设置买家和售价。

    预期结果参见 目标 的第三张图。

    请注意：在现实中，一个房产只能有一个报价被接受！

对象类型

在 第 6 章：终于可以上手 UI 了 中，我们创建了一个关联到菜单的动作。你可能在想能否把动作关联到按钮。好消息，可以！一种做法是：

<button type="action" name="%(test.test_model_action)d" string="My Action"/>

我们使用 type="action"，并在 name 中引用 外部标识符。

在 下一章 中，我们将了解如何在 Odoo 中防止录入错误的数据。