python __all__用法

今天在阅读程序的时候看到这么一行代码：

__all__ = ['S3DIS']

搜了搜将__all__的用法整理下来。

来源：

1. Python __all__变量用法
2. 【Python】all 暴露接口

---

当我们向文件导入某个模块时，导入的是该模块中那些名称不以下划线（单下划线“_”或者双下划线“__”）开头的变量、函数和类。因此，如果我们不想模块文件中的某个成员被引入到其它文件中使用，可以在其名称前添加下划线。

# mytest.py
def a():
    print('aaaaa')
def b():
    print('bbbbb')
def _c():
    print('ccccc')
    
# mytest2.py
from mytest import *
a()
b()
c()

运行mytest2.py，结果：

Traceback (most recent call last):
  File "/home/mytest2.py", line 6, in <module>
    c()
NameError: name 'c' is not defined
aaaaa
bbbbb

显然，mytest2.py 文件中无法使用未引入的c() 函数。
除此之外，还可以借助模块提供的__all__ 变量，该变量的值是一个列表，存储的是当前模块中一些成员（变量、函数或者类）的名称。通过在模块文件中设置__all__变量，当其它文件以“from 模块名 import *”的形式导入该模块时，该文件中只能使用__all__ 列表中指定的成员。__all__也是对于模块公开接口的一种约定，比起下划线，__all__提供了暴露接口用的“白名单”。

# mytest.py
__all__ = ['a','b']  #这里不同

def a():
    print('aaaaa')
def b():
    print('bbbbb') 
def c():                  # 这里不同
    print('ccccc')
    
# mytest2.py
from mytest import *
a()
b()
c()

运行mytest2.py，结果：

Traceback (most recent call last):
  File "/home/mytest2.py", line 6, in <module>
    c()
NameError: name 'c' is not defined
aaaaa
bbbbb

__all__中只包含了a()和b()两个函数，因此在用from mytest import *导入模块时c()函数是未被引入 的。

注意：

1. __all__变量只在以from 模块名 import *形式导入模块时起作用，而以其他形式，如import 模块名、from 模块名 import 成员时都不起作用。
2. 代码中当然是不提倡用 from xxx import * 的写法的，一般只用在临时代码如console调试中，这种时候如果没有定义__all__，会将模块中非下划线开头的所有成员都导入当前命名空间中，可能弄脏当前命名空间。
3. __all__应该是list 类型的。
4. 不应该动态生成__all__，比如使用列表解析式。
5. __all__的位置：按照 PEP8 建议的风格，__all__应该写在所有 import 语句下面，和函数、常量等模块成员定义的上面。