如何在VSCode中配置调试环境解决Python模块导入错误

配置VSCode调试环境的步骤 #

1. 打开调试配置文件
   在VSCode中，点击左侧边栏的「调试」面板（或按Ctrl+Shift+D），点击面板顶部的齿轮图标，选择Python环境后，VSCode会自动在项目根目录下生成.vscode/launch.json文件。

2. 修改launch.json添加PYTHONPATH配置
   将以下配置内容替换到launch.json中，根据你的实际脚本路径和参数调整：

   {
       "version": "0.2.0",
       "configurations": [
           {
               "name": "Python: Submodule3 Script",
               "type": "python",
               "request": "launch",
               "program": "${workspaceFolder}/ModuleB/Submodule3/script.py",
               "args": ["--arg-one", "string"],
               "env": {
                   "PYTHONPATH": "${workspaceFolder}"
               },
               "python": "${workspaceFolder}/venv/bin/python",
               "console": "integratedTerminal"
           }
       ]
   }
   

   • program：指定要调试的脚本绝对路径，${workspaceFolder}代表VSCode打开的项目根目录。
   • args：脚本需要的命令行参数，按数组格式填写。
   • env：这里设置PYTHONPATH为项目根目录，和你在CLI执行export PYTHONPATH=$PWD的效果完全一致。
   • python：指定项目venv虚拟环境的Python解释器路径，确保VSCode使用的是正确的虚拟环境。

3. 验证调试配置
   保存launch.json后，点击调试面板的启动按钮（或按F5），调试器会启动并执行脚本，此时模块导入错误应该会被解决。

额外注意事项 #

• 确保VSCode状态栏右下角显示的Python解释器是项目的venv虚拟环境（如果不是，点击状态栏的解释器名称，选择./venv/bin/python）。
• 如果你用pyenv管理Python版本，确认venv是基于pyenv指定的版本创建的（比如先执行pyenv local 3.10.12，再创建venv）。

内容的提问来源于stack exchange，提问作者Austin Hallett