pytest执行用例时返回异常ModuleNotFoundError: No module named ‘***‘

问题描述

1. 通过pytest执行用例会返回异常：ModuleNotFoundError: No module named '***'
2. 通过python -m pytest执行用例可以正常执行
3. 通过pycharm进行run对应的用例文件，可以正常执行

• 项目目录结构和test_dir.py文件中的内容如下
  

问题出现原因

• python -m pytest 和pytest区别：
  python -m pytest会把当前项目的目录添加到sys.path（指定模块的搜索路径）中
• 通过pycharm进行运行的时候也会把项目当前所在路径添加到sys.path中
• 因此问题出在项目所在目录未添加到sys.path中，所以找不到指定的模块

pytest导入机制

• 一开始找到原因时由于没有把项目目录添加到sys.path中，网上大部分的解决办法都是手动添加到sys.path中。
• 由于之前做的项目都不需要手动添加也可以进行导入，为了解答此疑惑，了解了一下pytest导入模块的机制，以此项目目录进行说明，如下：
  • pytest在收集用例时找到foodir/tests/test_dir.py，因为没有__init__.py文件，所以test_dir.py不是包中的一部分，只会把路径foodir/tests添加到sys.path中
  • 因为foodir目录下有conftest.py文件，所以会把root/foodir添加到sys.path中
  • 未添加root/路径到sys.path中，所以在test_dir.py中通过from pgobject.homeObject import homeobject进行模块导入时，会找不到对应的模块

如何修改

需要把root/添加到sys.path中

方法一

手动添加root/目录到sys.path中，sys.path.append('../root')具体方法详见https://www.cnblogs.com/sgfg-1314/p/10614938.html

方法二

在foodir目录下添加__init__.py文件，foodir会被识别成package，为了导入fooddir模块，因此会把root/路径添加到sys.path中

参考：pytest导入模块规则地址