Visual Studio Code 中的 Python 测试

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

配置测试

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

可以随时通过 命令面板 使用 Python: 配置测试 命令，或者通过在设置编辑器或 settings.json 文件中设置 python.testing.unittestEnabled 或 python.testing.pytestEnabled 来配置测试，如 VS Code 设置 文档所述。每个框架也有其文件夹和模式的特定配置设置，如测试配置设置中所述。

如果你启用了 pytest 并且它当前未安装在激活的环境中，Python 扩展会尝试在后台安装它。此外，如果两个框架都已启用，Python 扩展将只运行 pytest。

测试发现

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

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

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

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

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

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

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

运行测试

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

• 打开测试文件后，选择测试定义行旁边显示在 gutter 中的绿色运行图标，如上一节所示。此命令只运行该方法。

  

• 从命令面板，通过运行以下任何命令

  • 测试: 运行所有测试 - 运行所有已发现的测试。
  • 测试: 运行当前文件中的测试 - 运行编辑器中打开的文件中的所有测试。
  • 测试: 运行光标处测试 - 只运行编辑器中光标下的测试方法。

• 从测试资源管理器

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

    

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

    

  • 你还可以通过测试资源管理器运行选定的测试。为此，请按住 Ctrl+Click（或在 macOS 上按住 Cmd+Click）选择要运行的测试，然后右键单击其中一个并选择运行测试。

测试运行后，VS Code 会直接在编辑器中显示结果作为 gutter 装饰。失败的测试也会在编辑器中高亮显示，并带有 Peek View，其中显示测试运行错误消息和所有测试运行的历史记录。你可以按 Escape 键关闭视图，也可以通过打开用户设置（在命令面板中使用首选项: 打开设置 (UI) 命令）并将测试: 自动打开 Peek View 设置的值更改为 never 来禁用它。

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

VS Code 还在测试结果面板中显示测试结果。

运行带覆盖率的测试

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

覆盖率运行完成后，编辑器中会高亮显示行级覆盖率。测试覆盖率结果在测试资源管理器中显示为“测试覆盖率”子选项卡，你也可以通过命令面板中的测试: 聚焦测试覆盖率视图导航到该选项卡（⇧⌘P（Windows、Linux Ctrl+Shift+P））。在此面板上，你可以查看工作区中每个文件和文件夹的行覆盖率指标，以及相关的分支覆盖率。

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

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

调试测试

要调试测试，请右键单击函数定义旁边的 gutter 装饰并选择调试测试，或在测试资源管理器中选择该测试旁边的调试测试图标。

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

• 测试: 调试所有测试 - 启动工作区中所有测试的调试器。
• 测试: 调试当前文件中的测试 - 启动编辑器中打开的文件中定义的测试的调试器。
• 测试: 调试光标处测试 - 仅针对编辑器中光标聚焦的方法启动调试器。你还可以使用测试资源管理器中的调试测试图标来启动所选范围内的所有测试和所有已发现测试的调试器。

你还可以通过在 settings.json 文件中将 testing.defaultGutterClickAction 设置值更改为 debug 来更改点击 gutter 装饰的默认行为，使其调试测试而不是运行测试。

调试器对测试和其他 Python 代码的作用方式相同，包括断点、变量检查等。要自定义测试调试设置，你可以在工作区的 .vscode 文件夹中的 launch.json 或 settings.json 文件中通过将 "purpose": ["debug-test"] 添加到配置中来指定测试调试配置。当你运行测试: 调试所有测试、测试: 调试当前文件中的测试和测试: 调试光标处测试命令时，将使用此配置。

例如，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 启用且参数中未指定工作进程数量时，Python 扩展将根据测试资源管理器中选择的测试数量自动优化工作进程数量。

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 文件的路径。

      提示：你可以通过右键单击资源管理器视图中的文件并选择复制路径来复制路径。

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

导航到测试视图，然后选择刷新测试按钮以显示你的 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 本身提供，当你搜索“测试”时，可以在 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 配置中所述。

智能感知设置

另请参阅

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