什么是python __all__模块级变量?

时间:2010-02-02 20:50:09

标签: python namespaces

我在python / Lib源代码中看到了很多,但我不知道它是什么。

我认为它用于限制模块的可访问成员。因此,__all__时只会显示dir(module)处的元素。

我做了一个小例子,发现它没有像我预期的那样工作。

那么......什么是python __all__模块级变量?

3 个答案:

答案 0 :(得分:46)

它有两个目的:

  1. 任何阅读源代码的人都会知道公开的API是什么。它不会阻止他们在私人声明中进行探讨,但确实提供了一个很好的警告。

  2. 使用from mod import *时,只会导入__all__中列出的名称。在我看来,这并不重要,因为导入所有内容都是真的坏主意。

答案 1 :(得分:7)

http://docs.python.org/tutorial/modules.html#importing-from-a-package

  

现在用户写的时候会发生什么   from sound.effects import *?理想的情况下,   人们希望这会以某种方式发生   out到文件系统,找到哪个   子模块存在于包中,   并将它们全部导入。这可能需要   很长一段时间并导入子模块   可能会产生不必要的副作用   应该只在子模块时发生   明确导入。

     

唯一的解决方案是包装   作者提供了明确的索引   包裹。 import语句使用   以下约定:如果a   包的__init__.py代码定义了一个   名为__all__的列表,它被认为是   应该的模块名称列表   在from package import *时导入   遇到了。这取决于   包裹作者保留此列表   新版本的最新版本   包发布。包装作者   如果,也可能决定不支持它   他们没有看到用于导入*   从他们的包裹。

答案 2 :(得分:4)

它控制你在

中被拉入命名空间的内容
from blah import *

请参阅Importing * from a Package