将dataclass field用作property时如何避免元数据丢失

dataclass装饰器扫描类成员生成字段配置时，类命名空间内的同名属性会按定义顺序覆盖：你先为name赋值了携带metadata的field()实例，但后续@property装饰的name属性会直接替换掉命名空间内之前存储的field对象。dataclass最终收集字段配置时，只能拿到property对象作为name的默认值，会自动生成一个metadata为空的Field实例，之前配置的metadata自然就丢失了。

方案1：元数据绑定到实际存储的私有字段（兼容性最优） #

把需要的metadata直接配置在实际存储值的私有字段_name上，对外暴露的name仅作为property访问，不需要声明为dataclass field，这是原生dataclass下最稳定无兼容问题的写法：

from dataclasses import dataclass, field, fields

@dataclass
class Test:
    _name: str = field(init=False, default='name', repr=False, metadata={'persistence': 'DB'})
    
    @property
    def name(self):
        return self._name
    
    @name.setter
    def name(self, value):
        self._name = value

print(fields(Test))

运行后可以看到_name字段已正确携带配置的metadata，如果需要对外按公开字段名取元数据，写个简单的映射逻辑从对应私有字段读取即可。

方案2：将property作为field的default传入（保留公开字段元数据） #

如果你需要name作为公开字段直接出现在fields()返回结果中、metadata直接挂载在name字段上，可以调整定义顺序：先实现property逻辑，再声明field时将已经定义好的property作为default参数传入，避免property覆盖field配置：

from dataclasses import dataclass, field, fields

@dataclass
class Test:
    @property
    def name(self):
        return self._name
    
    @name.setter
    def name(self, value):
        self._name = value

    _name: str = field(init=False, default='name', repr=False)
    name: str = field(metadata={'persistence': 'DB'}, default=name)
        
print(fields(Test))

该写法下name字段会完整保留配置的metadata，输出中可直接看到name对应的metadata为{'persistence': 'DB'}。

提示：该方案在Python 3.10+版本行为稳定，低版本Python对descriptor类型default的处理存在差异，生产环境优先选择方案1。

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