切换Docker镜像后Pytest运行报lib.user_agents模块不存在错误如何解决

问题根因排查 #

• 包标识文件命名错误：你给出的项目结构里lib和lib/user_agents目录下的文件是init.py，Python识别目录为可导入包的要求是目录下必须存在命名为__init__.py的文件（前后各两个下划线），如果实际文件确实缺失下划线，就会导致模块无法被识别。
• Python模块搜索路径不包含项目根目录：切换Docker镜像后，新镜像没有将project根目录加入sys.path，导致Python找不到lib包的位置，旧镜像大概率是默认配置了工作目录或者PYTHONPATH所以运行正常。
• pytest执行路径错误：如果在执行pytest时进入了test等子目录运行，当前工作目录不是project根目录，也会导致无法找到lib包。
• pytest插件加载逻辑限制：你在conftest中将lib和lib.user_agents注册为pytest插件，插件加载时会优先从系统标准路径、第三方包路径搜索，没有项目根目录的话就会加载失败。

可行解决方案 #

1. 修正包标识文件命名 #

将lib目录下的init.py重命名为__init__.py，同时将lib/user_agents目录下的init.py也重命名为__init__.py，确保两个目录都被Python识别为合法的包结构。

2. 修正pytest执行路径 #

执行pytest命令时必须在project根目录下运行，不要进入test或其他子目录执行，可以在运行pytest前执行pwd命令确认当前工作目录为project根目录。

3. 手动添加项目根目录到搜索路径 #

在conftest.py文件最开头添加以下代码，强制将项目根目录加入Python模块搜索路径：

import sys
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parent.resolve()))

4. 修正Docker镜像配置 #

在你的Dockerfile中添加以下两项配置：

• 设置默认工作目录为project根目录，示例如下（路径根据你实际复制代码到容器的路径调整）：

WORKDIR /app/project

• 配置PYTHONPATH环境变量，提前将项目根目录加入搜索路径：

ENV PYTHONPATH=/app/project:$PYTHONPATH

5. 简化加载逻辑（可选） #

如果你的lib目录下的代码不需要作为pytest插件使用，只是普通的工具模块，可以直接删除conftest.py中的pytest_plugins = ("lib", "lib.user_agents")配置，在测试用例中按需导入对应模块即可，只要路径配置正确就不会触发报错。

内容的提问来源于stack exchange，提问作者Jérémy