讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用Python的__init__.py文件简化包内部模块的对外导出?

千婷酱_2631

千婷酱_2631

发布时间:2026-07-16 10:10:33

|

697人浏览过

|

来源于php中文网

原创

__all__ 必须是字符串列表,显式列出 __init__.py 中已定义的名称(如 from .submodule import X 或 X = submodule.X),才能控制 from xxx import * 的导入行为;未定义 __all__ 时,默认导入所有不以下划线开头的名称。

如何利用python的__init__.py文件简化包内部模块的对外导出?

__init__.py 里直接 import 并赋值给 __all__ 才能控制 from xxx import * 的行为

很多人误以为只要在 __init__.py 中写 import module,外部就能直接用 from package import module —— 实际上这只能让模块被加载,但不会自动导出名字。真正决定“哪些名能被 from package import * 拿到”的是 __all__ 列表。

常见错误现象:from mypkg import * 后发现啥都没导入,或者意外导入了你不希望暴露的内部工具函数。

  • __all__ 必须是字符串列表,比如 __all__ = ["Client", "connect", "DEFAULT_TIMEOUT"]
  • 列表里的每个字符串,必须对应 __init__.py 中已存在的变量名(通常是通过 from .submodule import X 或 X = submodule.X 绑定的)
  • 如果没定义 __all__,from xxx import * 会默认导入所有不以下划线开头的名称——这往往包含你不打算公开的辅助函数或测试类

用 from .module import name 而不是 import module 简化对外接口

假设包结构是 mypkg/ 下有 __init__.py、client.py、utils.py,你想让用户只写 from mypkg import Client,而不是 from mypkg.client import Client。

这时候在 __init__.py 中写 from .client import Client,比写 import mypkg.client 更直接有效——前者把 Client 名字注入到包命名空间,后者只是加载模块,Client 还得通过 mypkg.client.Client 访问。

立即学习“Python免费学习笔记(深入)”;

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 推荐显式导入: from .client import Client、from .utils import format_url
  • 避免 from .client import *,它会污染 __all__ 控制,也掩盖了来源
  • 如果模块里有大量要导出的符号,可以先 from .client import * 再手动清掉不需要的:del _helper_func

__init__.py 中的相对导入路径容易写错

在 __init__.py 里用 from .submodule import X 是相对导入,点号数量和位置稍有偏差就会报 ImportError: attempted relative import with no known parent package 或 ModuleNotFoundError。

根本原因:Python 只有把一个目录当作包来运行(比如 python -m mypkg)或明确作为子模块导入时,才支持相对导入。直接运行 __init__.py 文件会失败。

  • 确保包是通过 import mypkg 或 from mypkg import X 方式导入,而不是 python mypkg/__init__.py
  • 层级深时,用 from ..parent import X 要小心——上级目录必须也是包(含 __init__.py),且当前文件确实属于该包的子模块
  • 调试时可临时加 print(__name__, __package__) 看当前模块的全名和包上下文

别在 __init__.py 里做耗时初始化操作

有人习惯在 __init__.py 里连接数据库、读配置文件、初始化全局 client 实例——这会让任何一次 import mypkg 都变慢,甚至因环境缺失而失败,哪怕用户只想要其中某个工具函数。

典型问题场景:CI 环境没配 DB,但测试脚本只是 import mypkg.utils,却因 __init__.py 里执行了 init_db() 而崩溃。

  • 把副作用操作移到单独函数里,比如 mypkg.init(),由用户显式调用
  • 用懒加载模式:定义一个 _client = None,在首次访问属性时才创建实例
  • 配置类可以预定义,但不要在导入时就解析 os.environ 或读磁盘文件

最常被忽略的一点:__init__.py 的执行时机是模块首次导入时,且只执行一次。但它不是“包启动入口”,也不适合放业务逻辑——它只是命名空间的整理员。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4164

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24157

2023.08.03

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

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

2947

2023.08.04

python eval
python eval

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

2987

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn