迁移指南

Pydantic V2 对 API 进行了一些更改，包括一些破坏性更改。

此页面提供了一份指南，突出显示了最重要的更改，以帮助您将代码从 Pydantic V1 迁移到 Pydantic V2。

Install Pydantic V2

Pydantic V2 现为 Pydantic 的当前生产发布版本。可从 PyPI 安装 Pydantic V2：

pip install -U pydantic

如果遇到任何问题，请在 GitHub 中使用 bug V2 标签创建一个问题。这将有助于我们积极监控和跟踪错误，并继续改进库的性能。

如果因任何原因需要使用最新的 Pydantic V1，请参阅下面的继续使用 Pydantic V1 功能部分，以获取有关安装和从 pydantic.v1 导入的详细信息。

代码转换工具

我们创建了一个工具来帮助您迁移代码。这个工具仍处于测试阶段，但我们希望它能帮助您更快地迁移代码。

你可以从 PyPI 安装该工具：

pip install bump-pydantic

用法很简单。如果你的项目结构是：

* repo_folder
    * my_package
        * <python source files> ...

Then you'll want to do:

cd /path/to/repo_folder
bump-pydantic my_package

查看关于它在 Bump Pydantic 存储库的更多信息。

继续使用 Pydantic V1 特性

Pydantic V1 仍然可用，当你需要时，不过我们建议迁移到 Pydantic V2，因为它有改进和新功能。

如果需要使用最新的 Pydantic V1，可以用以下方式安装：

pip install "pydantic==1.*"

Pydantic V2 包也通过 pydantic.v1 导入继续提供对 Pydantic V1 API 的访问。

例如，你可以使用 Pydantic V1 的 BaseModel 类而不是 Pydantic V2 的 pydantic.BaseModel 类：

from pydantic.v1 import BaseModel

你也可以导入已从 Pydantic V2 中移除的函数，例如 lenient_isinstance ：

from pydantic.v1.utils import lenient_isinstance

Pydantic V1 文档可在 https://pydantic.com.cn/1.10/ 获得。

在 v1/v2 环境中使用 Pydantic v1 特性

截至 pydantic>=1.10.17 ， pydantic.v1 命名空间可在 V1 内使用。这使得向也支持 pydantic.v1 命名空间的 V2 迁移更容易。为了解除对 pydantic<2 依赖项的固定并继续使用 V1 功能，采取以下步骤：

1. 替换 pydantic<2 为 pydantic>=1.10.17

2. 查找并替换所有出现的：

   from pydantic. import