安装python扩展是调试的前提,2. 创建或打开项目后配置launch.json文件,3. 通过设置断点并启动调试器开始调试,4. 利用f5、f10、f11等快捷键进行单步执行和流程控制,5. 在调试视图中检查变量和执行表达式,6. 使用条件断点、日志断点等高级技巧提升效率,7. 调试第三方库需设置”justmycode”: false并确保有源码,8. 调试flask或django应用时需配置module、env和args以正确启动服务,9. 远程调试需在服务器安装debugpy并配置远程连接信息,10. 遇到端口占用错误时应查找并终止占用进程或更改端口,所有步骤完成后即可实现高效python调试。
VSCode调试Python程序,简单来说,就是配置好launch.json,然后打断点,愉快地debug。但是,细节往往藏在魔鬼里。
配置launch.json,设置断点,启动调试器,检查变量,单步执行,这些是基本操作。但要真正高效地调试Python代码,还需要了解一些更深入的技巧和方法。
VSCode调试Python代码的详细步骤
立即学习“Python免费学习笔记(深入)”;
-
安装Python扩展:确保VSCode中安装了Python扩展。这通常是第一步,因为这个扩展提供了调试、代码补全等核心功能。没有它,一切都无从谈起。
-
创建或打开Python项目:在VSCode中打开你的Python项目文件夹。如果还没有项目,可以创建一个新的Python文件。
-
配置调试环境(launch.json):这是关键的一步。
- 点击VSCode侧边栏的“运行和调试”图标(或者按
Ctrl+Shift+D
)。
- 点击“创建launch.json文件”。
- 选择“Python File”或者“Python Module”等合适的配置。
一个典型的
launch.json
文件可能看起来像这样:
{ "version": "0.2.0", "configurations": [ { "name": "Python: Current File", "type": "python", "request": "launch", "program": "${file}", "console": "integratedTerminal", "justMyCode": false } ] }
-
"program": "${file}"
表示调试当前打开的文件。
-
"console": "integratedTerminal"
表示在集成终端中运行程序。
-
"justMyCode": false
很重要,它允许你调试标准库和第三方库的代码。如果设为
true
,调试器会跳过这些代码。
- 点击VSCode侧边栏的“运行和调试”图标(或者按
-
设置断点:在你想暂停执行的代码行左侧点击,或者使用
F9
快捷键。断点会在编辑器中显示为一个红点。
-
启动调试:点击“运行和调试”视图中的绿色箭头,或者按
F5
键。VSCode会启动调试器,并在第一个断点处暂停。
-
调试操作:
- 继续 (F5): 继续执行到下一个断点,如果没有断点,则执行到程序结束。
- 单步跳过 (F10): 执行当前行,然后跳到下一行。如果当前行是一个函数调用,则直接执行完函数,不进入函数内部。
- 单步进入 (F11): 如果当前行是一个函数调用,则进入函数内部。
- 单步跳出 (Shift+F11): 从当前函数中跳出,返回到调用函数的地方。
- 重新启动 (Ctrl+Shift+F5): 重新启动调试会话。
- 停止 (Shift+F5): 停止调试会话。
-
检查变量:在“运行和调试”视图中,你可以查看当前作用域内的变量值。也可以使用“调试控制台”来执行Python代码,查看表达式的值。
-
高级调试技巧:
- 条件断点: 在断点上右键,选择“编辑断点”,可以设置断点触发的条件。例如,只有当变量
i
的值大于10时,断点才会暂停。
- 日志断点: 类似于条件断点,但不会暂停程序,而是在控制台中输出一条日志消息。这对于调试复杂的逻辑非常有用,可以避免频繁地暂停程序。
- 多线程调试: VSCode支持多线程调试。在调试多线程程序时,可以查看每个线程的状态,并在不同的线程之间切换。
- 条件断点: 在断点上右键,选择“编辑断点”,可以设置断点触发的条件。例如,只有当变量
如何调试import的第三方库?
确保
launch.json
中
"justMyCode": false
,这样调试器就不会跳过第三方库的代码。另外,你可能需要在第三方库的代码中设置断点,以便调试器能够暂停。如果第三方库的代码没有源代码(例如,只有编译后的二进制文件),则可能无法调试。不过,大多数流行的Python库都有源代码,所以通常不是问题。
如何调试Flask或Django等Web应用?
对于Web应用,
launch.json
的配置会略有不同。你需要告诉调试器如何启动你的Web应用。例如,对于Flask应用,可以这样配置:
{ "version": "0.2.0", "configurations": [ { "name": "Python: Flask", "type": "python", "request": "launch", "module": "flask", "env": { "FLASK_APP": "your_app.py", "FLASK_DEBUG": "1" }, "args": [ "run", "--no-debugger", "--no-reload" ], "justMyCode": false } ] }
-
"module": "flask"
表示使用Flask模块来启动应用。
-
"env": { "FLASK_APP": "your_app.py", "FLASK_DEBUG": "1" }
设置环境变量,指定Flask应用的文件和启用调试模式。
-
"args": [ "run", "--no-debugger", "--no-reload" ]
传递给Flask的参数,禁用Flask自带的调试器和自动重载,以便VSCode的调试器可以正常工作。
调试Django应用的配置类似,只是需要指定Django的
manage.py
文件。
如何调试远程服务器上的Python程序?
VSCode也支持远程调试。这需要一些额外的配置,例如,在远程服务器上安装
debugpy
库,并在
launch.json
中指定远程服务器的地址和端口。具体的步骤可以参考VSCode的官方文档。远程调试对于调试部署在服务器上的应用非常有用。
调试时遇到“OSError: [Errno 98] Address already in use”怎么办?
这个错误通常表示端口被占用。这可能是因为之前启动的调试会话没有正常关闭,或者有其他程序占用了该端口。解决办法是:
- 找到占用该端口的进程,并将其杀死。可以使用
lsof -i :<端口号>
(Linux/macOS)或者
netstat -ano | findstr <端口号>
(Windows)命令来查找占用端口的进程。
- 更改
launch.json
中指定的端口号。
确保每次调试结束后都正常停止调试会话,可以避免端口被占用的问题。
评论(已关闭)
评论已关闭