Base - Write Diff

Resumen

Este módulo te permite actualizar registros filtrando los campos cuyos valores van a quedar sin cambios por BaseModel.write(); por ejemplo, supongamos que tienes:

>>> self
sale.order.line(1,)
>>> self.price_unit
10.00

Si usas self.write({"price_unit": 10.00}) o self.price_unit = 10.00, Odoo puede acabar ejecutando operaciones innecesarias, como desencadenar la actualización del campo, recalcular campos computados que dependen de price_unit, etc., incluso si el valor en realidad no ha cambiado.

Al usar este módulo, puedes evitar todo eso.

Puedes usar este módulo de 3 formas distintas. Todas ellas requieren que añadas este módulo como dependencia de tu módulo.

1 - Clave de contexto "write_use_diff_values"

Al añadir write_use_diff_values=True al contexto al actualizar el valor de un campo, el parche BaseModel.write() se encargará de filtrar los valores de los campos que sean iguales a los actuales del registro.

⚠️ Atención: la clave de contexto se propaga hacia abajo a otras llamadas write()

Ejemplo:

from odoo import models


class ProductTemplate(models.Model):
    _inherit = "product.template"

    def write(self, vals):
        # Update only fields that are actually different
        self = self.with_context(write_use_diff_values=True)
        return super().write(vals)


class ProductProduct(models.Model):
    _inherit = "product.product"

    def update_code_if_necessary(self, code: str):
        # Update ``default_code`` only if different from the current value
        self.with_context(write_use_diff_values=True).default_code = code

2 - Método BaseModel.write_diff()

Es lo mismo que llamar a write(), pero habilita automáticamente el flag de contexto "write_use_diff_values": self.write_diff(vals) es un atajo para self.with_context(write_use_diff_values=True).write(vals)

⚠️ Atención: la clave de contexto se propaga hacia abajo a otras llamadas write()

3 - Método BaseModel._get_write_diff_values(vals)

Este método acepta como parámetro un dict similar a write, y devuelve un nuevo dict formado por los campos que realmente actualizarán los valores del registro. Esto permite un comportamiento más flexible y personalizable que el uso de la clave de contexto, porque:

• podrás filtrar campos específicos, en lugar de filtrar todos los campos cuyos valores no cambiarán tras la actualización;
• podrás ejecutar el filtrado en modelos específicos, en lugar de ejecutarlo en todos los modelos implicados en la pila de llamadas write() desde el primer uso de la clave de contexto hasta el método base BaseModel.write().

Ejemplo:

from collections import defaultdict

from odoo import api, models
from odoo.tools.misc import frozendict


class ProductProduct(models.Model):
    _inherit = "product.product"

    def write(self, vals):
        # OVERRIDE: ``odoo.addons.product.models.product_product.Product.write()``
        # override will clear the whole registry cache if either 'active' or
        # 'product_template_attribute_value_ids' are found in the ``vals`` dictionary:
        # remove them unless it's necessary to update them
        fnames = {"active", "product_template_attribute_value_ids"}
        if vals_to_check := {f: vals.pop(f) for f in fnames.intersection(vals)}:
            groups = defaultdict(lambda: self.browse())
            for prod in self:
                groups[frozendict(prod._get_write_diff_values(vals_to_check))] += prod
            for diff_vals, prods in groups.items():
                if res_vals := (vals | dict(diff_vals)):
                    super(ProductProduct, prods).write(res_vals)
            return True
        return super().write(vals)