VSCode中Python跨中间目录导入的原理与报错解决

1. 跳过中间目录的Python导入原理 #

这种跨目录导入能正常运行，核心是**module_A被Python识别为包的同时，python目录被加入了Python的模块搜索路径（sys.path）**，或者环境里做了特殊配置让script_B直接关联到module_A的命名空间下，常见的具体情况有：

• 代码启动时，通过脚本手动执行了sys.path.append("module_A/python")，或者系统环境变量PYTHONPATH包含了module_A/python路径，此时Python会把这个目录当成顶级模块目录，script_B就像直接在module_A包下一样
• 项目用了导入钩子、包重定向工具，或者自定义的sitecustomize.py脚本，把python目录下的模块直接挂载到module_A的命名空间中
• 部署或运行时的实际目录结构和你本地看到的不一致，比如module_A是python目录的别名，或者部署时做了目录合并

2. VSCode中解决pylint报错的方法 #

以下几种方法都能解决报错，恢复代码悬停、自动补全功能：

• 配置VSCode的额外分析路径
  打开VSCode设置（快捷键Ctrl+,），搜索Python › Analysis: Extra Paths，添加module_A/python的绝对路径；或者在项目根目录创建.env文件，写入PYTHONPATH=./module_A/python（根据实际相对路径调整），VSCode会自动加载该环境变量
• 显式导出模块（允许修改代码时用）
  在module_A根目录创建__init__.py（如果没有的话），添加导入语句：

  from .python import script_B
  

  这样module_A包就会显式导出script_B，pylint就能识别到这个模块
• 配置pylint的初始化钩子
  在项目根目录创建.pylintrc文件，添加：

  [MASTER]
  init-hook='import sys; sys.path.append("你的项目路径/module_A/python")'
  

  替换成实际的绝对路径即可
• 修改工作区设置
  在项目的.vscode/settings.json中添加：

  {
    "python.analysis.extraPaths": [
      "${workspaceFolder}/module_A/python"
    ],
    "python.linting.pylintArgs": [
      "--init-hook='import sys; sys.path.append(\"${workspaceFolder}/module_A/python\")'"
    ]
  }
  

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