如何编写嵌套的 __init__.py 文件

Question

我在编写的 Python 包中遇到嵌套的 __init__.py 问题。该包具有以下架构：

module/
├── __init__.py
├── submodule1
│   ├── __init__.py
│   └── source.py
└── submodule2
    ├── __init__.py
    ├── source.py
    └── subsubmodule2
        ├── __init__.py
        └── source.py

我的意图是能够访问在submodule2/source.py 到module.submodule2.function 和subsubmodules2/source.py 到module.submodule2.subsubmodule2.function 中定义的函数。

我尝试的第一件事是用这种方式在submodule2 中定义__init__.py：

from .subsubmodule2 import *

但是这样做，我得到了在subsubmodules2/source.py 到module.submodule2.function（和module.function）中定义的函数。

如果我这样做：

from . import subsubmodule2

我通过module.subsubmodule2.function获得这些功能。

我还尝试在__init__ 中定义__all__ 关键字，但没有成功。如果我能很好地理解Python documentation，我想我可以留下空的__init__.py 文件并且它可以工作，但据我了解这也不是最佳做法。

按照我的模块的预期访问这些功能的最佳方式是什么？

Answer 1

在module__init__.py文件中写入你要导入的模块

from . import submodule1
from . import submodule2
__all__ = ['submodule1', 'submodule2']

现在，在 submodule1 __init__.py 文件中写入

from . import source
from . import subsubmodule
# if you want to import functions from source then import them or in source.py
# define __all__ and add function which you want to expose
__all__ = ['souce', 'subsubmodule`]

现在在子模块__init__ 文件中定义要公开的函数或类

from . source import *
__all__ =  ['source']
# if you want to use * as import, i suggest you to use __all__ in source.py and mention all exposed function there

Answer 2

__init__.py 文件代表其各自的包。比如module/submodule2/__init__.py代表module. submodule2 。

为了将子模块中定义的对象拉入它们的包命名空间，导入它们：

# module/submodule2/__init__.py
from .source import *

由于__init__.py 是一个常规的Python 模块，我们也可以放弃一个单独的.source 模块，直接在__init__.py 中定义对象：

# module/submodule2/__init__.py

def function():
    ...

---

请注意，子包 本身已经可以作为它们各自的名称使用。不必——事实上也不应该——将它们导入到父模块中。如果代码使用包导入它们，它们将被导入。