Python 教程 / 用 dataclass 定义数据记录

dataclass 是根据字段声明生成初始化、对象表示和相等比较等方法的标准库功能,适合表达数据记录。它减少重复代码,但不会自动验证类型注解或业务规则;哪些输入有效、修改后是否仍有效,仍需单独设计。

减少数据记录的重复方法

@dataclass从类的类型注解识别字段,通常生成 __init__、__repr__ 和 __eq__。相比普通记录类,便于集中看到名称、金额和标签等数据结构;但并非所有复杂行为对象都应该改成 dataclass。

需要每个实例拥有独立列表时,使用 field(default_factory=list)。这里传入 list 这个创建函数,在需要默认值时调用它;不是调用 list() 后把同一个列表当成所有对象的默认值。它与实例属性与共享列表讨论的是同一个独立性问题。

方法生成、字段配置与适用条件见Python 官方 dataclasses 文档。默认生成的表示会展示字段值,因此也不要把包含敏感数据的完整对象表示直接写入公开日志。

运行独立标签和字段比较示例

将以下完整内容以 UTF-8 保存为 data_records.py,在项目环境执行 python data_records.py。若已核对的解释器命令为 python3,则使用 python3 data_records.py。本例仅使用标准库:

from dataclasses import dataclass, field

@dataclass
class Expense:
    name: str
    amount: int
    tags: list[str] = field(default_factory=list)

    def __post_init__(self):
        if type(self.amount) is not int or self.amount < 0:
            raise ValueError("invalid amount")

a = Expense("lunch", 8000)
b = Expense("bus", 2500)
a.tags.append("work")
print(a)
print(b.tags)
print(a == Expense("lunch", 8000, ["work"]))

预期输出:

Expense(name='lunch', amount=8000, tags=['work'])
[]
True

a 的默认标签列表增加 work 后,b.tags 仍为空,说明默认工厂创建了独立列表。打印 a 使用生成的对象表示;最后新建一个字段内容相同的 Expense,默认相等比较得到 True。这不意味着两个变量指向同一个对象。

__post_init__ 是生成的初始化方法完成字段赋值后调用的后处理方法。本例明确要求 amount 是非负整数,排除 bool 和小数。name: str 与 tags: list[str] 只是注解,本例并没有因此自动检查名称和每一个标签的实际类型。

区分初始验证、修改与 frozen

__post_init__ 验证发生在创建阶段;之后直接执行 a.amount = -1 不会自动再次调用它。若要求整个生命周期都保持规则,可以考虑property 的赋值验证或按需求采用不可变状态设计,而不是假设 dataclass 已处理所有修改。

frozen=True限制普通字段重新赋值,但不会冻结字段所引用的每个对象。将装饰器改成 @dataclass(frozen=True) 后,a.amount = 9000 会被拒绝,而 a.tags.append("extra") 仍可修改列表内容。若需要不可变的标签,应选择元组等适合的内部结构,并审查更深层对象。

默认工厂只负责默认值。若你显式把同一个列表传给两个实例,它们仍可能共享该列表;需要复制时也应明确复制的层次。不能仅看到字段声明使用 default_factory,就认定所有构造方式都没有别名共享。

明确相等含义与保存规则

默认相等比较检查同一具体类型的字段内容,并不是交易身份验证。两笔不同时间发生的午餐可以有相同名称、金额与标签,仍是两次交易。用于查重或关联时应另外设计标识与业务比较规则。

dataclasses.asdict将记录转换为字典并递归处理相关结构,但它不决定外部存储格式,也不会让日期、Decimal 等值自动成为可直接编码的 JSON。可以结合JSON 序列化与验证,分别检查转换后的字段与真正的文件读写结果。

  1. 将第一笔金额 8000 改为 -1,运行应在创建时抛出 ValueError: invalid amount;恢复后再核对原始输出。
  2. 在原始程序末尾临时打印 a.tags is b.tags,应为 False。再给 b.tags 添加一个标签,确认 a.tags 不随之变化。
  3. 使用上述 frozen 装饰器做独立副本实验,分别检查字段赋值被拒绝与内部列表仍可追加;不要把其中一个结果当作另一个也已经验证。
  4. 恢复普通 @dataclass 与原始代码,重新核对表示、空列表和 True 三行输出。

选择字段时,将默认值、验证、相等语义与序列化分开思考。dataclass 可以减少样板方法,但这些领域规则仍需由程序的实际用途决定。