如何在Python中利用__all__控制模块导出时被import*引入的内容?

夏枫君_5110

夏枫君_5110

2026-08-27

872人浏览

原创

__all__ 是模块内显式声明「哪些名字能被 from module import * 导入」的唯一方式;没定义时默认导入不以下划线开头的名字但不可靠,必须显式定义为顶层字符串列表,否则导致导入行为不确定、工具链误报及api不稳定。

如何在python中利用__all__控制模块导出时被import*引入的内容?

直接说结论: __all__ 是模块内显式声明「哪些名字能被 from module import * 导入」的唯一方式;没定义 __all__ 时,import * 默认只导入不以下划线开头的公有名字,但行为不可靠,应始终显式定义。

为什么 __all__ 不是可选的「建议」而是必须的约束

很多人误以为 __all__ 只是文档提示,其实它是 Python 解释器强制执行的白名单。一旦定义,from module import * 就完全忽略模块里其他所有名字(包括没加下划线的),哪怕它们是函数或类。

  • 没定义 __all__:Python 会扫描模块全局变量,自动收集所有不以 _ 开头的名字 —— 但这个过程不检查是否真正可导出(比如动态生成的变量、import 进来的名字可能被意外包含)
  • 定义了 __all__:解释器只认这个列表里的字符串,其余一概过滤,连 __version__ 或 logger 这种常见公有变量也不会进导入结果
  • 类型检查工具(如 mypy)和 IDE(如 PyCharm)也依赖 __all__ 做补全和错误提示,不设会导致误报或漏报

__all__ 必须是字符串列表,且只能出现在模块顶层

它不是注释,不是变量别名,也不是运行时计算的结果 —— 必须是字面量列表,且不能在函数、类或条件块里定义。

  • ✅ 正确写法:__all__ = ["load_config", "DEFAULT_TIMEOUT", "ConfigError"]
  • ❌ 错误写法:__all__ = [name for name in dir() if not name.startswith("_")](动态生成,import * 时还没执行)
  • ❌ 错误写法:if DEBUG: __all__ = [...](条件分支导致 import * 行为不稳定)
  • ❌ 错误写法:__all__ = ("load_config",)(元组不行,必须是 list 或 tuple?等等 —— 实际上 tuple 也行,但官方文档明确要求「list」,且多数 lint 工具(如 flake8)会警告非 list)

示例模块 config.py:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
__all__ = ["load_config", "DEFAULT_TIMEOUT", "ConfigError"]
<p>DEFAULT_TIMEOUT = 30</p><p>class ConfigError(Exception):
pass</p><p>def load_config(path):
...</p><p>def _parse_env():
...  # 不会被 import * 导入</p><p>import json  # json 模块名不会被导入,除非显式写进 <strong>all</strong></p>

常见陷阱:__all__ 和 import 的交互关系

__all__ 控制的是「从本模块导出什么」,不影响「本模块内部怎么 import」。但它直接影响别人 from this_module import * 能拿到什么 —— 包括你 import 进来的名字。

  • 想让别人通过 import * 用到你 import 的东西?必须手动加进 __all__,例如:from pathlib import Path 后,要写 __all__ = ["Path"]
  • from .submodule import * 不会自动合并到父模块的 __all__,必须显式列出:__all__ = ["Path", "load_config"],不能靠子模块自己定义
  • 如果模块里用了 import numpy as np,np 不会自动进入 import * 结果 —— 即使你把它加进 __all__,也得确保 np 在当前命名空间存在(即 import 语句已执行)

最易被忽略的一点:修改 __all__ 后,必须同步更新文档、类型注解和测试用例里的导入方式 —— 因为 import * 本身就不推荐用于生产代码,它的存在主要是为了兼容旧习惯或特定 DSL 场景,真正在意 API 稳定性的库,应该让人明确写 from module import func。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1791

4

python能做什么
python能做什么

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

2023.07.25

4724

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

28097

23

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

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

2023.08.04

3387

5

python eval
python eval

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

2023.08.04

3387

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2623

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习