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

问题描述

我定义了一个包，其中包括一组动态增长的模块：

- 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 *添加额外的行。

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

---

解决方案

在Python3中，解决方案使用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?