确保py.test在sys.path中包含应用程序目录

Question

我的项目目录结构如下（我认为这很标准）：

my_project
    setup.py
    mypkg
        __init__.py
        foo.py
    tests
        functional
            test_f1.py
        unit
            test_u1.py

我将py.test用于我的测试框架，并且希望能够py.test tests在my_project目录中运行我的测试时运行。在我尝试import mypkg在测试中使用（例如）导入应用程序代码之前，这确实可行。那时，我收到错误“没有名为mypkg的模块”。经过一些调查，似乎py.test使用测试文件的目录运行sys.path而
不是py.test从中运行目录的情况下运行测试。

为了解决此问题，我conftest.py向tests目录中添加了一个文件，其中包含以下代码：

import sys, os

# Make sure that the application source directory (this directory's parent) is
# on sys.path.

here = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.insert(0, here)

这似乎可行，但这是确保测试可以看到应用程序代码的好方法吗？有没有更好的方法来实现这一目标，或者我在组织项目的结构上做错了什么？

我已经看过其他一些使用py.test（例如pip）的项目，但是我看不到能做到这一点的代码，但是运行py.test tests似乎可以正常工作。我不知道为什么，但是我担心他们可能以更简单的方式获得了相同的结果。

我看过py.test文档，但看不到对此问题的解释或建议的处理方法。

Answer 1

就像您自己说的那样，py.test基本上假设您已经正确设置了PYTHONPATH。有几种方法可以实现此目的：

• 给您的项目一个setup.py，并pip install -e .在此项目的virtualenv中使用。这可能是标准方法。

• 如果您有virtualenv但没有setup.py，则可以作为一种变体，使用venv的工具在sys.path上添加项目目录，例如，pew add .如果使用pew，或者add2virtualenv .使用virtualenv和virtualenvwrapper的扩展名。

• 如果您始终喜欢sys.path上的当前工作目录，则只需始终将其导出PYTHONPATH=''到Shell中即可。这是确保sys.path上的空字符串，Python将其解释为当前工作目录。但是，这潜在地存在安全隐患。

• 我自己喜欢的黑客，滥用py.test加载conftest文件的方式：conftest.py在项目的顶级目录中放置一个空白。

py.test以这种方式运行的原因是使针对已安装的软件包在结帐的tests
/目录中轻松运行测试。如果它将无条件地将项目目录添加到PYTHONPATH，则将不再可能。