Python库项目结构最佳实践：导入和测试

Question

我想重构一个我在日常工作中经常使用的python库，将其作为开源发布到github上。在这样做之前，我希望遵循某种python项目结构的最佳实践。我将在下面描述我想做的事情，我将非常感谢你的建议。

下面是我的库（mylib）结构：

mylib/
   /examples/
       simple_example.py
   /mylib/
       __init__.py
       foo.py
       bar.py
   /tests/
       test_foo.py
       test_bar.py

#foo.py
def Foo():
    print("foo.Foo")


#bar.py
import foo

def Bar():
    print("bar.Bar")
    foo.Foo()


#test_bar.py
from ..mylib import bar #doesnt work!

class TestBar(unittest.TestCase):
    def test_1(self):
        bar.Bar()
        self.assertEqual(True, True)

if __name__ == '__main__':
    unittest.main()


#simple_example.py
from .. import foo #doesnt work!
from .. import bar #doesnt work!

if __name__ == '__main__':  
    foo.Foo()
    bar.Bar()

$cd myapp
$cd examples
$python simple_example.py
Traceback (most recent call last):
  File "simple_example.py", line 2, in <module>
    from .. import foo
SystemError: Parent module '' not loaded, cannot perform relative import

$cd myapp
$cd tests
$python test_bar.py
Traceback (most recent call last):
  File "test_bar.py", line 3, in <module>
    from ..mylib import bar
SystemError: Parent module '' not loaded, cannot perform relative import    

3-从mylib根执行所有测试

$cd myapp
$python -m unittest discover tests #same problem as above!

因此，问题出在simple_example.py和test_bar.py中的import语句中。修复这些进口的最佳方法是什么？

注意，我希望使用python标准库unittest进行单元测试。

Answer 1

在运行测试代码时，您希望执行绝对导入。这是因为当您运行单元测试等时，您应该假设您的“库”安装在本地开发模式下进行测试--不要使用相对导入，因为您不在同一个包中。

以下是如何在test_foo.py文件中进行导入，例如：

# test_foo.py
from mylib.foo import Foo

# ... your test code here

通常，您应该只在库代码中使用相对导入，而不是在测试中=)

$ python setup.py develop

$ pip install -e .

上面的任何一个命令都将检查项目的setup.py文件，该文件告诉Python如何构建/创建包，并将在本地安装它，以便运行测试/处理它。