测试和python包结构

Question

我在构建我的python项目时遇到了一些问题。目前它是一堆文件在同一个文件夹中。我试图把它的结构像

proj/ 
    __init__.py 
    foo.py 
    ... 
    bar/ 
    __init__.py 
    foobar.py 
    ... 
    tests/ 
    foo_test.py 
    foobar_test.py 
    ... 

问题是，我不能从内部目录，从外部目录导入模块。这对测试尤其恼人。

我已阅读关于相对进口的PEP 328和关于从主模块进行的相对进口的PEP 366。但是这两种方法都需要基础包装在我的PYTHONPATH中。事实上，我得到以下错误

ValueError: Attempted relative import in non-package.

所以我添加的测试文件

import os, sys 
sys.path.append(os.path.join(os.getcwd(), os.path.pardir)) 

我仍然得到同样的错误的顶部以下样板代码。什么是正确的方式来

• 结构的包，完成测试，并
• 增加的基本目录，以允许进口的路径？

编辑作为评论的要求，我想补充一个例子导入失败

import os, sys 
sys.path.append(os.path.join(os.getcwd(), os.path.pardir)) 
from ..foo import Foo 

Answer 1

当您使用-m切换器来运行代码时，当前目录被添加到sys.path。因此，要运行测试的最简单的方法是从proj父目录，使用以下命令：

python -m proj.tests.foo_test 

为了使这项工作，你将需要包括一个__init__.py文件在您的测试目录中，以便测试是正确的确认为包装的一部分。

Answer 2

我喜欢使用完整的proj.NAME包前缀尽可能导入模块（文件foo_test.py中）。这是Google Python styleguide推荐的方法。

允许您保留包结构，使用完整包路径，并继续前进开发的一个选择是使用virtualenv并将项目置于开发模式。您的项目setup.py将需要使用setuptools而不是distutils，以获取develop命令。

这将让你避免sys.path.append东西上面：

% virtualenv ~/virt 
% . ~/virt/bin/activate 
(virt)~% cd ~/myproject 
(virt)~/myproject% python setup.py develop 
(virt)~/myproject% python tests/foo_test.py 

其中foo_test.py用途：

from proj.foo import Foo 

现在，当你从你的virtualenv您PYTHONPATH中运行python将指向所有的软件包在你的项目中。你可以创建一个更短的shell别名来输入你的virtualenv，而不必每次输入. ~/virt/bin/activate。