跳转至

声明依赖

最佳实践是通过静态文件声明依赖项,而不是通过临时安装方式修改环境。定义好依赖后,可以通过锁定来创建一致且可复现的环境。

使用 pyproject.toml

pyproject.toml 文件是 Python 项目标准的配置文件。

pyproject.toml 文件中定义项目依赖:

pyproject.toml
[project]
dependencies = [
  "httpx",
  "ruff>=0.3.0"
]

pyproject.toml 文件中定义可选依赖:

pyproject.toml
[project.optional-dependencies]
cli = [
  "rich",
  "click",
]

每个键定义了一个 “额外项”,可以使用 --extra--all-extras 标志或 package[<extra>] 语法来安装。更多详细信息,请参阅安装包的文档。

有关 pyproject.toml 入门的更多详细信息,请参阅官方的pyproject.toml 指南

使用 requirements.in

使用轻量级的 requirements.txt 格式来声明项目依赖也很常见。每个依赖项单独占一行。通常,这个文件被称为 requirements.in,以区别于用于锁定依赖项的 requirements.txt

requirements.in 文件中定义依赖:

requirements.in
httpx
ruff>=0.3.0

这种格式不支持可选依赖组。