Python数据类dataclass使用_简化类定义

3次阅读

@dataclass 装饰器自动实现 init__、__repr__、__eq 等方法,支持 field() 定制字段行为,frozen=true 可创建不可变实例,继承时需注意默认值顺序规则。

Python数据类dataclass使用_简化类定义

python@dataclass 装饰器能大幅简化“只用来存数据”的类定义,省去重复的手写 __init____repr____eq__ 等方法,让代码更清晰、更少出错。

自动实现常用特殊方法

加了 @dataclass 的类,默认会自动生成:

  • __init__(self, field1, field2, ...):按字段顺序生成初始化方法
  • __repr__(self):返回形如 MyClass(field1=value1, field2=value2) 的可读字符串
  • __eq__(self, other):逐字段比较两个实例是否相等(基于值,不是身份)

无需手动写这些,也避免漏掉某个字段导致逻辑不一致。

用 field() 控制单个字段行为

默认所有带注解的变量都是 dataclass 字段。若需定制,比如设默认值、禁止参与比较、延迟计算或隐藏在 repr 中,可用 field()

立即学习Python免费学习笔记(深入)”;

  • default=...default_factory=list(避免可变默认参数问题)
  • compare=False:该字段不参与 == 比较
  • repr=False:该字段不出现在 repr 输出里
  • init=False:该字段不加入 __init__ 参数(适合运行时计算或外部注入)

支持不可变实例与冻结字段

加上 @dataclass(frozen=True),实例创建后所有字段变为只读(尝试赋值会抛 FrozenInstanceError),相当于自带 __slots__ 和属性保护,适合做配置、枚举或缓存键。

注意:frozen 类中不能有 __setattr____delattr__,且所有字段必须有默认值或在 __init__ 中被赋值。

继承与默认值规则要留意

子类继承 dataclass 时,如果父类字段有默认值,子类所有字段也必须有默认值(或用 field(default=...) 显式声明),否则会报 TypeError。这是 Python 为保证 __init__ 参数顺序合理而做的强制约束。

解决办法:把无默认值的字段放在类定义最上方,有默认值的放下方;或统一用 field(default=MISSING) 协调。

text=ZqhQzanResources