在VS Code中不使用sys.path.append(...)实现Python跨包导入的方法

我正在使用Visual Studio Code（VSC）开发Python项目，项目目录结构如下：

Python  
├──.vscode  
│   └── launch.json  
├── package1  
│   ├── __init__.py  
│   └── module1.py  
├── package2  
│   ├── __init__.py  
│   └── module2.py  
└── Python.code-workspace

需要将package1中的module1.py导入到package2的module2.py中，且不想使用sys.path.append(...)实现。已在module2.py中尝试from package1 import module1，但运行时提示ImportError，且确认两个包都包含__init__.py文件。

尝试修改VSC的launch.json配置PYTHONPATH替代sys.path.append(...)，但导入仍失败，当前launch.json配置如下：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python Launch",
      "type": "python",
      "request": "launch",
      "program": "${workspaceFolder}/package2/module2.py",
      "cwd": "${workspaceFolder}/package2",
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  ]
}

1. 修正launch.json配置 #

当前配置的cwd设置为${workspaceFolder}/package2，导致Python运行时的工作目录是package2，即便PYTHONPATH指向项目根，模块查找逻辑仍受工作目录影响。修改后的配置如下：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python Launch",
      "type": "python",
      "request": "launch",
      "program": "${workspaceFolder}/package2/module2.py",
      "cwd": "${workspaceFolder}",
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  ]
}

将cwd改为项目根目录后，Python会从根目录开始查找包，from package1 import module1即可正常导入。

2. 可编辑安装（推荐长期项目） #

通过Python的可编辑安装，将项目包注册到Python环境中，无需依赖launch.json配置即可实现跨包导入：

1. 在项目根目录（Python文件夹）创建pyproject.toml文件，内容如下：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "your-project-name"
version = "0.1.0"
packages = ["package1", "package2"]

2. 打开终端，切换到项目根目录，执行命令：

pip install -e .

安装完成后，无论在哪个目录运行module2.py，都能直接导入package1中的模块。

3. 配置VSC语言服务（解决编辑器提示） #

如果编辑器仍提示找不到package1模块，可在.vscode/settings.json中添加以下配置，让VSC的Python语言服务识别项目根路径：

{
  "python.analysis.extraPaths": ["${workspaceFolder}"]
}

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