贡献

我们欢迎您为 PydanticAI 做出贡献！

安装与设置

克隆您的 fork 并 cd 进入 repo 目录

git clone git@github.com:<your username>/pydantic-ai.git
cd pydantic-ai

安装 uv (版本 0.4.30 或更高版本) 和 pre-commit

我们在这里使用 pipx，有关其他选项，请参阅

• uv 安装文档
• pre-commit 安装文档

要获取 pipx 本身，请参阅 这些文档

pipx install uv pre-commit

安装 pydantic-ai、所有依赖项和 pre-commit 钩子

make install

运行测试等

我们使用 make 来管理您需要运行的大多数命令。

有关可用命令的详细信息，请运行

make help

要运行代码格式化、linting、静态类型检查以及带有覆盖率报告生成的测试，请运行

make

文档变更

要在本地运行文档页面，请运行

uv run mkdocs serve

向 PydanticAI 添加新模型的规则

为了避免 PydanticAI 维护者承担过多的工作量，我们无法接受所有模型贡献，因此我们设定了以下规则，规定何时接受新模型以及何时不接受。这应该有望减少失望和浪费工作的可能性。

• 要添加具有额外依赖项的新模型，该依赖项需要在 3 个月或更长时间内持续保持每月 > 50 万次来自 PyPI 的下载量
• 要添加使用其他模型逻辑的内部模型且没有额外依赖项，该模型的 GitHub 组织需要总共 > 2 万颗星
• 对于任何其他只是自定义 URL 和 API 密钥的模型，我们很乐意添加一段包含链接和 URL 使用说明的段落描述
• 对于任何其他需要更多逻辑的模型，我们建议您发布自己的 Python 包 pydantic-ai-xxx，它依赖于 pydantic-ai-slim 并实现一个从我们的 Model ABC 继承的模型

如果您不确定是否要添加模型，请创建 issue。