Vscode 中 python模块的导入问题

VSCode配置PYTHONPATH解决Python模块导入问题

问题描述

在使用VSCode开发Python项目时，经常会遇到模块导入错误的问题。当项目结构较为复杂，包含多个层级的目录时，Python解释器可能无法正确找到自定义模块，导致ModuleNotFoundError或ImportError。
问题原因

Python解释器在导入模块时，会按照以下顺序搜索模块：

• 当前脚本所在目录
  
• PYTHONPATH环境变量中指定的目录
  
• Python安装路径中的标准库目录
  

查看当前Python解释器的模块搜索路径

1. import sys
2. paths = sys.path
3. # 遍历当前Python解释器的模块搜索路径列表
4. for path in paths:
5.     print(path)

复制代码

终端输出信息：

1. (base) PS E:\Projects\OCR-sdk> (D:\ProgramData\Anaconda3\shell\condabin\conda-hook.ps1) ; (conda activate base)
2. (base) PS E:\Projects\OCR-sdk> & D:\ProgramData\Anaconda3\python.exe e:/Projects/OCR-sdk/tests/path.py
3. e:\Projects\OCR-sdk\tests
4. D:\ProgramData\Anaconda3\python313.zip
5. D:\ProgramData\Anaconda3\DLLs
6. D:\ProgramData\Anaconda3\Lib
7. D:\ProgramData\Anaconda3
8. D:\ProgramData\Anaconda3\Lib\site-packages
9. D:\ProgramData\Anaconda3\Lib\site-packages\win32
10. D:\ProgramData\Anaconda3\Lib\site-packages\win32\lib
11. D:\ProgramData\Anaconda3\Lib\site-packages\Pythonwin
12. (base) PS E:\Projects\OCR-sdk>

复制代码

路径仅包含当前python文件、系统环境变量和当前python环境目录，当前项目根目录不在Python的模块搜索路径中时，所以跨目录的模块导入会失败。
解决方法

通过配置VSCode的集成终端环境变量，将项目根目录添加到PYTHONPATH中，让Python解释器能够正确找到项目中的所有模块。
配置步骤

修改用户配置，通过ctrl+shift+p 打开用户配置文件：

也可以修改当前项目的工作区配置文件\.vscode\settings.json
在配置文件中添加如下配置：

1. {
2.   "terminal.integrated.env.windows": {
3.     // 设置 PYTHONPATH 环境变量为当前工作区根目录
4.     "PYTHONPATH": "${workspaceFolder}"
5.   }
6. }

复制代码

配置说明

• terminal.integrated.env.windows：针对Windows系统的集成终端环境变量配置
  
• PYTHONPATH：Python解释器用于搜索模块的环境变量
  
• ${workspaceFolder}：VSCode内置变量，表示当前工作区的根目录路径
  

其他平台配置

windows/Linux/macOS配置

1. {
2.   "terminal.integrated.env.windows": {
3.     "PYTHONPATH": "${workspaceFolder}"
4.   },
5.   "terminal.integrated.env.linux": {
6.     "PYTHONPATH": "${workspaceFolder}"
7.   },
8.   "terminal.integrated.env.osx": {
9.     "PYTHONPATH": "${workspaceFolder}"
10.   }
11. }

复制代码

验证配置是否生效

再次查看模块搜索路径

1. ```python
2. import sys
3. paths = sys.path
4. for path in paths:
5.     print

复制代码

为了防止修改后未立即生效，可以在新终端里再次测试或者直接重启Vscode

1. (base) PS E:\Projects\OCR-sdk> & D:\ProgramData\Anaconda3\python.exe e:/Projects/OCR-sdk/tests/path.py
2. e:\Projects\OCR-sdk\tests
3. E:\Projects\OCR-sdk
4. D:\ProgramData\Anaconda3\python313.zip
5. D:\ProgramData\Anaconda3\DLLs
6. D:\ProgramData\Anaconda3\Lib
7. D:\ProgramData\Anaconda3
8. D:\ProgramData\Anaconda3\Lib\site-packages
9. D:\ProgramData\Anaconda3\Lib\site-packages\win32
10. D:\ProgramData\Anaconda3\Lib\site-packages\win32\lib
11. D:\ProgramData\Anaconda3\Lib\site-packages\Pythonwin

复制代码

如果配置成功，那么项目根目录（例如：E:\Projects\OCR-sdk）应该出现在sys.path的输出中。
注意

• 重启终端：修改配置后需要重新打开集成终端才能生效
  
• 多项目支持：每个项目可以有独立的.vscode/settings.json配置
  
• 路径分隔符：在Windows中使用分号;分隔多个路径，在macOS/Linux中使用冒号:
  

扩展配置

如果需要添加多个路径到PYTHONPATH：

1. {
2.   "terminal.integrated.env.windows": {
3.     "PYTHONPATH": "${workspaceFolder};${workspaceFolder}\\src;${workspaceFolder}\\lib"
4.   }
5. }

复制代码

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！