如何在VS Code工作区为Python开发添加自定义搜索路径

1. 配置编辑器智能提示（解决IntelliSense找不到模块的问题） #

VS Code的Python智能提示由Pylance语言服务提供，需要额外配置搜索路径：

• 打开项目根目录下的.vscode/settings.json文件，若不存在则手动创建.vscode文件夹和对应文件
• 在文件中添加如下配置：

{
  "python.analysis.extraPaths": ["./src"]
}

配置完成后重启Pylance语言服务（或直接重启VS Code），即可识别src目录下的模块，实现代码补全、跳转等功能。

2. 配置运行时搜索路径（解决代码运行时导入报错的问题） #

上述配置仅针对编辑器提示生效，运行代码时需要单独配置Python的模块搜索路径：

方法一：使用.env文件全局配置（推荐） #

• 在项目根目录新建.env文件，写入如下内容：

PYTHONPATH=./src

VS Code运行Python代码时会自动加载该文件的环境变量，自动将src目录加入搜索路径，无需额外修改代码。

方法二：针对调试运行配置 #

如果使用VS Code的调试功能运行代码，可以直接修改.vscode/launch.json的调试配置：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: 当前文件",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "env": {"PYTHONPATH": "${workspaceFolder}/src"}
    }
  ]
}

临时测试方法 #

如果仅需要临时测试，可在代码入口开头添加如下代码，不建议长期使用：

import sys
sys.path.append("./src")

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