为什么要在 python 包的 __init__ 中使用 __all__？

Question

我已经阅读了Can someone explain __all__ in Python? 并且我知道它只影响from ... import * 语句，但我无法弄清楚一个真正的用例。当我可以简单地避免在 __init__ 命名空间中导入这些名称时，为什么还要在 __all__ （干！）中重复导出的名称？

例子：

mypackage/__init__.py

from a import A

mypackage/a.py

A = "A"
A1 = "A1"

mypackage/b.py

B = "B"    

然后在python中：

>>> from mypackage import *
>>> A
'A'
>>> 
>>> A1
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'A1' is not defined
>>> b
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'b' is not defined

如您所见，A 在命名空间中，但 A1 和 b 不在。为什么我必须定义__all__ = ["A"]？

Answer 1

唯一你想在你的包的__init__.py 中定义__all__ 的时间是在用户这样做时列出你想要导出的“导出”成员的名称：

from package import *

这在6.4.1. Importing * From a Package中有记录

注意：如果您不在您的包中定义__all__，则默认行为如下（来自文档 ):

如果__all__没有定义，语句from sound.effects import * 不会将 sound.effects 包中的所有子模块导入 当前命名空间；它只确保包 sound.effects 有 已导入（可能在 __init__.py) 然后导入包中定义的任何名称。这包括任何定义的名称（和明确的子模块 加载）由__init__.py。它还包括包的任何子模块 由先前的导入语句显式加载。考虑 这段代码：

对此的“幼稚”解释可以是：

如果你没有定义__all__; from package import * 将引入该包中的所有内容以及 that pacakge 的__init__.py 中导入的所有内容。