在 Visual Studio Code (VSCode) 中调试 Python 代码是一项常见的任务,下面是一个详细的步骤指南,帮助您在 VSCode 中设置并进行 Python 调试:
1. 安装必备软件
确保已安装以下组件:
- Python 解释器:在您的系统上安装 Python,可以从 Python 官方网站 下载并安装适合您操作系统的版本。
- VSCode:下载并安装最新版的 Visual Studio Code,可从 VSCode 官网 获取。
2. 安装 Python 扩展
在 VSCode 中安装 Python 扩展,以提供对 Python 语言的支持,包括智能提示、代码格式化以及调试功能。按以下步骤操作:
- 打开 VSCode。
- 点击左下角的 Extensions 图标(或通过菜单栏选择 View > Extensions)。
- 在搜索框中输入 “Python”,找到由 Microsoft 发布的官方 Python 扩展。
- 点击 “Install”(如果已安装则显示为 “Reload” 或 “Update”)。
3. 配置调试环境
创建一个 launch.json 文件来配置调试环境。这个文件告诉 VSCode 如何启动和连接到 Python 调试器。按照以下步骤创建或编辑 launch.json:
- 打开您要调试的 Python 文件所在的项目目录。
- 点击左侧活动栏的 Debug 图标(或通过菜单栏选择 View > Debug)。
- 如果首次使用调试功能,VSCode 会提示您创建 launch.json。点击提示中的 “Create a launch.json file” 按钮,然后选择 “Python” 环境。
- 如果已有 launch.json 文件,点击齿轮图标(或右键选择 “Add Configuration…”),然后选择 “Python”。
生成的 launch.json 文件通常包含一些预设的调试配置模板。您可以根据需要选择合适的配置(如 “Python File”、“Module” 或 “Integrated Terminal/Console”),或者自定义配置。典型的调试配置可能如下所示:
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: 当前文件",
"type": "python",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": true,
"cwd": "${workspaceFolder}",
"env": {},
"args": []
}
]
}
- "name":配置的名称,用于在调试面板中选择启动。
- "type":调试器类型,这里应为 "python"。
- "request":请求类型,通常设为 "launch" 表示启动一个新的 Python 进程进行调试。
- "program":要调试的主程序文件路径,"${file}" 表示当前打开的文件。
- "console":输出调试信息的终端类型,可以是 "integratedTerminal"(集成终端)或 "internalConsole"(内部调试控制台)。
- "justMyCode":是否只调试自己的代码,true 表示忽略外部库的代码。
- "cwd":工作目录,"${workspaceFolder}" 表示当前工作区根目录。
- "env":环境变量,可以在这里添加或覆盖需要传递给调试进程的环境变量。
- "args":传递给调试程序的命令行参数。
4. 设置断点
在您想要调试的代码行号左侧单击,即可设置一个断点。断点标记为红色圆圈,表示当程序执行到这一行时会暂停。
5. 启动调试
- 确保您打开了要调试的 Python 文件,并已设置好断点。
- 在 Debug 视图中,选择与您配置对应的调试任务(如上例中的 “Python: 当前文件”)。
- 点击绿色的三角形按钮(或使用快捷键 F5)启动调试。
当程序运行到断点处时,将会暂停执行,此时您可以进行以下操作:
- 查看变量:在 Variables 视图中查看当前作用域内的变量及其值。
- 步进:
- F10:Step Over,执行下一行代码,但不会进入函数或方法内部。
- F11:Step Into,执行下一行代码,并进入函数或方法内部。
- Shift + F11:Step Out,从当前函数或方法跳出,返回到调用处的下一行。
- 继续执行:点击 Continue 按钮(或使用 F5)继续执行,直到遇到下一个断点或程序结束。
- 监视表达式:在 Watch 视图中添加或编辑表达式,观察其在调试过程中的值变化。
- 控制台交互:在调试控制台中(如集成终端)输入命令与当前调试环境交互,如打印变量、修改变量值等。
通过以上步骤,您就可以在 Visual Studio Code 中顺利地调试 Python 代码了。如有需要,可根据具体项目需求进一步调整 launch.json 配置,以适应不同的调试场景。