Python包跨目录集成测试：导入project子包报错问题求助

Hey，我遇到过一模一样的问题！当测试目录和源码目录分离时，Python的导入机制经常会给我们添点小麻烦。下面是几个经过实践验证的解决方案，你可以根据自己的项目需求选择：

方法1：手动添加项目根目录到Python路径 #

很多人添加路径后仍报错，大概率是加错了路径。你需要把包含project文件夹的根目录加入sys.path，而不是project本身。

假设你的目录结构是这样：

your-project/
├── project/
│   ├── __init__.py
│   └── subpackage1/
│       ├── __init__.py
│       └── bar1.py
└── test/
    └── test_main.py

在test_main.py的最开头添加这段代码：

import sys
from pathlib import Path

# 获取项目根目录（test文件夹的父目录）
root_dir = Path(__file__).parent.parent
# 把根目录加入Python搜索路径
sys.path.append(str(root_dir))

# 现在就能正常导入了
from project.subpackage1.bar1 import YourTargetClass

这样Python就能找到project这个顶级包了。

方法2：使用pip editable模式（推荐） #

如果是长期维护的项目，这个方法更优雅，一劳永逸。

在项目根目录（也就是包含project和test的那个文件夹）下打开终端，执行：

pip install -e .

这个命令会把你的project包以“可编辑”模式安装到Python环境中。之后不管你在哪个目录运行测试，都能直接导入project下的模块，不需要手动修改sys.path：

# test_main.py里直接写就行
from project.subpackage1.bar1 import YourTargetClass

而且你修改项目代码后，不需要重新安装，改动会实时生效，非常适合开发阶段。

方法3：利用测试框架的配置（比如pytest） #

如果你用pytest来运行测试，可以通过配置文件自动添加路径，不用在测试代码里写路径相关的代码。

在项目根目录创建一个pytest.ini文件，内容如下：

[pytest]
pythonpath = .

这样pytest运行时会自动把根目录加入Python搜索路径，你的测试文件里直接导入模块即可。

几个关键注意点 #

• 确保project和subpackage1目录下都有__init__.py文件（Python 3.3+支持无__init__.py的namespace包，但显式添加能避免很多奇怪的问题）。
• 尽量从项目根目录运行测试，比如用python -m test.test_main（模块方式运行），而不是进入test目录执行python test_main.py。模块方式运行时，Python会自动把当前工作目录（根目录）加入搜索路径。

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