python - 模块导入和 __init__.py

Question

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

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

包名是foo，在它下面我有模块Foo.py，它包含Foo类的代码。因此，我对包、模块和类使用相同的名称，这可能不是很聪明。

__init__.py 是空的，类 Foo 需要导入 module1、module2 和 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 代码的事实上的规范标准。

Modules should have short, all-lowercase names. Underscores can beused in the module name if it improves readability. Python packagesshould also have short, all-lowercase names, although the use ofunderscores is discouraged.

根据这些准则，您的项目模块应如下命名:

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

中

我还建议使用 absolute or explicit relative imports用于导入子模块。例如，在 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 or console_scripts feature of setuptools .根据您使用的方法，您组织脚本的方式可能会有所不同，但我通常是这样组织我的:

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