在 Visual Studio Code 中进行 Python 测试

Python 扩展构建在 VS Code 内置的测试功能之上，为 Python 的内置 unittest 框架和 pytest 提供了测试发现、测试覆盖率以及运行和调试测试的功能。

配置测试

安装 Python 扩展并在编辑器中打开 Python 文件后，VS Code 活动栏上会显示一个烧杯图标，代表测试资源管理器 (Test Explorer) 视图。如果尚未启用测试框架，打开测试资源管理器会显示配置 Python 测试 (Configure Python Tests) 按钮。选择配置 Python 测试后，系统会提示您选择测试框架以及包含测试的文件夹。如果您使用 unittest，还需要选择用于识别测试文件的文件 glob 模式。

您可以随时通过命令面板使用 Python: Configure Tests 命令，或按照 VS Code 设置文档所述，在设置编辑器或 settings.json 文件中设置 python.testing.unittestEnabled 或 python.testing.pytestEnabled 来配置测试。每个框架还有特定的配置设置，详见测试配置设置中关于其文件夹和模式的说明。

如果您启用了 pytest 但它尚未安装在激活的环境中，Python 扩展会尝试在后台安装它。此外，如果同时启用了两个框架，Python 扩展将仅运行 pytest。

测试发现

默认情况下，一旦启用框架，Python 扩展就会尝试发现测试。您可以随时使用命令面板中的 Test: Refresh Tests 命令触发测试发现。

测试发现会应用当前框架的发现模式（可以使用测试配置设置进行自定义）。默认行为如下：

• python.testing.unittestArgs：在顶级项目文件夹中查找名称中包含 "test" 的任何 Python (.py) 文件。所有测试文件必须是可导入的模块或包。您可以使用 -p 配置设置自定义文件匹配模式，并使用 -t 设置自定义文件夹。

• python.testing.pytestArgs：查找名称以 "test_" 开头或以 "_test" 结尾的任何 Python (.py) 文件，这些文件位于当前文件夹及其所有子文件夹中。

如果测试发现成功，您将在测试资源管理器中看到列出的测试。

直接从测试资源管理器触发测试发现时，您也可以取消正在进行的测试发现调用。使用 Cancel 按钮，该按钮在发现期间会替换 Refresh 按钮。

如果发现失败（例如，未安装测试框架或测试文件中存在语法错误），测试资源管理器中会显示一条错误消息，其中包含指向日志的链接。您可以查看 Python 输出面板以查看完整的错误消息（使用 View > Output 菜单命令显示 Output 面板，然后在右侧的下拉菜单中选择 Python）。

运行测试

您可以使用以下任何操作运行测试：

• 在打开测试文件的情况下，选择显示在测试定义行旁边的绿色运行图标（如前一节所示）。此命令仅运行该特定方法。

  

• 从命令面板运行以下任何命令：

  • Test: Run All Tests - 运行所有已发现的测试。
  • Test: Run Tests in Current File - 运行编辑器中打开的文件中的所有测试。
  • Test: Run Test at Cursor - 仅运行编辑器中光标下的测试方法。

• 从测试资源管理器中：

  • 要运行所有已发现的测试，请选择测试资源管理器顶部的播放按钮。

    

  • 要运行特定的一组测试或单个测试，请选择文件、类或测试，然后选择该项目右侧的播放按钮。

    

  • 您还可以通过测试资源管理器运行选定的一组测试。为此，请 Ctrl+Click（macOS 上为 Cmd+Click）选择您想要运行的测试，右键单击其中一个，然后选择 Run Test。

测试运行后，VS Code 会直接在编辑器中将结果显示为装订线装饰（gutter decorations）。失败的测试也会在编辑器中高亮显示，并带有 Peek View，显示测试运行的错误消息和所有测试运行的历史记录。您可以按 Escape 关闭该视图，也可以通过打开用户设置（在命令面板中输入 Preferences: Open Settings (UI)）并将 Testing: Automatically Open Peek View 设置的值更改为 never 来禁用它。

在测试资源管理器中，结果显示在单个测试以及包含这些测试的类和文件中。如果文件夹中的任何测试未通过，文件夹将显示失败图标。

VS Code 也会在 Test Results 面板中显示测试结果。

运行测试并查看覆盖率

要运行已启用覆盖率的测试，请选择测试资源管理器中的覆盖率运行图标，或从您通常触发测试运行的任何菜单中选择 Run with coverage 选项。如果您使用的是 pytest，Python 扩展会使用 pytest-cov 插件运行覆盖率；如果您使用的是 unittest，则使用 coverage.py。

覆盖率运行完成后，编辑器中会高亮显示行级覆盖率。测试覆盖率结果会作为“测试覆盖率”子选项卡出现在测试资源管理器中，您也可以通过命令面板中的 Testing: Focus on Test Coverage View (⇧⌘P（Windows, Linux Ctrl+Shift+P）) 进行导航。在此面板上，您可以查看工作区中每个文件和文件夹的行覆盖率指标，以及相关的分支覆盖率。

使用 pytest 时，若要对覆盖率运行进行更精细的控制，可以编辑 python.testing.pytestArgs 设置以包含您的规范。当 python.testing.pytestArgs 中存在 pytest 参数 --cov 时，Python 扩展将不会对覆盖率参数进行额外编辑，以允许您的自定义设置生效。如果未找到 --cov 参数，扩展将在运行前将 --cov=. 添加到 pytest 参数中，以启用工作区根目录的覆盖率。

有关测试覆盖率的更多信息，请访问 VS Code 的 测试覆盖率文档。

调试测试

要调试测试，请右键单击函数定义旁边的装订线装饰，然后选择 Debug Test，或选择测试资源管理器中该测试旁边的 Debug Test 图标。

您可以使用命令面板中的以下命令来调试测试：

• Test: Debug All Tests - 为工作区中的所有测试启动调试器。
• Test: Debug Tests in Current File - 为您在编辑器中打开的文件中定义的测试启动调试器。
• Test: Debug Test at Cursor - 仅为您在编辑器中光标聚焦的方法启动调试器。您还可以使用测试资源管理器中的 Debug Test 图标为选定范围内的所有测试以及所有已发现的测试启动调试器。

您也可以通过在 settings.json 文件中将 testing.defaultGutterClickAction 设置的值更改为 debug，来改变点击装订线装饰时的默认行为（由运行改为调试）。

调试器对于测试的工作方式与对于其他 Python 代码一样，包括断点、变量检查等。要自定义调试测试的设置，您可以通过在工作区的 .vscode 文件夹中将 "purpose": ["debug-test"] 添加到 launch.json 或 settings.json 文件中的配置中，来指定测试调试配置。此配置将在您运行 Test: Debug All Tests、Test: Debug Tests in Current File 和 Test: Debug Test at Cursor 命令时使用。

例如，下面 launch.json 文件中的配置禁用了调试测试时的 justMyCode 设置：

{
  "name": "Python: Debug Tests",
  "type": "debugpy",
  "request": "launch",
  "program": "${file}",
  "purpose": ["debug-test"],
  "console": "integratedTerminal",
  "justMyCode": false
}

如果您有多个带有 "purpose": ["debug-test"] 的配置条目，将使用第一个定义，因为我们目前不支持此请求类型的多个定义。

有关调试的更多信息或了解其在 VS Code 中的工作方式，请阅读 Python 调试配置 和常规 VS Code 调试文章。

并行运行测试

通过 pytest-xdist 包支持使用 pytest 并行运行测试。访问其文档，了解更多关于如何使用 pytest-xdist 的信息。

启用 xdist 且参数中未指定 worker 数量时，Python 扩展会根据测试资源管理器中选择的测试数量自动优化 worker 数量。

Django 单元测试

Python 扩展还提供对发现和运行 Django 单元测试的支持！只需几个额外的设置步骤即可发现您的 Django 测试：

1. 在 settings.json 文件中设置 "python.testing.unittestEnabled": true,。
2. 将 MANAGE_PY_PATH 添加为环境变量。
   1. 在项目根目录中创建一个 .env 文件。
   2. 将 MANAGE_PY_PATH='<path-to-manage.py>' 添加到 .env 文件，并将 <path-to-manage.py> 替换为您应用程序 manage.py 文件的路径。

      提示：您可以通过在“资源管理器”视图中右键单击该文件并选择 Copy Path 来复制路径。

3. 根据需要将 Django 测试参数添加到 settings.json 文件中的 "python.testing.unittestArgs": []，并删除与 Django 不兼容的任何参数。

导航到“测试”视图，并选择 Refresh Tests 按钮以显示您的 Django 测试！

故障排除

如果您的 Django 单元测试未在“测试”视图中显示，请尝试以下故障排除步骤：

• 在 Python 输出面板中搜索错误消息。它们可能会提示您的测试为何未被发现。
• 尝试在终端中运行 Django 测试。然后将相同的命令“转换”为 VS Code 设置。例如，如果您在终端中运行 python manage.py test --arg，您可以将 MANAGE_PY_PATH='./manage.py' 添加到 .env 文件，并在 VS Code 设置中设置 "python.testing.unittestArgs": [--arg]。或者，您也可以在 Python 输出面板中找到 Python 扩展运行的命令。
• 如果您最初使用的是相对路径，请在设置 MANAGE_PY_PATH 环境变量时改用 manage.py 文件的绝对路径。

测试命令

以下是 VS Code 中 Python 扩展测试所支持的所有命令。所有这些都可以在命令面板中找到：

测试配置设置

Python 测试的行为由 VS Code 提供的常规 UI 设置以及特定于 Python 和您启用的框架的设置驱动。

常规 UI 设置

影响测试功能 UI 的设置由 VS Code 本身提供，当您搜索 "Testing" 时，可以在 VS Code 设置编辑器中找到。

常规 Python 设置

unittest 配置设置

unittest 的默认参数如下：

• -v 设置默认详细程度。删除此参数以获得更简单的输出。
• -s . 指定发现测试的起始目录。如果您有 "test" 文件夹中的测试，请将参数更改为 -s test（意味着参数数组中的 "-s", "test"）。
• -p *test*.py 是用于查找测试的发现模式。在这种情况下，它是包含单词 "test" 的任何 .py 文件。如果您命名测试文件的方式不同（例如在每个文件名后附加 "_test"），则在数组的相应参数中使用类似 *_test.py 的模式。

要在第一次失败时停止测试运行，请将快速失败选项 "-f" 添加到参数数组中。

请参阅 unittest 命令行界面以获取完整的可用选项集。

pytest 配置设置

pytest 的默认参数如下：

• rootdir 根据您的工作区中是否存在 python.testing.cwd 设置进行动态调整。

您也可以使用 pytest.ini 文件配置 pytest，如 pytest 配置中所述。

IntelliSense 设置

另请参阅

• Python 环境 - 控制用于编辑和调试的 Python 解释器。
• 设置参考 - 探索 VS Code 中所有与 Python 相关的设置。