__all__仅控制from module import *的导入行为,不约束显式导入;必须定义在模块顶层,列表元素须为存在且拼写准确的字符串,本质是API边界声明而非访问控制。

__all__ 只影响 from module import *,不影响显式导入
Python 的 __all__ 是一个字符串列表,仅在执行 from module import * 时起作用。它不阻止你用 import module 或 from module import func_name 访问任何东西——那些方式完全绕过 __all__ 检查。
常见错误现象:写了 __all__ = ["public_func"],但用户仍能通过 from mymod import _private_helper 成功导入,于是误以为 __all__ 失效了。其实它根本没被触发。
-
__all__必须定义在模块顶层(不能在函数或类里) - 如果模块没定义
__all__,from module import *会导入所有不以下划线开头的公有名称(即not name.startswith('_')) - 如果
__all__包含了不存在的名称,导入时不会报错,只是忽略该条目
__all__ 列表里的名字必须是字符串,且需与实际可访问变量名一致
写成 __all__ = [my_func](没加引号)会直接抛 NameError;写成 __all__ = ["my_func", "MyClass", "missing_var"],其中 missing_var 未定义,from module import * 仍能成功,只是不导入它。
使用场景:当你希望明确暴露一组稳定接口,同时隐藏内部辅助函数、测试用例或临时变量时,__all__ 是最轻量的“API 边界声明”手段。
立即学习“Python免费学习笔记(深入)”;
Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能
- 名字必须拼写完全一致(大小写敏感,不能多空格)
- 不支持通配符(如
"helper_*")、正则或前缀匹配 - 动态生成(如
__all__ = [n for n in dir() if not n.startswith('_')])可行,但降低可读性,且可能漏掉后期import进来的符号
__all__ 不提供真正的封装或访问控制
Python 没有私有变量机制,__all__ 只是约定,不是强制。用户始终可以绕过它:import module; module._internal_func() 完全合法。它既不改变属性的可见性,也不影响 IDE 补全逻辑(某些 IDE 会参考 __all__,但非全部)。
性能和兼容性上无开销——它只在导入时被读取一次,解析为字符串列表,不参与运行时逻辑。
- 别把它当权限系统用;它更像一份“推荐导入清单”
- 如果模块依赖
from submodule import *,记得在子模块里也设好__all__,否则父模块的__all__无法控制子模块符号的暴露 - 类型检查器(如 mypy)默认不尊重
__all__,需额外配置(如 mypy 的disallow_untyped_defs不相关,得靠follow_imports=normal和模块结构配合)
实际项目中 __all__ 的典型写法
多数成熟库(如 requests、click)会在 __init__.py 显式列出公开 API,避免意外导出内部模块路径或调试变量。
# mypackage/__init__.py from .core import process_data, validate_input from .utils import format_error <p><strong>all</strong> = [ "process_data", "validate_input", "format_error", ]</p>
注意:上面没写 core 或 utils,所以 from mypackage import core 不会成功——除非你在 __all__ 里加了它们。这种写法把实现细节(模块名)和接口名(函数名)做了分离,是更干净的设计。
容易被忽略的是:如果你在 __init__.py 中只做 import submodule 而不 from submodule import xxx,那么即使 submodule.__all__ 设好了,from mypackage import * 也不会自动转发那些符号——你得手动 re-export。

















