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()

我想做的是：

1-理想情况下从/ mylib / examples /执行simple_example.py：

$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

2-理想情况下从/ mylib / tests /执行单个测试文件：

$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 root执行所有测试

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

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

请注意，我想使用python标准lib unittest进行单元测试。

谢谢

查理

Answer 1

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

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

# test_foo.py
from mylib.foo import Foo

# ... your test code here

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

我希望这有帮助。

编辑 ：您还需要在开发模式下安装库，然后才能工作。 您可以通过以下两种方式之一完成此操作：

$ python setup.py develop

要么

$ pip install -e .

上述任一命令都将检查项目的setup.py文件，该文件告诉Python如何构建/创建包，并将其本地安装，以便您可以运行测试/混乱。