Python导入以使用鼻子进行测试-在当前软件包之上导入模块的最佳做法是

Question

这是一个经常以不同形式提出的问题，通常会得到“大声笑，您做得不好”的回答。可以肯定的是，这是因为有人（包括我在内）正在尝试将其用作实现，并且解决方案并不明显（如果您以前没有这样做过）。

会接受“让蝇从瓶子里飞出来”的答案。

给定

project/
    __init__.py
    /code
        __init__.py
        sut.py
    /tests
        __init__.py
        test_sut.py

tests_sut.py开始的位置：

import code.sut

在根目录中运行鼻子测试会导致：

ImportError: No module named code.sut

行驶的路线：

a）做一个亲戚

from ..code import sut

b）将项目的根目录添加到PYTHONPATH

c）使用

sys.path.append

在每个测试模块开始处的导入之前添加..路径。

d）只记得做一个

setup.py

在项目上运行测试之前，将模块安装到站点程序包中。

因此，要求将测试置于测试包根目录下，并且可以访问该项目。以上每种对我来说都不觉得“自然”，事实证明是有问题的，或者看起来太辛苦了！

在Java中，这是可行的，但基本上是通过构建工具/ IDE将所有类放在类路径上来完成的。也许问题在于我期望Python产生“魔力”？在Flask
Webframework测试中已经注意到，选项d）似乎是首选。

无论如何，以下建议采用首选解决方案的陈述将消除我自己的“不自然”感觉。

Answer 1

您已经很好地回答了您的问题。.D（安装到系统位置）是可分发代码的首选。我通常使用C（修改sys.path），因为我不希望在系统范围内安装数百个自定义库。从理论上讲，A（相对导入）似乎更好，但是在某些情况下它会失败。B（PYTHONPATH）是正确的，我认为实际上仅用于测试目的。

这几乎总结了所有选项。您偏爱的选项（Python神奇地知道在哪里寻找）实际上不是可行的解决方案，因为它可能导致无法预测的结果，例如从不相关的项目中自动查找库。

我认为，最好的办法是将其放在程序的入口点：

import sys, os
sys.path = [os.path.abspath(os.path.dirname(__file__))] + sys.path