模块导入和__init__.py在Python中

Question

我试图了解关于Python（v2.7）导入机制的最佳实践。我有一个项目开始有所增长，可以说我的代码如下组织：

foo/
    __init__.py
    Foo.py
    module1.py
    module2.py
    module3.py

包名称为foo，在其下方，我有一个模块Foo.py，其中包含该类的代码Foo。因此，我对包，模块和类使用了相同的名称，但起初可能不太聪明。

__init__.py为空，Foo需要导入类，module1, module2 and module3因此Foo.py文件的一部分如下所示：

# foo/Foo.py

import module1
import module2
import module3

class Foo(object):
    def __init__(self):
....
....
if __name__ == '__main__':
    foo_obj = Foo()

但是我后来又重新考虑了这一点，并且我认为最好在__init__.py文件中包含所有导入内容。因此，我__init__.py现在看起来像：

# foo/__init__.py

import Foo
import module1
import module2
import module3
....
....

而我Foo.py只需要导入foo：

# foo/Foo.py

import foo

虽然这很方便，因为它是一个班轮，但我有点担心它可能会产生循环进口。我的意思是，当脚本Foo.py运行时，它将导入它可以导入的所有内容，然后__init__.py将被调用并Foo.py再次导入（这是正确的吗？）。此外，对于包，模块和类使用相同的名称会使情况更加混乱。

我这样做的方式有意义吗？还是我在找麻烦？

Answer 1

如果仅遵守一些流行的python约定和标准，您可以做一些事情来改善组织。

如果您搜索此主题，则不可避免地会遇到建议PEP8准则的人们。这些是组织python代码的事实上的规范标准。

模块应使用简短的全小写名称。如果模块名称可以提高可读性，则可以在模块名称中使用下划线。尽管不鼓励使用下划线，但Python软件包也应使用短小写全名。

根据这些准则，您的项目模块应命名为：

foo/
    __init__.py
    foo.py
    module1.py
    module2.py
    module3.py

我发现通常最好避免不必要地导入模块，__init__.py除非您出于命名空间原因这样做。例如，如果您希望包的名称空间看起来像这样

from foo import Foo

代替

from foo.foo import Foo

然后把

from .foo import Foo

在你的__init__.py。随着包的变大，某些用户可能不想使用所有子包和模块，因此通过隐式将它们导入到中来强迫用户等待所有这些模块加载是没有意义的__init__.py。此外，你要考虑你是否甚至想module1，module2和module3为您的外部API的一部分。它们仅由Foo最终用户使用而不打算供最终用户使用吗？如果它们仅在内部使用，则不要将它们包括在__init__.py

我还建议使用绝对或显式相对导入来导入子模块。例如，在foo.py

绝对

from foo import module1
from foo import module2
from foo import module3

显式相对

from . import module1
from . import module2
from . import module3

这样可以防止其他软件包和模块的任何命名问题。如果您决定支持Python3，也将变得更加容易，因为Python3不支持您当前使用的隐式相对导入语法。

另外，您包中的文件通常不应包含

if __name__ == '__main__'

这是因为将文件作为脚本运行意味着该文件将不被视为属于该文件包的一部分，因此将无法进行相对导入。

向用户提供可执行脚本的最佳方法是使用scripts或console_scripts功能setuptools。根据使用的方法，组织脚本的方式可以有所不同，但是我通常这样组织我的脚本：

foo/
    __init__.py
    foo.py
    ...
scripts/
     foo_script.py
setup.py