Python项目怎么在VS Code中调试pytest用例_配置launch.json调试项

阿枫大大_9733

阿枫大大_9733

2026-05-10

595人浏览

原创

在vs code中直接调试单个pytest测试函数,需先配置python测试框架为pytest并完成测试发现,然后右键测试函数选择“debug test”即可自动启动带断点的调试会话;手动配置launch.json时须设"module": "pytest"、args指定具体测试路径如["tests/test.py::test_func"],并确保cwd和pythonpath正确。

python项目怎么在vs code中调试pytest用例_配置launch.json调试项

怎么在 VS Code 里直接调试单个 pytest 测试函数

VS Code 默认不识别 pytest 的测试结构,必须显式告诉它“这是一个 pytest 用例,用 pytest 运行器启动”。关键不是改 python 调试配置,而是用 python-testing 类型的配置,并指定 pytest 为测试工具。

实操建议:

  • 确保已安装 pytest(pip install pytest)且 VS Code 已启用 Python 扩展和 Python Test Explorer 扩展(推荐)
  • 在项目根目录下打开命令面板(Ctrl+Shift+P),运行 Python: Configure Tests → 选 pytest → 指定测试目录(如 tests/ 或 .)→ 完成后 VS Code 会自动生成 settings.json 中的 python.testing.pytestArgs
  • 此时右键某个 def test_* 函数 → Debug Test,VS Code 会自动创建临时调试配置并启动带断点的 pytest 进程

手动写 launch.json 调试 pytest 单文件或单函数时要注意什么

手动配置 launch.json 是为了更细粒度控制(比如传参、环境变量、coverage),但容易错配 request 类型或入口路径。

常见错误现象:断点不命中、报 ModuleNotFoundError、提示 No module named pytest。

实操建议:

  • type 必须是 python(不是 python-testing),request 必须是 launch
  • module 字段设为 pytest,而不是写脚本路径;用 args 传测试目标,例如:["tests/test_math.py::test_add"] 或 ["-s", "tests/"]
  • cwd(工作目录)要设为项目根目录,否则 pytest 找不到被测模块;如果被测代码在 src/ 下,还需加 "env": {"PYTHONPATH": "${workspaceFolder}/src"}
  • 避免用 program 指向 pytest 可执行文件——跨平台路径不可靠,module 更稳定

为什么 pytest 参数加在 args 里却没生效

launch.json 中的 args 是透传给 pytest 命令行的,但顺序和语义必须符合 pytest 规则,否则会被忽略或报错。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载

使用场景:想调试时显示 print 输出、跳过某些 fixture、启用详细日志。

实操建议:

  • -s(允许输出)和 -v(详细模式)必须放在 args 最前面,否则 pytest 可能解析失败
  • 测试路径或函数名必须是最后一个参数,例如:["-s", "-v", "--tb=short", "tests/test_api.py::test_login"]
  • 不要在 args 里写 --debug(那是 VS Code 自己的调试开关,不是 pytest 的);pytest 的调试相关参数是 --pdb 或 --trace,但它们和 VS Code 断点冲突,慎用
  • 如果用了 pytest-xdist(如 -n 2),调试会失效——多进程下 VS Code 无法 attach 子进程,调试时务必去掉并发参数

调试时 import 报错 ModuleNotFoundError 怎么快速定位

这不是 pytest 问题,是 VS Code 启动调试器时 Python 解释器找不到模块路径。根本原因通常是 sys.path 没包含你的源码目录。

性能 / 兼容性影响:硬改 sys.path 在代码里只是临时解法,不利于 CI 和他人复现;用 PYTHONPATH 或 setup.py develop 更规范。

实操建议:

  • 先确认你当前选择的 Python 解释器是否正确(左下角状态栏点击 Python 版本,选对虚拟环境)
  • 在 launch.json 的 env 中显式添加 PYTHONPATH,例如:"PYTHONPATH": "${workspaceFolder}/src:${workspaceFolder}"
  • 如果项目有 pyproject.toml 且用的是 PEP 517 构建,可以加 "env": {"PYTHONPATH": "${workspaceFolder}"} + pip install -e .(推荐长期方案)
  • 别依赖 __file__ 动态推导路径——调试器启动方式不同会导致 __file__ 指向 pytest 内部文件,不可靠

最易被忽略的是:VS Code 的调试配置不会自动继承终端里的环境变量(比如你在 shell 里 export PYTHONPATH 了,但调试器看不到)。所有路径依赖都得显式写进 launch.json 的 env 里。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python js json vs code

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4224

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24577

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3007

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3027

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2343

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程