Python mashumaro 的 dataclass 序列化

2次阅读

mashumaro的to_dict()只序列化带类型注解且非initvar的字段,无注解字段(如nickname=”anon”)会被忽略;to_json()不支持indent参数,需先to_dict()再json.dumps(…, indent=2);datetime需显式配置metadata或serializationstrategy才能序列化。

Python mashumaro 的 dataclass 序列化

为什么 to_dict() 有时漏字段?

mashumaro 默认只序列化带类型注解且非 InitVar 的字段,没注解的变量(哪怕有默认值)会被跳过。比如 name: str = "unknown" 没问题,但 age = 42(缺类型)就进不了 to_dict() 结果。

  • 确保所有要序列化的字段都有明确类型注解,包括 Optionalunion 等复杂类型
  • 如果字段是动态加的(比如用 setattr),mashumaro 在实例化时根本看不到它,自然不会处理
  • 注意 field(default_factory=...) 需配合类型注解,否则仍可能被忽略
from mashumaro import DataClassDictMixin from typing import Optional <p>class User(DataClassDictMixin): name: str age: Optional[int] = None  # ✅ 有类型,会被序列化 nickname = "anon"          # ❌ 无类型,to_dict() 里没有

如何让 to_json() 输出带缩进的可读 JSON?

to_json() 底层调用的是 json.dumps(),但 mashumaro 默认不透出 indent 参数。直接传参会报错:TypeError: to_json() got an unexpected keyword argument 'indent'

  • 必须通过重写 __post_init__ 或自定义序列化方法绕过,更简单的是先调 to_dict() 再手动 json.dumps(..., indent=2)
  • 不要试图给 to_json() 加参数——它不支持
  • 如果项目大量需要格式化输出,建议封装一个工具函数,避免重复写 json.dumps(obj.to_dict(), indent=2)

常见误操作:以为 to_json(indent=2) 合法,实际会崩。

嵌套 dataclass 里含 datetime 字段,序列化时报 TypeError: Object of type datetime is not JSON serializable

这不是 mashumaro 的 bug,是 python 原生 json 模块的限制。mashumaro 虽内置了部分类型支持(如 datetime),但对 datetime 默认不自动转字符串——除非你显式告诉它怎么转。

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

  • 在字段上加 metadata={'serialize': 'iso'},例如:created_at: datetime = field(metadata={'serialize': 'iso'})
  • 或全局配置:继承 DataClassDictMixin 时加 SerializationStrategy,但容易过度设计
  • 注意时区:带 tzinfo 的 datetime'iso' 会保留时区信息;若后端只认 UTC 时间戳,得自己转成 timestamp() 再存为 Float

别指望 mashumaro 默默帮你处理所有时间类型——它只做最安全的默认行为,其余靠你指明。

用了 Meta 类配置 serialization_strategy,但子类没继承行为?

mashumaro 的 Meta 配置不继承父类写了 serialization_strategy = {...},子类必须重新声明,否则用的是默认策略。

  • 子类如果没定义自己的 Meta,就完全没策略,哪怕父类有
  • 多层嵌套时,每一级 dataclass 都得单独配(或统一用装饰器 + 全局策略)
  • 更稳妥的做法是把共用策略抽成常量,各处显式引用,避免漏配导致某一层时间字段突然变 None

这个不继承的特性非常容易被忽略,尤其在重构时把父类字段挪到子类,结果序列化输出悄悄变了。

text=ZqhQzanResources