如何在VS Code中搭配pytest运行pytest-cov并自动生成cov.xml文件

前置依赖确认 #

首先确保你已经安装了覆盖率生成所需的依赖：
pip install pytest-cov

方案1：正确配置VS Code测试参数 #

你之前配置未生效大概率是参数配置的位置不对，VS Code测试资源管理器只会读取python.testing.pytestArgs字段下的参数，优先配置在工作区配置（项目根目录.vscode/settings.json）避免全局配置冲突：

{
  // 禁用其他测试框架避免冲突
  "python.testing.unittestEnabled": false,
  "python.testing.pytestEnabled": true,
  // pytest 运行参数
  "python.testing.pytestArgs": [
    // 替换为你的实际源代码目录，根目录源码就写--cov=.
    "--cov=src",
    // 指定生成xml格式报告，输出路径为项目根目录cov.xml
    "--cov-report=xml:cov.xml",
    // 可选参数：测试用例运行失败时依然生成覆盖率报告
    "--no-cov-on-fail"
  ]
}

配置完成后打开测试面板，点击顶部的刷新按钮重载测试配置后再运行测试即可。

方案2：项目级pytest配置（更稳妥，优先级更高） #

如果不想受编辑器配置影响，可以直接在项目根目录添加pytest原生配置文件，所有场景下运行pytest都会自动生效：

方式A：添加pytest.ini #

[pytest]
addopts = --cov=src --cov-report=xml:cov.xml
testpaths = tests

方式B：添加pyproject.toml（适用于使用现代Python项目规范的场景） #

[tool.pytest.ini_options]
addopts = "--cov=src --cov-report=xml:cov.xml"
testpaths = ["tests"]

问题排查 #

如果配置后依然不生成文件，可以打开VS Code的输出面板，切换到Python Test Log视图，查看实际运行的pytest命令是否携带了cov相关参数：

• 如果没有携带：检查是否有其他配置文件覆盖了参数，比如全局settings.json、项目内其他pytest配置文件
• 如果已经携带：检查--cov参数指定的源码路径是否正确，是否有文件写入权限

内容的提问来源于stack exchange，提问作者Sam T