pip-tools：打造可重复、可控的 Python 开发环境，解决依赖关系，让代码更稳定

在 Python 开发中，管理依赖关系是一项繁琐且容易出错的任务。手动更新依赖版本、处理冲突、确保一致性等等，都可能让开发者感到头疼。而 pip-tools 为开发者提供了一套稳定可靠的解决方案。

什么是 pip-tools？

pip-tools 是一组命令行工具，旨在简化 Python 依赖关系的管理，确保项目环境的稳定性和可重复性。它主要包含两个核心工具：pip-compile 和 pip-sync。

• • pip-compile: 从项目配置文件（如 pyproject.toml、setup.cfg、setup.py 或 requirements.in）中读取依赖关系信息，并生成一个包含所有依赖项及其精确版本号的 requirements.txt 文件。

• • pip-sync: 根据 requirements.txt 文件中的信息，更新虚拟环境，安装、升级或卸载所需的软件包，确保虚拟环境与 requirements.txt 文件保持一致。

为什么要使用 pip-tools？

• • 可重复性： 使用 pip-tools 可以确保每次构建环境时都使用相同的依赖项版本，从而避免由于依赖项版本不一致导致的错误，提高代码可重复性和稳定性。

• • 可控性： 手动管理依赖关系容易出错， pip-tools 可以帮助你更好地控制依赖项的版本，避免意外升级或降级。

• • 效率： pip-tools 自动化了依赖关系管理过程，节省了开发者的时间和精力，可以将更多时间投入到实际的开发工作中。

• • 易用性： pip-tools 提供简单易用的命令行界面，方便开发者使用。

• • 广泛支持： pip-tools 支持各种项目配置文件格式，包括 pyproject.toml、setup.cfg、setup.py 和 requirements.in，以及各种常见的打包工具。

pip-compile 的使用

pip-compile 命令可以从你的项目配置文件中生成 requirements.txt 文件。

基本使用:

从 pyproject.toml 生成需求

pyproject.toml 文件是最新标准的软件包和应用程序配置文件，推荐用于新项目。pip-compile 支持安装 project.dependencies 和 project.optional-dependencies。

示例:

假设你有一个名为 "foobar" 的 Python 应用程序，使用 Setuptools 进行打包，你想为生产环境锁定它。你可以将项目元数据声明为：

然后运行 pip-compile 命令即可生成 requirements.txt 文件。

从 setup.py 和 setup.cfg 生成需求

pip-compile 也完全支持使用 setuptools 的 setup.py 和 setup.cfg 项目。只需像往常一样定义依赖关系和扩展，然后运行 pip-compile。

从 requirements.in 生成需求

你也可以使用纯文本文件来声明依赖关系（例如，如果你不想将应用程序打包）。

示例:

使用 requirements.in 文件来声明 Django 依赖项：

运行 pip-compile requirements.in：

pip-sync 的使用

pip-sync 命令会根据 requirements.txt 文件中的信息更新你的虚拟环境，确保虚拟环境与 requirements.txt 文件保持一致。

基本使用:

最佳实践

• • 尽可能使用 pyproject.toml 文件来定义项目依赖关系。

• • 在项目的根目录中创建 .pip-tools.toml 配置文件，以自定义 pip-compile 和 pip-sync 的行为。

• • 将 requirements.in 和 requirements.txt 提交到版本控制系统。

• • 确保在所有开发环境中使用相同的 Python 版本和依赖项版本。

• • 定期更新依赖项版本，以获得最新的安全补丁和功能。

总结

pip-tools 是一个强大且易用的工具，可以帮助开发者轻松管理 Python 项目的依赖关系，确保代码的可重复性和稳定性。它可以有效地避免由于依赖关系管理不当而导致的错误，提高开发效率，让开发者专注于代码本身。

项目地址：https://github.com/jazzband/pip-tools