这是我的项目布局:
project
+-- package_1
| +-- __init__.py
| +-- module_1.py tests
+-- package_2
| +-- __init__.py
| +-- module_2.py tests
+-- tests
+-- package_1
| +-- __init__.py
| +-- test_module_1.py
+-- package_2
+-- __init__.py
+-- test_module_2.py
test_module_1.py 开始于:
import package_1.module_1
test_module_2.py 开始于:
import package_2.module_2
从项目目录运行 python -m unittest discover tests 会出现错误:
EE
======================================================================
ERROR: package_1.test_module_1 (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: package_1.test_module_1
Traceback (most recent call last):
File "/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/loader.py", line 434, in _find_test_path
module = self._get_module_from_name(name)
File "/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/loader.py", line 375, in _get_module_from_name
__import__(name)
File "/Users/maggyero/project/tests/package_1/test_module_1.py", line 1, in <module>
import package_1.module_1
ModuleNotFoundError: No module named 'package_1.module_1'
======================================================================
ERROR: package_2.test_module_2 (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: package_2.test_module_2
Traceback (most recent call last):
File "/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/loader.py", line 434, in _find_test_path
module = self._get_module_from_name(name)
File "/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/loader.py", line 375, in _get_module_from_name
__import__(name)
File "/Users/maggyero/project/tests/package_2/test_module_2.py", line 1, in <module>
import package_2.module_2
ModuleNotFoundError: No module named 'package_2.module_2'
----------------------------------------------------------------------
Ran 2 tests in 0.000s
FAILED (errors=2)
添加导入系统; print(sys.modules['package_1']) 在 test_module_1.py 的开头和 import sys;在 test_module_2.py 的开头打印(sys.modules['package_2']) 以查看 sys.modules cache 中的内容显示测试目录中的 package_1 和 package_2 已经在测试发现期间导入:
<module 'package_1' from '/Users/maggyero/project/tests/package_1/__init__.py'>
<module 'package_2' from '/Users/maggyero/project/tests/package_2/__init__.py'>
导入以前导入的包会重用 sys.modules 中的相同缓存包,即使 sys.path 已更新。因此,当执行 import package_1.module_1 和 import package_2.module_2 时,首先从测试目录(包含 test_module_1 和 test_module_2)中重新导入 package_1 和 package_2,而不是 package_1 和 package_2从项目目录(包含 module_1 和 module_2)导入 module_1 和 module_2,引发 ModuleNotFoundError。
除了重命名之外,是否有解决方法可以避免测试目录中的包影响项目目录中的包?
更新(发布答案)
下面是 Laurent Laporte 的替代解决方案(他在执行 import package_1.module_1 和 import package_2.module_2,通过 'tests.package_1' 和 'tests.package_2'相反,由于更改了顶级目录)是更新 sys.path 并重新加载 test_module_1.py 中的包:
import importlib
import pathlib
import sys
sys.path.insert(0, pathlib.Path(__file__).resolve().parents[2])
import package_1
importlib.reload(package_1)
import package_1.module_1
和 test_module_2.py:
import importlib
import pathlib
import sys
sys.path.insert(0, pathlib.Path(__file__).resolve().parents[2])
import package_2
importlib.reload(package_2)
import package_2.module_2
此解决方案的唯一优点是测试目录不需要是常规包(即具有 __init__.py 文件)。因此,当 Unittest 允许递归命名空间包发现时,不会有任何优势(目前票证仍然开放:https://bugs.python.org/issue23882)。
Laurent Laporte 的解决方案应该是首选,因为包限定比包重新加载更好地区分具有相同名称的包。另一个好的解决方案是包重命名(例如将 package_1 和 package_2 从 tests 目录重命名为 test_package_1 和 test_package_2)。
请您参考如下方法:
您可以通过使用标志 -t, --top-level-directory directory 设置顶级目录来解决您的问题你的项目(默认为开始目录)
例如:
python -m unittest discover tests -t .
但是,为了让发现导入您的测试模块,您需要通过插入__init__.py 将您的tests 目录变成一个包> 在里面。
请参阅有关 tests discovery 的文档.
注意事项:
我在使用 PyTest 时遇到了同样的问题。看我的study在 GitHub 上。
在其他开源项目中,只有一个根包(比如只有
package_1),没有tests/package_1目录,只有tests所有test_*.py模块(可能还有子包)。所以,问题没有出现。
