datamodel-code-generator中_deep_merge()函数导致的列表值突变问题分析

在datamodel-code-generator项目中，一个关于JSON Schema解析的bug引起了我们的注意。这个bug会导致在特定情况下生成的Pydantic模型不正确，具体表现为模型字段的required属性出现异常。

问题背景

datamodel-code-generator是一个用于从JSON Schema生成Pydantic模型的工具。在解析JSON Schema时，特别是处理包含anyOf等组合模式的复杂Schema时，工具需要合并多个Schema定义。这个合并过程通过_deep_merge()函数实现。

问题表现

当处理包含anyOf组合的Schema时，生成的模型会出现字段required属性不正确的情况。例如，对于以下Schema：

{
  "type": "object",
  "properties": {
    "foo": {
      "type": "object",
      "required": ["bar"],
      "anyOf": [
        {"required": ["baz"]},
        {"required": ["qux"]}
      ],
      "properties": {
        "bar": {"type": "integer"},
        "baz": {"type": "integer"},
        "qux": {"type": "integer"}
      }
    }
  }
}

预期应该生成两个不同的模型变体：一个要求baz字段，另一个要求qux字段。但实际上，生成的模型错误地将baz字段标记为在两个变体中都是必需的。

根本原因

问题的根源在于_deep_merge()函数中对列表合并的实现方式发生了变化。在修复前的版本中，代码使用：

result[key] = result[key] + value

这种方式会创建一个新的列表对象。而在有问题的版本中，代码被改为：

result[key] += value

虽然这两种写法在简单情况下效果相同，但对于可变对象（如列表）来说，+=操作符会就地修改原列表，而+操作符会创建新列表。这个细微差别导致了基础Schema对象在合并过程中被意外修改。

技术细节

在parse_combined_schema()函数中，代码首先创建基础Schema对象的副本：

base_object = obj.dict(exclude={target_attribute_name}, exclude_unset=True, by_alias=True)

然后遍历anyOf中的每个Schema进行合并。由于_deep_merge()会就地修改传入的字典，第一次合并后，base_object中的required列表就被修改了，导致后续合并时错误地保留了前一次合并的结果。

解决方案

修复方案很简单：恢复使用列表相加而非+=操作符的方式。这样可以确保每次合并都基于原始的基础Schema，不会受到前次合并的影响。

经验教训

这个案例展示了几个重要的编程实践：

1. 在使用可变对象时要格外小心，特别是当它们被多个地方共享时
2. 看似等价的代码可能有不同的副作用
3. 自动化的代码风格检查工具（如ruff）的建议有时会改变代码语义，需要谨慎评估
4. 对于合并/复制操作，明确创建新对象通常比就地修改更安全

总结

这个bug提醒我们，在处理复杂数据结构时，特别是涉及嵌套和可变对象时，需要特别注意操作的副作用。在datamodel-code-generator这样的代码生成工具中，确保生成的模型正确性至关重要，因为任何微小的差异都可能导致生成的代码行为不符合预期。