Python中from package import *为什么失效_设置__all__列表白名单

老宇君_2047

老宇君_2047

2026-04-09

879人浏览

原创

from package import * 只导入 __all__ 列表中明确声明的名字,未列出的即使存在也不会被导入;若未定义 __all__,则仅自动导入同级非下划线开头的 .py 模块,不递归子包。

python中from package import *为什么失效_设置__all__列表白名单

from package import * 为什么只导入部分模块

因为 Python 默认不会把包里所有模块都暴露给 from package import *,它只认 __all__ 列表里明确写进去的名字。没加进去的,哪怕文件存在、能 import 成功,也不会被星号导入捕获。

这跟“有没有 __init__.py”无关,也跟文件名是否合法无关——核心就一条:__all__ 是白名单,不是黑名单。

  • __all__ 必须定义在包的 __init__.py 文件中(类型为 list 或 tuple),且元素必须是字符串
  • 如果 __init__.py 里根本没定义 __all__,Python 会退而求其次,尝试扫描当前目录下所有 .py 文件名,但**仅限于不以下划线开头的文件**(即忽略 _helper.py 这类)
  • 即便走自动扫描逻辑,它也**不会递归子包**,更不会导入模块内部的函数或类——只导入同级模块对象本身

__all__ 里该写模块名还是对象名

写什么,取决于你希望用户通过 from package import * 拿到什么。它控制的是“导入后出现在当前命名空间里的名字”,不是“要加载哪些文件”。

比如 package/__init__.py 里写了 __all__ = ["utils", "config"],那 from package import * 后,utils 和 config 这两个模块对象就可用;但如果想让用户直接用 load_yaml(),就得把函数名放进 __all__,并提前在 __init__.py 中导入它:

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
from .utils import load_yaml
__all__ = ["load_yaml"]
  • 写模块名(如 "utils"):导入的是模块对象,使用时需 utils.load_yaml()
  • 写函数/类名(如 "load_yaml"):前提是已在 __init__.py 中执行了 from .utils import load_yaml,否则运行时报 NameError
  • 混写允许,但容易混乱;建议统一风格,多数库倾向导出易用的对象名而非模块名

常见失效场景和调试方法

最典型的“明明写了 __all__ 却不生效”,往往卡在路径或执行顺序上。

  • 检查是否误改了 __init__.py 的编码或加了 BOM 头,导致 __all__ 定义没被正确解析(可打印 dir(package) 看实际内容)
  • 确认 __all__ 是顶层变量,没被缩进、没被包裹在函数或条件块里(例如 if False: 下的定义无效)
  • 注意相对导入路径错误:若 __init__.py 中写 from utils import xxx(缺点),Python 会去父级找 utils,而不是当前包下的 utils.py,结果 xxx 根本没导入成功,__all__ 里列了也白列
  • 执行 from package import * 后,用 print([x for x in dir() if not x.startswith('_')]) 快速验证导入效果

替代方案比 __all__ 更可控

依赖 __all__ + 星号导入本质是妥协方案,容易失控。真正需要清晰 API 边界的项目,应该主动设计导入入口。

  • 在 __init__.py 中显式导入并重命名:例如 from .core import run as execute,再把 "execute" 加入 __all__,避免用户直呼内部模块名
  • 用 __getattr__(Python 3.7+)做懒加载:对非核心功能延迟导入,既减少启动开销,又能按需暴露接口
  • 彻底放弃 import *,改用文档明确列出推荐导入方式,比如 from package.core import execute —— 大多数成熟库(如 requests、click)都不支持星号导入

别低估 __all__ 的维护成本:每次新增一个公开接口,不仅要改实现文件,还得同步更新 __init__.py 里的字符串列表,漏一次,用户就用不了。真正的边界控制,得靠导入逻辑本身,而不是一个靠人维护的字符串清单。

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

相关专题

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

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

2023.07.20

1751

4

python能做什么
python能做什么

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

2023.07.25

4504

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26437

23

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

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

2023.08.04

3207

5

python eval
python eval

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

2023.08.04

3227

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2503

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习