tox参数

tox参数
TOX 是一个命令行工具，专门用于管理 Python 项目的虚拟环境、运行测试和代码分析等任务。

该工具提供了一组丰富的参数，允许开发者在不同的场景下配置、运行和管理Python 项目。

本文将详细讲解 TOX 的参数，并附带例子，以帮助开发者更好地理解和使用 TOX。

1. 核心参数
1.1. -e
该参数用于指定环境名称，比如测试环境、linting 环境等，可通过该参数调用不同环境来执行相应的任务。

该参数可以用在 run、create 和 list 命令中。

例如：
tox -e py36, cover
该命令将执行名为 py36 和 cover 的两个环境。

该参数用于指定要运行的项目安装的环境数量。

默认情况下，TOX 会为每个兼容版本安装一个环境，但也可以通过该参数指定更多的环境。

例如：
tox -p 4
# 这将为每个兼容版本安装 4 个环境
1.3. --workdir
tox --workdir /path/to/folder
# 这将在 /path/to/folder 中运行 TOX
1.4. --result-json
该参数用于将测试结果输出到 JSON 文件中。

例如：
tox --result-json /path/to/folder/test-results.json
# 这将测试结果输出到 /path/to/folder/test-results.json 文件中
1.5. --parallel
该参数用于并行运行测试。

该参数可以接受一个可选的参数，用于指定并行数量。

例如：
tox --parallel 4
# 这将使用 4 个进程并行运行测试
该参数用于指定只构建源码包，而不安装其他依赖包。

这在你需要将程序部署到Docker 或虚拟机等环境时非常有用。

例如：
tox --sdistonly
# 这将只构建源码包，而不安装其他依赖包
1.7. --skip-missing-interpreters
该参数用于跳过缺失的解释器。

如果 TOX 无法在系统中找到某个 Python 解释器，则停止运行，但通过该参数可以继续运行其他可用的解释器。

例如：
tox --skip-missing-interpreters
# 如果 TOX 无法找到某个解释器，则跳过并继续运行其他解释器
2. 测试参数
该参数用于传递 pytest 命令行参数。

例如：
tox --pytest-args="-v"
# 这将传递 -v 参数给 pytest 命令
2.2. --timeout
该参数用于指定测试的最长运行时间（秒）。

例如：
tox --timeout=30
# 这将指定测试的最长运行时间为 30 秒
2.3. --recreate
该参数用于强制重新创建虚拟环境。

例如：
tox --recreate
# 这将强制重新创建虚拟环境
tox --force-dep
# 这将重新安装所有依赖包
2.5. --hashseed
该参数用于指定生成哈希值的种子。

哈希值用于验证依赖包和虚拟环境的一致性。

例如：
tox --hashseed=12345
# 这将使用 12345 作为哈希值的种子
3. 分发参数
该参数用于指定分发目录。

例如：
该参数用于构建 Python 轮廓包（wheel）。

例如：
该参数用于构建源代码分发包（sdist）。

例如：
tox --bdist-wheel --wheeldeps
# 这将构建 wheel 包，并包含所有软件包的依赖项
4. 其他参数
该参数用于显示 TOX 的版本号。

例如：
tox --version
# 这将显示 TOX 的版本号。