如何让Python单元测试兼容setup.py中package_data指定的数据文件

问题根源 #

单元测试阶段未执行包安装流程，importlib.resources无法识别未安装的本地包结构，同时JSON资源文件未被纳入Python的包资源查找路径，导致ModuleNotFoundError和文件读取失败。

解决方案 #

1. 规范项目目录结构 #

确保JSON文件直接放在包目录下，结构如下：

项目根目录/
├── app/
│   ├── mypackage/
│   │   ├── __init__.py
│   │   ├── 你的模块文件.py
│   │   └── foo.json
├── setup.py
└── tests/
    └── test_xxx.py

2. 修改资源读取代码，增加本地 fallback #

在模块中编写兼容两种场景的读取逻辑，优先使用importlib.resources适配生产环境，失败时通过__file__定位本地文件路径：

import importlib.resources
from pathlib import Path

def load_foo_json():
    # 生产环境：已安装包的资源读取
    try:
        return importlib.resources.files("mypackage").joinpath("foo.json").read_text()
    except (ModuleNotFoundError, FileNotFoundError):
        # 本地开发/单元测试：通过模块文件路径定位资源
        module_path = Path(__file__).parent
        return (module_path / "foo.json").read_text()

# 初始化数据
data_text = load_foo_json()

3. 单元测试环境配置 #

两种可选方式确保测试能找到包和资源：

• 方式一：安装可编辑版本
  在项目根目录执行命令，将包以可编辑模式安装到Python环境：

  pip install -e .
  

  此方式下importlib.resources能正常识别包资源，无需修改测试代码。

• 方式二：手动添加路径到Python环境
  在测试文件开头添加代码，将app目录加入Python的模块查找路径：

  import sys
  from pathlib import Path
  
  # 将app目录添加到sys.path
  sys.path.append(str(Path(__file__).parent.parent / "app"))
  

注意事项 #

• 确保app/mypackage目录下存在__init__.py文件（Python 3.3+允许无，但兼容旧版本或工具链建议保留）；
• setup.py中的package_data配置无需修改，已正确声明需要打包的JSON资源。

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