在本地运行 SciPy 测试#

基本测试编写和执行从 Python 解释器内部进行,在 NumPy/SciPy 测试指南 中有记录。此页面包含有关使用 SciPy 的 dev.py 命令行工具从命令行运行测试的信息。注意:开始之前,请确保 pytest 已安装。

注意

dev.py 接口是自文档化的,这意味着此页面上所有内容以及更多内容(包括每个命令的用法示例)都可以通过 python dev.py --help 访问,对于单个命令(如 python dev.py <command-name> --help)也是如此。在这种情况下,您可以查看 python dev.py test --help

要运行所有测试,请在命令行中导航到 SciPy 根目录并执行

python dev.py test

这将构建 SciPy(或更新现有构建)并运行测试。

要对特定子模块(如 optimize)运行测试,请使用 --submodule 选项

python dev.py test -s optimize

要运行特定测试模块,请使用 Pytest 语法 --test(或 -t

python dev.py test -t scipy.<module>.tests.<test_file>

以下示例为 scipy/optimize/tests/test_linprog.py 文件测试,运行

python dev.py test -t scipy.optimize.tests.test_linprog

要运行测试类

python dev.py test -t scipy.<module>.tests.<test_file>::<TestClass>

以下示例为 test_linprog.py 中的 TestLinprogRSCommon

python dev.py test -t scipy.optimize.tests.test_linprog::TestLinprogRSCommon

要运行特定测试

python dev.py test -t scipy.<module>.tests.<test_file>::<test_name>

以下示例为 test_linprog.py 中的 test_unknown_solvers_and_options

python dev.py test -t scipy.optimize.tests.test_linprog::test_unknown_solvers_and_options

对于类内的测试,您需要指定类名和测试名

python dev.py test -t scipy.<module>.tests.<test_file>::<TestClass>::<test_name>

示例

python dev.py test -t scipy.optimize.tests.test_linprog::TestLinprogRSCommon::test_nontrivial_problem_with_guess

其他有用的选项包括

  • -v--verbose,它会激活详细选项以获得更详细的输出。

  • --coverage 以在 scipy/build/coverage/index.html 中生成测试覆盖率报告。注意: pytest-cov 必须安装。

  • -n--no-build 以防止 SciPy 在测试之前更新构建

  • -j--parallel n 用于在构建 SciPy 时使用 n 个核心;例如 python dev.py test -j 4 使用四个核心。从 #10172 开始,如果安装了 pytest-xdist,它也会在四个核心上运行测试。

  • -m full--mode full 用于运行“完整”测试套件,包括标记为 slow 的测试(例如,使用 @pytest.mark.slow)。请注意,这不会运行标记为 xslow 的测试;请参阅下面的技巧。

  • -- 用于将剩余的命令行参数发送到 pytest 而不是 dev.py test。例如,虽然发送到 pytest.py-n 会激活 --no-build 选项,但发送到 pytest-n 会在多个核心上运行测试;例如 python dev.py test -- -n 4 使用四个核心运行测试。注意: pytest-xdist 必须安装才能在多个核心上进行测试。 pytest 的常见命令行参数包括

    • --durations=m 用于显示最慢的 m 个测试的持续时间。使用 --durations=0 以及 --durations-min=x 来显示所有持续时间超过 x 秒的测试的持续时间。

    • --fail-slow=x 用于在测试时间超过 x 秒时导致测试失败。(注意:必须安装 pytest-fail-slow。)

    • --timeout=x 用于在任何测试时间超过 x 秒时停止所有测试执行。(注意:必须安装 pytest-timeout。)

有关 pytest 的更多信息,请参阅 pytest文档

技巧:#

如果您从源代码构建了 SciPy,但在更改代码库后无法运行测试,请尝试删除 scipy/build 目录。这会强制 dev.py 在执行测试之前完全重建 SciPy。

还有一个级别的非常慢的测试(几分钟),即使调用 python dev.py test -m full 也会被禁用。可以通过在运行测试套件之前设置环境变量 SCIPY_XSLOW=1 来启用它们。

默认情况下,使用 Hypothesis 运行的测试使用在 scipy/scipy/conftest.py 中定义的 deterministic 配置文件。此配置文件包含 Hypothesis 设置 derandomize=True,因此直到 Hypothesis、Python 或测试函数更新之前,才会使用相同的示例。要更好地利用 Hypothesis 查找反例的能力,请在运行测试套件之前通过设置环境变量 SCIPY_HYPOTHESIS_PROFILE=nondeterministic 来选择 nondeterministic 配置文件。可以通过编辑选定的配置来配置运行的示例数量,例如,添加 max_examples=100_000