如何在SQLAlchemy中检测自定义TypeDecorator类型的字段变更？

问题原因 #

SQLAlchemy的实例变更检测默认采用浅比较：它只检查模型列属性的引用是否发生变化，不会递归检查对象内部的字段修改。当你修改ConfigFlags数据类的内部字段时，res.config_flags本身的引用没有改变，因此SQLAlchemy认为该列没有更新，不会生成UPDATE语句。

解决方案 #

方法一：手动标记字段为已修改 #

使用SQLAlchemy提供的flag_modified函数，明确告诉ORM该字段已发生变更：

from sqlalchemy.orm import flag_modified

res = ConvHistories(session=session).find_one(conv_id=3)

if res.config_flags:
    res.config_flags.abc = False
    # 手动标记config_flags字段为脏数据
    flag_modified(res, "config_flags")

session.commit()

方法二：重新赋值数据类对象 #

通过创建新的ConfigFlags实例并赋值给模型属性，改变属性的引用，触发SQLAlchemy的变更检测：

res = ConvHistories(session=session).find_one(conv_id=3)

if res.config_flags:
    # 基于原有属性创建新对象并修改字段
    new_config = ConfigFlags(**res.config_flags.to_dict())
    new_config.abc = False
    res.config_flags = new_config

session.commit()

方法三：让数据类支持可变追踪（进阶） #

自定义支持变更通知的可变包装类，让内部字段修改时自动触发ORM的变更检测：

1. 定义可变包装类：

from sqlalchemy.ext.mutable import Mutable

class MutableConfigFlags(Mutable):
    def __init__(self, config):
        self.config = config

    @classmethod
    def coerce(cls, key, value):
        if not isinstance(value, MutableConfigFlags):
            if isinstance(value, ConfigFlags):
                return MutableConfigFlags(value)
            return Mutable.coerce(key, value)
        else:
            return value

    def __setattr__(self, name, value):
        # 修改内部属性时标记为脏数据
        if name == "config":
            object.__setattr__(self, name, value)
        else:
            setattr(self.config, name, value)
            self.changed()

    def __getattr__(self, name):
        return getattr(self.config, name)

    def to_dict(self):
        return self.config.to_dict()

2. 修改自定义类型的process_result_value方法：

def process_result_value(self, value: Optional[dict], dialect):
    if not isinstance(value, dict):
        raise ValueError("Value must be a dictionary")
    config = ConfigFlags.from_dict(value)
    return MutableConfigFlags(config)

3. 修改模型列定义，添加mutable=True：

config_flags: ConfigFlags = Column(ConfigFlagType, mutable=True)

这样修改数据类内部字段时，会自动触发SQLAlchemy的变更检测，无需手动标记。

内容的提问来源于stack exchange，提问作者Cdaman