为 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__
可以这样定义: