Pydantic V2中自定义类型核心模式定义的最佳实践

在Pydantic V2.11版本中，对于自定义类型的核心模式定义方式进行了重要调整，这直接影响了开发者如何正确地为自定义类型实现__get_pydantic_core_schema__方法。本文将深入分析这一变更的技术背景，并提供经过验证的最佳实践方案。

问题背景

在Pydantic V2.10及之前版本中，开发者可以直接访问模型类的__pydantic_core_schema__属性，并手动构建复杂的核心模式。例如，通过组合多个模型的模式来创建联合类型或字典结构。这种方式在2.10版本中能够正常工作，但在2.11版本中会触发"类未完全定义"的错误。

技术原理

Pydantic V2.11对核心模式的处理机制进行了优化，主要是出于性能考虑。关键变化在于：

1. 定义引用机制：Pydantic内部会为模型类创建引用，避免重复定义相同的模式
2. 定义存储位置：所有定义必须存储在模式树的根部，而不是分散在各个层级
3. 模式解析顺序：2.11版本简化了定义查找逻辑，不再递归搜索整个模式树

当直接使用__pydantic_core_schema__时，这些内部定义会被"孤立"，无法被正确处理，从而导致验证失败。

推荐解决方案

Pydantic核心团队推荐使用handler.generate_schema()方法来正确生成核心模式。这种方法会：

1. 自动处理所有内部引用
2. 确保定义被正确收集和存储
3. 保持与Pydantic内部机制的一致性

对于需要自定义字典结构的场景，可以结合Python的类型注解系统：

@classmethod
def __get_pydantic_core_schema__(
    cls, source_type: Any, handler: "GetCoreSchemaHandler"
) -> pydantic_core.CoreSchema:
    return handler.generate_schema(dict[Event, TaskConfigA | TaskConfigB])

完整实现示例

以下是一个经过优化的完整实现，展示了如何正确地为自定义字典类型实现核心模式和JSON模式：

from collections import UserDict
from enum import StrEnum
from typing import Any, Literal, Union

import pydantic_core
from pydantic import BaseModel, GetCoreSchemaHandler, GetJsonSchemaHandler

class Event(StrEnum):
    START = "start"
    END = "end"

class TaskConfigA(BaseModel):
    task: Literal["A"] = "A"
    param_1: str

class TaskConfigB(BaseModel):
    task: Literal["B"] = "B"
    param_2: str

class EventTasks(UserDict[Event, list[TaskConfig]]):
    @classmethod
    def __get_pydantic_core_schema__(
        cls, source_type: Any, handler: "GetCoreSchemaHandler"
    ) -> pydantic_core.CoreSchema:
        return handler.generate_schema(dict[Event, list[TaskConfigA | TaskConfigB]])

    @classmethod
    def __get_pydantic_json_schema__(
        cls, core_schema: pydantic_core.CoreSchema, handler: "GetJsonSchemaHandler"
    ) -> JsonSchemaValue:
        json_schema = handler(core_schema)
        return handler.resolve_ref_schema(json_schema)

迁移建议

对于从Pydantic V2.10升级到2.11的项目，建议：

1. 检查所有自定义类型的__get_pydantic_core_schema__实现
2. 替换直接使用__pydantic_core_schema__的代码
3. 优先使用handler.generate_schema()方法
4. 充分利用Python的类型系统来表达复杂结构

总结

Pydantic V2.11对核心模式处理机制的优化，虽然带来了短暂的兼容性问题，但从长远来看提高了框架的性能和稳定性。通过采用推荐的方式实现自定义类型的模式定义，开发者可以构建更健壮的数据验证系统，同时确保与未来版本的兼容性。