如何使用VSCode调试python代码

零壹漫步

已于 2024-06-05 15:29:55 修改

阅读量2.8k

点赞数 8

分类专栏： python 文章标签： python

于 2024-05-21 11:39:56 首次发布

本文链接：https://blog.csdn.net/jiaxin576/article/details/139080188

版权

python 专栏收录该内容

33 篇文章

订阅专栏

在 Visual Studio Code (VSCode) 中进行 Python 代码调试是一个直观且功能强大的过程，借助于内置的调试支持和 Python 扩展（如 Python extension by Microsoft）。以下是如何设置和开始使用 VSCode 进行 Python 调试的步骤：

1 安装 Python 扩展

确保你已经安装了 VSCode 的 Python 扩展。这可以通过以下步骤完成：

打开 VSCode。
转到扩展视图，可以通过点击左侧工具栏中的方块图标或按下 Ctrl+Shift+X 打开。
在搜索栏中输入 “Python” 并找到由 Microsoft 发布的 Python 扩展。
点击安装。

2 配置调试环境

一旦安装了 Python 扩展，你需要配置调试环境。VSCode 的 Python 调试配置文件存储在工作区的 .vscode/launch.json 文件中。按照以下步骤来配置：

打开你的 Python 项目文件夹。
转到“运行和调试”视图，可以通过点击侧边栏的播放按钮图标或按 Ctrl+Shift+D 打开。
点击“创建 launch.json 文件”链接（如果你的工作区还没有配置文件的话）。
选择 Python 文件的调试环境。这通常是 “Python File” - 这将创建一个基本的调试配置。

3 编辑 `launch.json` 文件

为了运行 run.py 并传递 --debug 参数，你需要修改 launch.json 文件以包含正确的配置。例如：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Run with Arguments",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/run.py",
            "args": ["--debug"],
            "console": "integratedTerminal"
        }
    ]
}

示例
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "run.py",
            "args": ["configs/api_examples/eval_Nebulacoder.py", "--dump-eval-details", "--debug"],
            "console": "integratedTerminal",
            "cwd": "/media/vdb/PycharmProjects/pythonProject/jingzhun/AIGC/opencompass",
            "justMyCode": true
        }
    ]
}

这里，"program" 指向你的 run.py 文件，"args" 包含了传递给脚本的命令行参数（在这个例子中是 --debug）。

“console”: "integratedTerminal"这个设置指定了调试输出应当显示在哪里。“integratedTerminal” 是 VSCode 中的一个选项，它表示：集成终端：调试输出将在 VSCode 的集成终端中显示。这包括任何来自程序的打印输出、错误消息以及其他标准输出和错误信息。当你使用 “console”: “integratedTerminal” 时，调试器将会在 VSCode 的底部终端视图中启动和运行你的代码，你可以在这里看到程序的运行输出，也可以直接在终端中输入内容，例如当程序请求输入时。这个设置对于需要与用户交互的程序特别有用，或者当你希望看到程序运行中可能产生的完整终端输出时。

“justMyCode”: true 这个设置是用来控制调试器行为的：仅我的代码 (justMyCode): 当设置为 true，调试器将只关注用户自己的代码，忽略那些执行中涉及到的库代码或者是第三方代码。当启用 (true) 时，这个选项告诉调试器跳过那些认为不是用户自己写的代码的步入（Step Into）。例如，如果你的代码调用了标准库函数或第三方库函数，调试器将不会进入这些函数内部。这对于调试更为干净直观，因为它让开发者能够专注于他们直接写的代码，而不是跳进去看库的内部实现，这通常对解决问题不是很有帮助。使用 justMyCode 可以减少调试会话中的干扰，让开发者更专注于自己的代码逻辑问题，而不是库或框架内部可能的问题。同时，如果你需要调试库代码或确认库代码中的错误，可以将 justMyCode 设置为 false，以允许调试器步入任何执行代码。

4 启动调试

确保你已经保存了 launch.json 文件。
在“运行和调试”视图中，从下拉菜单中选择你刚才创建的配置（例如 “Python: Run with Arguments”）。
点击绿色的开始调试按钮或按 F5 开始调试。
VSCode 将启动 Python 调试器，并在遇到任何断点时停下来。

5 设置断点

为了在特定的代码行上中断执行：

打开你希望停止执行的 Python 文件。
点击代码行号左边的空白区域设置断点，你会看到一个红点出现。
当调试运行到这一行时，VSCode 会自动停止，允许你检查变量、步进代码和查看调用堆栈。

5 选择一个项目的 Python 解释器

在 Visual Studio Code (VSCode) 中选择一个项目的 Python 解释器是一个重要的步骤，特别是当你在同一台机器上安装了多个 Python 版本或环境时。VSCode 通过 Python 扩展允许你为每个工作区（项目）选择特定的 Python 解释器。以下是如何设置默认的 Python 解释器：