Django-Ninja 与 Pydantic 2.7.0 版本兼容性问题的分析与解决

在开发基于 Django-Ninja 的 API 项目时，我们可能会遇到 Pydantic 版本升级带来的兼容性问题。最近，Pydantic 2.7.0 版本与 Django-Ninja 1.1.0 版本在某些特定场景下出现了不兼容的情况，导致验证过程中抛出异常。

问题现象

当使用 Pydantic 2.7.0 版本时，在以下特定场景会出现验证失败：

1. 使用了带有 ConfigDict(extra="forbid") 配置的 Schema 类
2. 结合了 RootModel 和 discriminated unions（带鉴别器的联合类型）
3. 包含嵌套的 Schema 结构

错误表现为在验证过程中抛出 PanicException，提示 Python API 调用失败，特别是在 _run_root_validator 方法中处理带有 extra="forbid" 配置的 Schema 时。

问题重现

以下是一个能够重现该问题的简化代码示例：

from typing import Annotated, Literal
from ninja import Schema, Field
from pydantic import ConfigDict, RootModel

class ExtraForbidSchema(Schema):
    model_config = ConfigDict(extra="forbid")

class AbstractProfileIn(ExtraForbidSchema):
    first_name: str | None = None
    last_name: str | None = None

class NewUserBOIn(ExtraForbidSchema):
    email: str
    role: str
    project_id: int | None = None

class AdminProfileIn(AbstractProfileIn):
    first_name: str
    last_name: str

class AdminBOIn(NewUserBOIn):
    site_ids: list[int] | None = Field(None, json_schema_extra={"deprecated": True})
    role: Literal["ADMIN"]
    profile: AdminProfileIn

class HCProfileIn(AbstractProfileIn):
    first_name: str
    last_name: str

class HCPBOIn(NewUserBOIn):
    role: Literal["HCP"]
    project_id: int
    profile: HCProfileIn

class NewUserBOUnionIn(Schema, RootModel):
    root: Annotated[(HCPBOIn | AdminBOIn), Field(discriminator="role")]

当尝试使用这个 Schema 验证数据时，Pydantic 2.7.0 会抛出异常。

问题原因

这个问题的根本原因在于 Pydantic 2.7.0 版本在处理带有 extra="forbid" 配置的 Schema 时，与 Django-Ninja 的 DjangoGetter 机制产生了冲突。DjangoGetter 是 Django-Ninja 用来处理 Django 模型和查询集的一个包装器，它在某些情况下会与 Pydantic 的严格模式验证产生不兼容。

解决方案

Pydantic 团队在 2.7.1 版本中修复了这个问题。升级到 Pydantic 2.7.1 后，上述问题将不再出现。

建议的解决方案：

1. 升级 Pydantic 到 2.7.1 或更高版本
2. 如果暂时无法升级，可以暂时将 extra="forbid" 配置移除（但这会降低数据验证的严格性）

最佳实践

在使用 Django-Ninja 时，特别是结合复杂的 Pydantic Schema 时，建议：

1. 保持 Pydantic 和 Django-Ninja 都更新到最新稳定版本
2. 在使用 discriminated unions 和 RootModel 时，注意测试各种边界情况
3. 对于关键业务逻辑，考虑添加额外的测试用例覆盖 Schema 验证场景
4. 在升级依赖时，先在开发环境充分测试，再部署到生产环境

通过这次问题的解决，我们可以看到开源社区快速响应和修复问题的能力。作为开发者，及时关注依赖库的更新和变更日志，能够帮助我们更好地预防和解决类似问题。