Synthetic Data Generator 项目中 Metadata 扩展属性保存问题分析

问题背景

在 Synthetic Data Generator (SDG) 项目中，Metadata 类用于存储和管理数据集的元信息。元数据不仅包含数据集的基本统计信息，还支持通过 add() 方法添加自定义的扩展属性。然而，近期发现当 Metadata 对象被序列化为 JSON 文件并重新加载后，这些扩展属性会丢失。

问题现象

当开发者使用 Metadata 类时，通过 add() 方法添加的自定义属性（存储在 _extend 字段中）在以下过程中会丢失：

1. 创建 Metadata 对象并添加自定义属性
2. 将对象保存为 JSON 文件
3. 从文件重新加载 Metadata 对象
4. 检查之前添加的自定义属性已不存在

技术分析

根本原因

问题的根源在于 Pydantic 模型的序列化机制。Metadata 类继承自 Pydantic 的 BaseModel，当调用 model_dump_json() 方法时：

1. Pydantic 默认不会序列化以下划线开头的"私有"属性
2. _extend 作为 Metadata 的内部字典，恰好以下划线开头
3. 因此序列化时 _extend 内容被忽略
4. 反序列化时自然无法恢复这些数据

影响范围

此问题影响所有需要持久化保存自定义元数据的场景，特别是：

• 需要保存额外数据特征的机器学习流程
• 需要记录数据处理历史的ETL流程
• 需要附加业务元数据的数据管理场景

解决方案

临时解决方案

目前可以通过以下方式临时规避问题：

1. 避免直接使用 _extend 添加自定义属性
2. 或者在使用前手动将 _extend 内容复制到可序列化的公共字段

长期解决方案

更完善的解决方案应包括：

1. 修改 Metadata 类，显式声明 _extend 为可序列化字段
2. 或者提供专门的接口方法来管理扩展属性
3. 实现自定义的序列化/反序列化逻辑

最佳实践建议

在使用 SDG 的 Metadata 功能时，建议：

1. 对于需要持久化的元数据，优先使用官方支持的字段
2. 如果必须使用扩展属性，考虑实现自定义的保存/加载逻辑
3. 定期检查元数据的完整性，特别是在持久化操作后

总结

Metadata 扩展属性的持久化问题是 SDG 项目中的一个重要缺陷，会影响需要保存自定义元数据的应用场景。理解其根本原因有助于开发者规避问题，同时也为项目未来的改进提供了方向。随着项目的迭代，这一问题有望得到官方修复，使元数据管理功能更加完善可靠。