在Visual Studio Code中进行Python测试

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

配置测试

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

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

如果你启用 pytest 但当前激活的环境中未安装，Python 扩展将尝试在后台安装。此外，如果同时启用两个框架，Python 扩展将仅运行pytest输入：.

测试发现

默认情况下，Python扩展会在您启用一个框架后尝试发现测试。您可以随时使用命令面板中的测试：刷新测试命令来触发测试发现。

测试发现应用了当前框架的发现模式（可以通过测试配置设置进行定制）。默认行为如下：

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

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

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

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

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

运行测试

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

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

  

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

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

• 从 测试浏览器：

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

    

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

    

  • 你也可以通过测试浏览器运行一系列测试。要这样做，Ctrl+Click（或在macOS上Cmd+Click）点击你想要运行的测试，右键点击其中一个，然后选择运行测试。

经过测试运行后，VS Code 会在编辑器中直接显示结果作为行号标记。失败的测试也会在编辑器中高亮显示，并且有一个预览视图，显示测试运行错误消息和所有测试运行的历史记录。你可以按Escape键来关闭视图，并且你可以通过打开用户设置（在首选项：打开设置 (UI)命令中，在命令面板中打开）并更改测试：自动打开预览视图设置的值来禁用它。从不输入：.

在测试浏览器中，显示每个测试的结果以及包含这些测试的任何类和文件。如果文件夹中的任何测试未通过，则该文件夹将显示失败图标。

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

运行测试并覆盖

要启用代码覆盖运行测试，请在测试资源管理器中选择代码覆盖运行图标或从任何通常触发测试运行的菜单中选择带代码覆盖运行选项。Python 扩展使用pytest-覆盖插件如果你使用pytest，或者使用覆盖.py用于单元测试。

一旦代码覆盖运行完成，编辑器中相应的行将会被高亮显示，以显示行级代码覆盖情况。测试覆盖结果会显示在测试资源管理器中的“测试覆盖”子标签页中，你也可以通过测试：关注测试覆盖视图 在命令面板中导航（⇧⌘P（Windows, Linux Ctrl+Shift+P））。在这个面板中，你可以查看工作区中每个文件和文件夹的行覆盖指标，如果有相关性的话，还可以查看分支覆盖指标。

在使用pytest时，为了对覆盖运行进行更精细的粒度控制，您可以编辑python.testing.pytestArgs设置包括您的规范。当 pytest 参数--覆盖存在于python.testing.pytestArgsPython 扩展将不会对 coverage args 进行任何额外的编辑，以允许您的自定义设置生效。如果不存在--覆盖发现参数，扩展将添加--覆盖=.在运行 pytest 之前，添加参数以在工作区根目录启用代码覆盖。

欲了解更多关于测试覆盖的信息，请访问 VS Code 的 测试覆盖文档.

调试测试

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

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

• 测试：调试所有测试 - 在你的工作区中启动调试器以调试所有测试。
• 测试：在当前文件中调试测试 - 为在您打开的编辑器中定义的测试启动调试器。
• 测试：在光标处进行调试测试 - 仅对编辑器中光标所在的的方法启动调试器。您还可以使用调试测试图标在测试资源管理器中启动调试器，以对选定范围内的所有测试和所有发现的测试进行调试。

您还可以通过更改来将点击 gutter decoration 的默认行为从运行测试更改为调试测试测试默认的边缘点击动作设置值为调试在你的settings.json文件。

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

例如，下面的配置launch.json文件禁用了只是我的代码调试测试设置：

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

如果您有多个配置条目"目的": ["调试测试"]由于我们目前不支持此请求类型的多个定义，将使用第一个定义。

如需更多有关调试的信息或了解VS Code中的工作原理，请阅读Python调试配置和VS Code的调试文章。

并行运行测试

通过 pytest 提供了并行运行测试的支持。pytest-xdist 包。访问他们的 文档，以获取有关如何使用的更多信息 pytest-xdist输入：.

当xdist如果启用并且在参数中没有指定工作线程的数量，Python 扩展将根据在测试资源管理器中选择了多少测试来自动优化工作线程的数量。

Django 单元测试

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

1. 设置"python.testing.unittestEnabled": true,在你的settings.json 文件.
2. 添加管理_PY_PATH作为环境变量：
   1. 创建一个环境变量文件项目根目录下的文件。
   2. 添加MANAGE_PY_PATH=''<路径到manage.py>''到环境变量文件文件，替换<路径到manage.py>与通向你应用程序的路径管理.py文件。

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

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

导航到测试视图，并选择刷新测试按钮以显示您的Django测试！

故障排除

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

• 在Python输出面板中搜索错误消息。它们可能会提供有关为什么您的测试未被发现的提示。
• 尝试在终端中运行Django测试。然后将相同的命令“翻译”到VS Code设置中。 例如，如果你运行python manage.py 测试 --参数在终端中，你会添加MANAGE_PY_PATH='./manage.py'到一个环境变量文件文件，并设置"python.testing.unittestArgs": [--arg]在 VS Code 设置中。或者，您还可以在 Python 扩展运行的命令中找到这些命令，位于 Python 输出面板中。
• 使用绝对路径到管理.py文件设置时管理_PY_PATH环境变量，如果你最初使用了相对路径。

测试命令

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

测试配置设置

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

常规用户界面设置

影响测试功能用户界面的设置由VS Code本身提供，并且可以在您搜索“Testing”时在VS Code设置编辑器中找到。

常规 Python 设置

单元测试配置设置

unittest的默认参数如下：

• -版本设置默认的详细程度。移除此参数以获得更简单的输出。
• -s .指定用于发现测试的起始目录。如果你的测试在名为“test”的文件夹中，请更改该参数为-s 测试(意思"-s", "test"在参数数组中）。
• -p *test*.py是用于寻找测试的发现模式。在这种情况下，是任何.py包含单词“test”的文件。如果你以不同的方式命名测试文件，例如在每个文件名后附加“_test”，那么使用像这样的模式*_test.py在数组的适当参数中。

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

参见unittest命令行界面了解所有可用选项。

pytest 配置设置

pytest的默认参数如下：

• 根目录根据存在的动态调整python.testing.cwd在你的工作区设置。

您还可以通过一个文件来配置 pytestpytest.ini 文件如 pytest 配置 中所述。

IntelliSense 设置

另见

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