tox：Python 项目的测试与构建自动化工具

tox：Python 项目的测试与构建自动化工具

tox 在 GitHub 上已经拿到近四千 Star 了。

这个工具在 Python 圈子里存在了很多年，定位很清晰：给项目提供一个统一入口，把测试、构建、发布这些重复性工作串起来，自动在隔离环境里执行完毕。

1、这玩意儿是干嘛的

Python 项目开发中有一堆机械性工作。代码要在 Python 3.9 上跑通，也要在 3.12 上验证，还要跑静态检查、打包成 wheel、检查文档能否编译成功。每做一步都要手动切环境、装依赖、执行命令，流程一长就容易漏掉某个环节。

tox 把这些步骤写进配置文件，一条命令跑完。它会自动创建虚拟环境，安装项目依赖，执行预设的命令序列，最后给出每个环境的结果汇总。

核心就三样东西：隔离环境、配置驱动、批量执行。

2、为什么需要它

很多人的第一个 Python 项目都是这么过来的：本地开发一切正常，推到 CI 就挂了。原因通常是本地和 CI 的环境不一致，或者只测了当前 Python 版本，遗漏了其他版本。

tox 解决的就是这个不一致问题。你在 tox.ini 里写好所有要测的环境和步骤，本地跑一次，CI 里也跑完全相同的配置。不会出现"我本地是好的"这种情况。

另一个场景是发布前的检查清单。打包之前要跑测试、验证安装、确认文档能正常生成。把这些全部交给 tox，一条命令验证所有环节，比人工逐项核对靠谱。

3、怎么用

最简单的配置只需要一个 tox.ini 文件。比如想在 Python 3.7 和 3.8 上分别跑 pytest：

[tox] envlist = py37,py38 [testenv] deps = pytest commands = pytest

然后在项目根目录执行tox，它就会自动创建两个虚拟环境，分别安装 pytest，然后跑测试。最后输出汇总，告诉你哪些环境通过了，哪些挂了。

配置也可以放到 pyproject.toml 里，在tool.tox下写。具体格式参考官方文档。

tox 还支持插件扩展。官方提供了不少插件来支持额外功能，比如 tox-conda 可以用 conda 环境替代 venv，tox-docker 可以在测试时启动 Docker 容器。

4、能用来做什么

除了最常见的多版本测试，tox 还能做不少事：

• 搭建开发环境：新成员加入项目，执行一条命令就装好所有依赖
• 跑静态检查：把 flake8、mypy、black 这些工具串进流程
• 自动打包：生成 wheel 和 sdist
• 验证安装：确保包在不同 Python 版本下都能正常装上
• 构建文档：把 Sphinx 文档编译流程也纳入自动化
• 发布到 PyPI：把上传流程写进配置，减少手动操作

凡是需要"在隔离环境里按固定步骤执行命令"的场景，tox 都能胜任。

5、适合哪些人

• 维护多版本兼容的 Python 库开发者
• 需要统一本地和 CI 环境的团队
• 想把发布流程自动化的项目维护者

项目文档在 Read The Docs 上有详细说明，star 数接近四千，在 Python 生态里算是老牌工具了。如果你还在手动管理测试矩阵和发布检查清单，可以看看这个。

有详细说明，star 数接近四千，在 Python 生态里算是老牌工具了。如果你还在手动管理测试矩阵和发布检查清单，可以看看这个。