VSCode中Python自定义模块mylib在examples目录导入失败求助

这个问题我之前开发Python项目时也碰到过，本质是Python的模块查找路径机制导致的：当脚本在项目根目录时，当前目录（根目录）默认在sys.path里，所以能找到mylib；但移到examples目录后，Python只会把examples目录加入查找路径，自然找不到上一级的mylib。下面是几个实用的解决办法：

方法一：在脚本中手动添加项目根目录到Python路径 #

这是最直接的临时解决方案，适合快速调试。在split_example.py的最开头添加以下代码：

import sys
from pathlib import Path

# 获取当前脚本所在目录的父目录（也就是项目根目录）
project_root = Path(__file__).parent.parent
# 将项目根目录添加到Python的模块查找路径
sys.path.append(str(project_root))

# 现在就能正常导入了
from mylib.dataset import split

这种方法不需要额外配置，脚本本身就能独立运行，但缺点是每个examples里的脚本都要加这段代码。

方法二：通过PYTHONPATH环境变量指定项目根目录 #

通过设置环境变量告诉Python去哪里找mylib，这种方法不用修改脚本代码。

终端运行时设置 #

在Linux/macOS终端中，运行脚本前先执行：

export PYTHONPATH=/data/dev/python/myproject:$PYTHONPATH
python examples/split_example.py

Windows下的cmd命令行：

set PYTHONPATH=C:\data\dev\python\myproject;%PYTHONPATH%
python examples\split_example.py

Windows PowerShell：

$env:PYTHONPATH = "C:\data\dev\python\myproject;$env:PYTHONPATH"
python examples\split_example.py

VS Code调试时配置 #

如果用VS Code调试脚本，可以在.vscode/launch.json里添加环境变量配置，这样每次调试都会自动生效：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "env": {
                "PYTHONPATH": "${workspaceFolder}"
            }
        }
    ]
}

${workspaceFolder}就是VS Code打开的项目根目录，会自动替换成实际路径。

方法三：将mylib安装为可编辑模块（推荐） #

这是最规范的解决方案，适合长期开发。通过pip的可编辑安装模式，把mylib链接到Python的site-packages目录，这样不管脚本在哪个目录，都能直接导入mylib。

步骤如下：

1. 在项目根目录创建setup.py文件，内容如下：

from setuptools import setup, find_packages

setup(
    name="mylib",
    version="0.1.0",
    packages=find_packages(),  # 自动发现所有Python包（包括mylib）
)

如果是用较新的Python项目结构，也可以创建pyproject.toml（推荐）：

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

[project]
name = "mylib"
version = "0.1.0"
packages = ["mylib"]

2. 在项目根目录运行以下命令，安装可编辑版本的mylib：

pip install -e .

这里的.表示当前目录，-e是editable的缩写，意思是安装的是本地代码的链接，后续修改mylib的代码不需要重新安装，直接生效。

之后不管是在examples目录还是其他地方运行脚本，都能直接from mylib.dataset import split了。

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