[转载]python之__all__

[转载]使用__all__暴露接口

在Python中我们可以使用__all__暴露出模块级别的接口：

__all__ = ['foo', 'bar']

这样在其他模块导入本模块时，会将列表中定义的变量或者函数暴露出去。而不会暴露出其他的变量或者函数。

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

不像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__定义有误，列出的成员不存在，还会明确地抛出异常，而不是默默忽略。

为 lint 工具提供辅助

编写一个库的时候，经常会在__init__.py中暴露整个包的 API，而这些 API 的实现可能是在包中其他模块中定义的。如果我们仅仅这样写：

from foo.bar import Spam, Egg

一些代码检查工具，如pyflakes就会报错，认为Spam和Egg是import了又没被使用的变量。当然一个可行的方法是把这个警告压掉：

from foo.bar import Spam, Egg  # noqa

但是更好的方法是显式定义__all__，这样代码检查工具会理解这层意思，就不再报unused variables的警告：

from foo.bar import Spam, Egg

__all__ = ["Spam", "Egg"]

需要注意的是大部分情况下__all__都是一个list，而不是tuple或者其他序列类型。如果写了其他类型的__all__，如无意外pyflakes 等lint工具会无法识别出。

定义 all 需要注意的地方

• 如上所述__all__应该是list类型的
• 不应该动态生成__all__，比如使用列表解析式。__all__的作用就是定义公开接口，如果不以字面量的形式显式写出来，就失去意义了。
• 即使有了__all__也不应该在非临时代码中使用from xxx import *语法，或者用元编程手段模拟Ruby的自动import。Python不像Ruby，没有Module这种成员，模块就是命名空间隔离的执行者。如果打破了这一层，而且引入诸多动态因素，生产环境跑的代码就充满了不确定性，调试也会非常困难。
• 按照 PEP8 建议的风格，__all__应该写在所有import语句下面，和函数、常量等模块成员定义的上面。

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

__all__ = [
"foo",
"bar",
"egg",
]

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

学习Python时找到的一篇文章。

本文转载自http://python-china.org/t/725