python中【__all__】的用法

Python 可以在模块级别暴露接口：

_all_ = [“foo”, “bar”]

__all__是一个字符串list，用来定义模块中对于from XXX import *时要对外导出的符号，即要暴露的接口，但它只对import *起作用，对from XXX import XXX不起作用。

提供了哪些是公开接口的约定

不像 Ruby 或者 Java，Python 没有语言原生的可见性控制，而是靠一套需要大家自觉遵守的”约定“下工作。比如下划线开头的应该对外部不可见。同样，all 也是对于模块公开接口的一种约定，比起下划线，all 提供了暴露接口用的”白名单“。一些不以下划线开头的变量（比如从其他地方 import 到当前模块的成员）可以同样被排除出去。

import os
import sys
all = [“process_xxx”] # 排除了 os 和 sys
def process_xxx():
pass # omit

控制 from xxx import * 的行为

代码中当然是不提倡用 from xxx import * 的写法的，但是在 console 调试的时候图个方便还是很常见的。如果一个模块 spam 没有定义__all__，执行from spam import * 的时候会将spam 中非下划线开头的成员都导入当前命名空间中，这样当然就有可能弄脏当前命名空间。如果显式声明了 __all__，import *就只会导入 __all__列出的成员。如果__all__定义有误，列出的成员不存在，还会明确地抛出异常，而不是默默忽略。

如果一个模块需要暴露的接口改动频繁，all 可以这样定义：

all = [
“foo”,
“bar”,
“egg”,
]

最后多出来的逗号在 Python 中是允许的，也是符合 PEP8 风格的。这样修改一个接口的暴露就只修改一行，方便版本控制的时候看 diff。