用 Python dataclass 替代“裸字典”,让数据结构更清晰
写 Python 脚本时,很多人习惯用字典传递数据:user = {"name": "Tom", "age": 18}。小脚本里这样没问题,但项目稍大,字典就会带来几个麻烦:键名拼错只能运行时才发现、编辑器没有补全、字段含义靠猜。Python 3.7 引入的 dataclasses 模块可以用很少的代码解决这些问题。
1. 基本用法
from dataclasses import dataclass
@dataclass
class User:
name: str
age: int
email: str = ""
u = User("Tom", 18)
print(u) # User(name='Tom', age=18, email='')
print(u.name)
装饰器会自动生成 __init__、__repr__ 和 __eq__,不用手写样板代码。打印对象时直接能看到所有字段,调试很方便。
2. 默认值与可变默认值的坑
字段默认值如果是列表或字典,不能直接写 tags: list = [],dataclass 会直接报错,防止多个实例共享同一个对象。正确写法是 field(default_factory=list):
from dataclasses import dataclass, field
@dataclass
class Article:
title: str
tags: list[str] = field(default_factory=list)
3. 不可变对象:frozen=True
如果希望对象创建后不能被修改(例如配置、坐标),可以加 frozen=True:
@dataclass(frozen=True)
class Point:
x: float
y: float
修改属性会抛出 FrozenInstanceError。frozen 的对象还可以作为字典的键或放进集合,因为它会自动生成 __hash__。
4. 排序与比较
加上 order=True 后,实例可以按字段顺序比较大小:
@dataclass(order=True)
class Version:
major: int
minor: int
print(Version(1, 2) < Version(1, 10)) # True
这比手写 __lt__ 简单得多。注意比较顺序就是字段定义顺序。
5. 初始化后处理
需要校验或派生字段时,使用 __post_init__:
@dataclass
class Rect:
w: float
h: float
area: float = field(init=False)
def __post_init__(self):
if self.w <= 0 or self.h <= 0:
raise ValueError("宽高必须为正数")
self.area = self.w * self.h
init=False 表示这个字段不出现在构造函数参数里,由 __post_init__ 计算。
6. 与字典、JSON 互转
from dataclasses import asdict
import json
u = User("Tom", 18)
text = json.dumps(asdict(u), ensure_ascii=False)
u2 = User(**json.loads(text))
asdict 会递归地把嵌套的 dataclass 也转成字典,用来写 JSON 日志或接口返回都很顺手。
7. 什么时候不用
- 需要运行时严格类型校验:dataclass 的类型注解只是提示,不会强制检查,这种场景可考虑 pydantic。
- 只是临时返回两三个值:用普通元组或
NamedTuple更轻量。 - 字段极多且全是动态的:字典反而更合适。
小结
dataclass 的价值在于:用声明式的方式描述数据长什么样,同时拿到构造、打印、比较、哈希这些常用能力。把项目里到处传递的“裸字典”逐步换成 dataclass,代码可读性和 IDE 提示都会明显提升,重构时也更安心。建议从最常用的几个数据结构开始替换,一次改一处,配合类型检查工具(如 mypy)效果更好。
- 点赞
- 收藏
- 关注作者
评论(0)