python __all__

用 __all__ 暴露接口

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

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

 

 

 调用模块里面的方法有两种情况：1、import msg （msg.test1()） 2、from msg import test1（test1() ）

test1（）、test2（）同时调用   from msg

如果想限制用户的调用，就用__all__=[ ]对其做限制

 

结果如下

 

定义 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。

转载于：https://blog.csdn.net/hang916/article/details/79474821