当requirements.txt文件变更时，如何更新tox虚拟环境？

通常修改tox.ini文件中的deps配置时，tox会检测到变更并重新创建包含新依赖的virtualenv。但如果使用deps = -r requirements.txt从requirements.txt文件读取依赖，当requirements.txt变更时，tox不会更新virtualenv。如何让tox虚拟环境自动与requirements.txt文件保持同步？

背景说明 #

• 当直接在tox.ini的deps中列出依赖时，修改deps后，下次运行tox会自动重建virtualenv并安装新依赖。
• 当通过-r requirements.txt引用外部依赖文件时，tox仅监控tox.ini的变化，无法感知requirements.txt的更新，导致虚拟环境依赖始终停留在旧版本。
• 理想需求：无需重建整个virtualenv，而是原地更新依赖（安装/升级/移除包），让环境与requirements.txt保持同步。

解决方案 #

方法1：添加前置命令原地更新依赖 #

在testenv配置中增加commands_pre，每次运行tox前先执行依赖更新命令，确保环境与requirements.txt同步。

修改后的tox.ini示例：

[tox]
skipsdist = true

[testenv]
deps = -r requirements.txt
# 每次运行测试前先更新依赖
commands_pre = pip install -r requirements.txt --upgrade
commands = pylint --version

说明：

• commands_pre中的命令会在commands之前执行，强制用最新的requirements.txt更新环境依赖。
• 无需重建virtualenv，直接在现有环境中升级/安装缺失的包，节省时间。

方法2：让tox监控requirements.txt的变化 #

通过files选项告诉tox监控requirements.txt，当文件内容变化时，触发依赖重新安装。

修改后的tox.ini示例：

[tox]
skipsdist = true

[testenv]
deps = -r requirements.txt
# 指定需要监控的文件，变化时触发环境更新
files = requirements.txt
# 自定义安装命令，确保依赖完全匹配requirements.txt
install_command = pip install -r requirements.txt --force-reinstall
commands = pylint --version

说明：

• files选项让tox检测requirements.txt的变更，一旦文件修改，tox会重新执行依赖安装步骤。
• --force-reinstall确保依赖完全匹配requirements.txt，避免缓存导致的版本不一致。
• 这种方式会重新安装依赖，但不会完全重建virtualenv（仅更新依赖部分），比重建环境更高效。

方法3：利用哈希值触发依赖更新 #

通过计算requirements.txt的哈希值，将其作为deps的一部分，当文件变化时哈希值改变，tox会认为deps配置变更，从而重新安装依赖。

步骤1：修改tox.ini

[tox]
skipsdist = true

[testenv]
deps =
    -r requirements.txt
    # 用环境变量传递requirements.txt的哈希值
    req-hash=={env:REQ_HASH}
commands = pylint --version

步骤2：运行tox前计算哈希值

# 计算requirements.txt的SHA256哈希（Linux/macOS）
export REQ_HASH=$(sha256sum requirements.txt | awk '{print $1}')
# Windows系统可使用certutil命令
# export REQ_HASH=$(certutil -hashfile requirements.txt SHA256 | findstr /v "SHA256" | findstr /v "CertUtil")
tox

说明：

• 当requirements.txt内容变化时，哈希值REQ_HASH改变，tox会检测到deps变更，重新安装依赖。
• 这种方式会触发virtualenv的重建（因为deps标识变化），适合需要完全干净环境的场景。

内容的提问来源于stack exchange，提问作者Sean Hammond