使用deepdiff比较含时区感知datetime的数据时抛出大量错误

问题根源 #

你遇到的错误是因为DeepDiff 6.2.3对带时区信息的datetime.datetime对象的默认序列化逻辑存在缺陷：这类对象的repr格式（如datetime.datetime(2023, 2, 26, 0, 20, 2, tzinfo=datetime.timezone.utc)）包含关键字参数赋值，而DeepDiff内部的literal_eval_extended函数无法解析这种语法，导致stringify_param无法生成有效的可比较字面量，最终将对象标记为None并抛出大量报错。truncate_datetime参数仅处理datetime的精度截断，不解决序列化语法问题，因此无效。

解决方案 #

通过自定义stringify_param函数，覆盖DeepDiff的默认序列化逻辑，将带时区的datetime和date对象转换为可正确解析的格式。

具体步骤

1. 导入依赖模块

import datetime
from deepdiff import DeepDiff
from deepdiff.helper import stringify_param
import deepdiff.helper

2. 自定义序列化函数
   这个函数会优先处理带时区的datetime和自定义解包的date对象，将其转换为ISO格式的字符串repr，确保literal_eval_extended能正确解析：

def custom_stringify_param(obj, **kwargs):
    # 处理带时区的datetime
    if isinstance(obj, datetime.datetime) and obj.tzinfo is not None:
        return repr(obj.isoformat())
    # 处理datetime.date实例（适配你的自定义msgpack解包结果）
    elif isinstance(obj, datetime.date) and not isinstance(obj, datetime.datetime):
        return repr(obj.isoformat())
    # 其他类型沿用默认处理逻辑
    return stringify_param(obj, **kwargs)

3. 替换DeepDiff的默认序列化函数

deepdiff.helper.stringify_param = custom_stringify_param

4. 正常使用DeepDiff
   现在可以正常对比数据，包括使用truncate_datetime参数：

ddiff = DeepDiff(data1, data2, truncate_datetime='second')

补充说明 #

• literal_eval_extended是DeepDiff的内部辅助函数，用于将对象的repr转换为可比较的字面量，属于内部实现细节，因此官方文档未单独说明。
• 如果你需要保留datetime的原始对象结构而非字符串，也可以修改自定义函数，返回一个能被literal_eval_extended解析的合法repr（比如手动构造不带关键字参数的datetime初始化语句），但ISO格式字符串的方式更简洁且不易出错。

内容的提问来源于stack exchange，提问作者Anthon