用 vars() 转换实例为字典最简单但仅返回已赋值的实例属性,不支持 __slots__ 类;推荐优先使用 @dataclass 的 asdict() 或 pydantic.basemodel.dict(),兼顾完整性、类型安全与可维护性。

用 vars() 转换实例为字典最简单,但只返回实例属性
vars() 本质是读取对象的 __dict__,所以它只返回「已赋值的实例属性」,不包含类属性、方法、property、或未初始化的字段。
常见错误现象:定义了 __slots__ 的类调用 vars() 会直接抛出 TypeError: vars() argument must have __dict__;或者字段在 __init__ 里没显式赋值(比如用了 if condition: self.x = 1 但条件不满足),对应键就根本不会出现在结果字典里。
实操建议:
- 确保所有想导出的字段都在
__init__中被显式赋值(哪怕赋None) - 避免对
__slots__类使用vars(),改用其他方式 - 若需排除某些敏感字段(如
password),不能靠vars()自带过滤,得手动删键:data = vars(obj) data.pop('password', None)
实现 __iter__ 让类支持 dict(obj) 调用
只要类实现了 __iter__,且每次 yield 一个长度为 2 的可迭代对象(如 (key, value) 元组),就能被 dict() 构造器识别并转成字典。
注意:这不是“自动转换”,而是你主动控制哪些字段进字典、怎么取值——比如可以动态计算、跳过私有属性、或把 @property 包含进来。
实操建议:
-
__iter__必须yield,不能return列表;返回值类型必须是Iterator[Tuple[str, Any]] - 推荐用
getattr()+dir()或白名单过滤,避免遍历到方法和双下划线属性:def __iter__(self): for key in ['name', 'age', 'status']: yield key, getattr(self, key, None) - 若依赖
dir()动态获取,记得过滤掉方法和私有名:not key.startswith('_') and not callable(getattr(self, key))
__iter__ 和 vars() 在继承和动态属性上的行为差异
vars() 只看当前实例的 __dict__,父类属性、__slots__、__getattr__ 动态生成的属性全都不出现;而 __iter__ 完全由你编码控制,可以显式 include 父类字段、调用 super().to_dict()、甚至触发 __getattr__。
性能影响很小,但兼容性上要注意:
- 如果类用了
__slots__,vars()失效,__iter__是更通用的选择 - ORM 模型(如 SQLAlchemy 的
declarative_base实例)通常禁用__dict__,必须走__iter__或专用序列化方法 -
__iter__返回的键名必须是字符串,否则dict()会报TypeError: cannot convert dictionary update sequence element #0 to a sequence
别忽略 __dataclass__ 和 pydantic 这类标准方案
手写 __iter__ 或反复调 vars() 很容易漏字段、难维护。Python 3.7+ 的 @dataclass 提供了现成的 asdict(),它递归处理嵌套 dataclass、支持 field(default_factory=...),且默认跳过 init=False 字段。
实操建议:
- 新项目优先用
@dataclass+asdict(),比手写稳健得多 - 需要校验、类型转换、JSON 序列化时,
pydantic.BaseModel.dict()更合适,它天然处理Optional、datetime、嵌套模型,并支持exclude_unset=True等精细控制 - 如果只是临时调试打印,
pprint.pprint(vars(obj))比dict(obj)更安全——至少不会因__iter__写错而卡死
vars 还是 __iter__,而是字段来源混杂:一部分来自 __init__ 参数,一部分是 @property,一部分靠 __getattr__ 延迟加载,还有一部分是 ORM 的关系字段。这种时候,硬套单一机制一定会漏,得按字段性质分层处理。Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!











