跳转至

声明依赖项

最佳实践是在静态文件中声明依赖项,而不是通过即席安装来修改环境。一旦定义了依赖项,就可以锁定它们以创建一个一致、可复现的环境。

使用 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”,可以使用 --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

此格式不支持可选依赖项组。