如何配置VSCode按下F5时自动在pipenv环境中调试Python脚本

你无需手动维护pipenv shell进程，通过修改项目.vscode目录下的两个配置文件，即可实现按F5自动完成所有预期操作，配置如下：

1. 新建/修改.vscode/tasks.json #

该文件对应preLaunchTask参数所需的前置校验任务，没有文件可手动新建：

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "check-pipenv-env",
            "type": "shell",
            "windows": {
                "command": "pipenv --py"
            },
            "presentation": {
                "reveal": "silent"
            },
            "problemMatcher": []
        }
    ]
}

该任务会自动校验当前项目的pipenv环境是否正常，避免调试启动报错。

2. 新建/修改.vscode/launch.json #

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Pipenv调试当前文件",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "cwd": "${workspaceFolder}/src",
            "pythonPath": "${command:python.interpreterPath}",
            "preLaunchTask": "check-pipenv-env",
            "console": "integratedTerminal",
            "justMyCode": true
        }
    ]
}

以上配置已经适配Windows 10环境，内置变量${workspaceFolder}对应你当前打开的项目根目录，${file}对应当前打开的待调试脚本路径，无需手动修改占位符。

一次性全局适配配置 #

打开VSCode命令面板（快捷键Ctrl+Shift+P），输入Python: Select Interpreter，在弹出的列表中选择当前项目对应的pipenv虚拟环境即可，VSCode会自动识别项目根目录的Pipfile文件列出对应选项。

效果说明 #

配置完成后按F5启动调试，会自动实现以下逻辑：

• 自动加载pipenv虚拟环境，无需手动执行pipenv shell命令
• 自动将工作目录切换到项目根目录下的src文件夹
• 直接在虚拟环境中启动当前打开脚本的调试流程
  如果你的源码目录不是${workspaceFolder}/src，自行修改launch.json中cwd字段的路径即可。

内容的提问来源于stack exchange，提问作者Raymond C.