Python项目目录结构/ pytest麻烦

Question

这应该是地球上最简单的问题，但是即使经过广泛的搜索和修补，我仍然在寻找一种“正确的”方式来放置目录结构并设法正确运行pytest等方面深陷困境。

假设我有一个名为apple的程序。

|- README.md
|- apple
|   |-- __init__.py
|   |-- apple.py
| - tests
|   |-- test_everything.py

apple.py包含一些函数，为方便起见，我们将其称为一个eat()。该test_everything.py文件包含一些测试，例如assert eat()=="foobar"。太好了，太容易了，但是乐趣就开始了：

• 怎么样__init__.py在苹果目录…正确吗？空或里面应该有什么？
• py.test从根目录调用是最佳实践吗？还是py.test tests？
• 许多项目__init__.py的测试目录中都有一个，但是在py.test文档中明确指出这是错误的。那为什么上帝啊
• test_everything.py文件顶部的内容是：import apple或from apple import *？或完全其他的东西
• 您是否通过eat()或调用了这些函数apple.eat()？
• 一些人甚至建议os.path.dirname在python中进行操作

这应该很容易，但是我已经看到了上面的每种组合，甚至都没有谈论过tox和无数其他工具。然而，即使有丝毫错误，您也会抛出一些ImportError: No module named 'apple'或其他一些时髦的错误。

什么是“正确”方式？该建议和github等上的现有代码遵循极为不同的约定。对于经验丰富的编码器，这应该容易得多。

Answer 1

1. 怎么样__init__.py在苹果目录…正确吗？空或里面应该有什么？

是，对的。最经常是空的。如果放入foo = 42，您可以稍后再做from apple import foo，from apple.apple import foo如果放入，则需要做apple.py。尽管它看起来很方便，但您应该谨慎使用。

1. 从根目录调用py.test是最佳实践吗？还是py.test测试？

py.test无论如何都应该能够找到您的测试，但请参见下文。

1. 许多项目__init__.py的测试目录中都有一个，但是在py.test文档中明确指出这是错误的。那为什么上帝啊

因此，您可以在提供通用测试功能的测试中导入文件。在py.test中，通过在名为的文件中创建固定装置可能会更好地实现tests/conftest.py。

1. test_everything.py文件顶部的内容是：导入苹果还是来自苹果导入*？或完全其他的东西

from apple import apple

1. 您是否先通过eat（）或apple.eat（）调用函数？

apple.eat()

1. 甚至有人建议在python中操作os.path.dirname

那似乎很脆弱。我建议

（a）将环境变量PYTHONPATH设置为指向所在的文件夹README.md，或者更好

（b）创建一个setup.py文件（与您的README.md文件处于同一级别），这是最小的文件：

from setuptools import setup
setup(name='apple', packages=['apple'])

像这样运行文件：

python setup.py develop

现在apple可以在全球范围内使用，您再也不会遇到no module named apple问题，例如，您可以从根文件夹或tests文件夹运行py.test。

您可以setup.py在https://python-packaging-user-
guide.readthedocs.org/en/latest/index.html
的《
Python打包用户指南》中了解更多信息。