Python模块中的__all__特殊变量如何控制from module import *的行为?

雨辰小哥_5514

雨辰小哥_5514

2026-11-16

207人浏览

原创

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

python模块中的__all__特殊变量如何控制from module import *的行为?

__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 边界声明”手段。

  • 名字必须拼写完全一致(大小写敏感,不能多空格)
  • 不支持通配符(如 "helper_*")、正则或前缀匹配
  • 动态生成(如 __all__ = [n for n in dir() if not n.startswith('_')])可行,但降低可读性,且可能漏掉后期 import 进来的符号

__all__ 不提供真正的封装或访问控制

Python 没有私有变量机制,__all__ 只是约定,不是强制。用户始终可以绕过它:import module; module._internal_func() 完全合法。它既不改变属性的可见性,也不影响 IDE 补全逻辑(某些 IDE 会参考 __all__,但非全部)。

Python 环境工具专业版
Python 环境工具专业版

Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能

下载

性能和兼容性上无开销——它只在导入时被读取一次,解析为字符串列表,不参与运行时逻辑。

  • 别把它当权限系统用;它更像一份“推荐导入清单”
  • 如果模块依赖 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。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1931

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5464

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1889

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

33297

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3907

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3927

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3043

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程