<p>all 是 Python 中用于控制模块导入行为的特殊变量,它是一个字符串列表,定义了模块的公共接口。当使用 from module import 时,Python 只会导入 all 中列出的名称,从而限制未公开的函数、类或变量被意外导入。例如,在 mymodule.py 中设置 all = ['func_a', 'MyClass'] 后,执行 from mymodule import 仅导入 func_a 和 MyClass,而以下划线开头的 _func_b 和 _PrivateClass 不会被导入。这有助于明确模块的公共 API,提升代码可维护性,避免命名冲突,并支持后期重构。建议在开发公共库时始终定义 all,并将其置于模块顶部,配合文档使用,以增强 API 的清晰性和工具支持。</p>

__all__ 是 Python 中一个特殊的变量,用来控制模块在使用 from module import * 时,哪些名称会被导入。它是一个字符串列表,定义了模块的公共接口。
作用:限制 * 导入的内容
当你在模块中写 from mymodule import *,Python 默认会导入所有不以下划线开头的全局名称。但通过定义 __all__,你可以明确指定只允许导入某些名字。
例如,mymodule.py 内容如下:
__all__ = ['func_a', 'MyClass']
<p>func_a = lambda: print("公开函数")</p><p><span>立即学习</span>“<a href="https://pan.quark.cn/s/00968c3c2c15" style="text-decoration: underline !important; color: blue; font-weight: bolder;" rel="nofollow" target="_blank">Python免费学习笔记(深入)</a>”;</p><p>_func_b = lambda: print("私有函数")</p><div class="aritcle_card flexRow">
<div class="artcardd flexRow">
<a class="aritcle_card_img" href="/ai/1446" title="Imagine By Magic Studio"><img
src="https://img.php.cn/upload/ai_manual/001/431/639/68b6cd725c13a417.png" alt="Imagine By Magic Studio" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
<div class="aritcle_card_info flexColumn">
<a href="/ai/1446" title="Imagine By Magic Studio">Imagine By Magic Studio</a>
<p>AI图片生成器,用文字制作图片</p>
</div>
<a href="/ai/1446" title="Imagine By Magic Studio" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span> </a>
</div>
</div><p>class MyClass:
pass</p><p>class _PrivateClass:
pass</p>此时执行 from mymodule import *,只会导入 func_a 和 MyClass,不会导入 _func_b 和 _PrivateClass。
提升代码可维护性
显式声明 __all__ 能让其他开发者清楚知道模块提供的公共 API 有哪些。这在大型项目或库开发中尤其重要。
好处包括:
- 避免意外导出内部使用的函数或变量
- 防止命名冲突(比如工具函数名与用户变量重名)
- 便于后期重构,只要保持 __all__ 中的接口不变,内部实现可以随意调整
实际使用建议
虽然 __all__ 不是强制的,但在编写公开库时建议始终定义它。
- 放在模块顶部,靠近其他元数据(如 __version__)
- 只包含希望用户直接访问的对象
- 配合文档一起使用,确保 API 清晰
- IDE 和静态分析工具通常会参考 __all__ 提供自动补全提示
基本上就这些。合理使用 __all__ 能让你的 Python 模块更专业、更可控。










