测试配置¶

请参阅测试概览教程，获取更全面的操作指南。

设置项（Settings）¶

如果某个选项在 test 命令中有对应的命令行参数，则该参数始终优先生效。

默认参数¶

你可以通过设置 default-args 选项为字符串数组，定义 test 命令的默认参数。以下是默认配置：

[tool.hatch.envs.hatch-test]
default-args = ["tests"]

[envs.hatch-test]
default-args = ["tests"]

额外参数¶

你可以通过设置 extra-args 选项为字符串数组，为测试脚本定义额外的内部参数。例如，如果你希望提高 pytest 的输出详细程度，可以如下设置：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
extra-args = ["-vv"]

[envs.hatch-test]
extra-args = ["-vv"]

测试顺序随机化¶

你可以启用 randomize 选项来随机化测试顺序，对应的命令行参数为 --randomize/-r：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
randomize = true

[envs.hatch-test]
randomize = true

测试并行执行¶

你可以启用 parallel 选项来并行化测试执行，对应的命令行为 --parallel/-p：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
parallel = true

[envs.hatch-test]
parallel = true

重试失败的测试¶

你可以设置 retries 选项来重试失败的测试，对应命令行为 --retries：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
retries = 2

[envs.hatch-test]
retries = 2

你还可以通过设置 retry-delay 选项来指定重试间隔的秒数，对应命令行为 --retry-delay：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
retry-delay = 1

[envs.hatch-test]
retry-delay = 1

自定义环境¶

你可以完全改变 test 命令所使用环境的行为。

依赖项¶

你可以定义测试所需的额外依赖项：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
extra-dependencies = [
  "pyfakefs",
  "pytest-asyncio",
  "pytest-benchmark",
  "pytest-memray",
  "pytest-playwright",
  "pytest-print",
]

[envs.hatch-test]
extra-dependencies = [
  "pyfakefs",
  "pytest-asyncio",
  "pytest-benchmark",
  "pytest-memray",
  "pytest-playwright",
  "pytest-print",
]

以下是默认配置：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
dependencies = [
  "coverage-enable-subprocess==1.0",
  "coverage[toml]~=7.4",
  "pytest~=8.1",
  "pytest-mock~=3.12",
  "pytest-randomly~=3.15",
  "pytest-rerunfailures~=14.0",
  "pytest-xdist[psutil]~=3.5",
]

[envs.hatch-test]
dependencies = [
  "coverage-enable-subprocess==1.0",
  "coverage[toml]~=7.4",
  "pytest~=8.1",
  "pytest-mock~=3.12",
  "pytest-randomly~=3.15",
  "pytest-rerunfailures~=14.0",
  "pytest-xdist[psutil]~=3.5",
]

矩阵（Matrix）¶

你可以重写默认的一组矩阵配置：

pyproject.toml hatch.toml

[[tool.hatch.envs.hatch-test.matrix]]
python = ["3.13", "3.12", "3.11", "3.10", "3.9", "3.8"]

[[envs.hatch-test.matrix]]
python = ["3.13", "3.12", "3.11", "3.10", "3.9", "3.8"]

脚本¶

如果你希望修改默认执行的命令，可以重写 scripts。以下默认脚本必须重新定义：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test.scripts]
run = "pytest{env:HATCH_TEST_ARGS:} {args}"
run-cov = "coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}"
cov-combine = "coverage combine"
cov-report = "coverage report"

[envs.hatch-test.scripts]
run = "pytest{env:HATCH_TEST_ARGS:} {args}"
run-cov = "coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}"
cov-combine = "coverage combine"
cov-report = "coverage report"

run 脚本是默认行为；当需要统计代码覆盖率时，将改用 run-cov 脚本。所有测试完成后会执行 cov-combine 脚本，如果未使用 --cover-quiet 参数，还会执行 cov-report 脚本。

Note

HATCH_TEST_ARGS 环境变量用于在不影响用户参数的情况下，将 test 命令的标志位转换为内部参数。这也是传递额外参数的方式。

安装器（Installer）¶

默认情况下，UV 是启用的。你可以如下禁用该行为：

pyproject.toml hatch.toml

[tool.hatch.envs.hatch-test]
installer = "pip"

[envs.hatch-test]
installer = "pip"