如何在包的__init__.py中公开子模块中的每个名称？

Question

我定义了一个包含动态增长的模块集的包：

- mypackage
    - __init__.py
    - module1.py
    - module2.py
    - module3.py
    ... many more .py files will be added

我可以在__init__.py中公开每个模块中的每个名字，如下所示：

from module1 import *
from module2 import *
from module3 import *

现在，当我在客户端代码中import mypackage时，我获得了子模块中定义的所有名称：

# suppose funcA is defined in module1, class B is defined in module2
import mypackage
mypackage.funcA() # call module1.funcA
b = mypackage.B() # module2.B

问题是，我可以在mypackage中定义许多新模块，并且我不想在from modulex import *添加额外的行__init__.py，每次我都添加一个新模块包。

在所有子模块中动态导出名称的最佳方法是什么？

Answer 1

我不确定这是不是你的意思：

但如果我理解正确 - 请在__init__.py文件中执行此操作。

import os

__all__ = []

for module in os.listdir(os.path.dirname(__file__)):
    if module != '__init__.py' and module[-3:] == '.py':
        __all__.append(module[:-3])

您正在将同一个包中的所有文件添加到__all__

中

Answer 2

在Python 3中，使用importlib和pkgutil可以轻松解决问题。

对于所有子模块（甚至是嵌套的子模块），在__init__.py中放置以下代码与键入from submodule import *相同。

import importlib
import pkgutil

for mod_info in pkgutil.walk_packages(__path__, __name__ + '.'):
    mod = importlib.import_module(mod_info.name)

    # Emulate `from mod import *`
    try:
        names = mod.__dict__['__all__']
    except KeyError:
        names = [k for k in mod.__dict__ if not k.startswith('_')]

    globals().update({k: getattr(mod, k) for k in names})

如果您只想包含直接子模块（例如pkg.mod而不是pkg.mod.submod），请用walk_packages替换iter_modules。

我根据以下答案模拟了from mod import *：How to do from module import * using importlib?