0

0

Python 包初始化代码的正确放置位置

舞夢輝影

舞夢輝影

发布时间:2026-02-21 16:53:02

|

114人浏览过

|

来源于php中文网

原创

__init__.py 必须放在希望被当作python包导入的最外层目录中,如 mypackage/ 下;空文件即可生效,但若编写内容需避免耗时操作与循环导入,并合理使用 __all__ 和子模块导入来控制接口。

python 包初始化代码的正确放置位置

__init__.py 应该放在哪个目录里

它必须出现在你想让 Python 把那个目录当作一个包来导入的最外层目录下。不是所有目录都要放,只在你明确要 import mypackagefrom mypackage import something 的那个目录里放。

常见错误现象:ModuleNotFoundError: No module named 'mypackage',往往是因为 __init__.py 缺失,或者位置比你预期的高/低了一层。

  • 如果你运行 python main.py,而 main.py 试图 import utils,那 utils/ 目录下就得有 __init__.py
  • 如果项目结构是 src/mypackage/__init__.py,但你没把 src 加进 PYTHONPATH 或没用 -m 方式运行,Python 就找不到 mypackage
  • 空文件即可生效;内容可以为空,不需要写任何代码

__init__.py 里写什么才不算多余

它不是必须写东西,但一旦写了,就会影响包的公开接口和导入行为——这点容易被忽略。

使用场景:你想控制 from mypackage import * 暴露哪些名字,或想简化嵌套模块的导入路径。

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

Voicenotes
Voicenotes

Voicenotes是一款简单直观的多功能AI语音笔记工具

下载
  • __all__ = ['Client', 'Config'] 明确限定 from mypackage import * 可导入的内容
  • __init__.pyfrom .core import Client,就能让用户直接 from mypackage import Client,而不是 from mypackage.core import Client
  • 避免在 __init__.py 中做耗时操作(比如读配置、连数据库),因为只要导入包就会执行它
  • 别在 __init__.py 里循环导入同级模块,容易触发 ImportError: cannot import name 'X' from partially initialized module

Python 3.3+ 还需要 __init__.py 吗

技术上,PEP 420 引入了隐式命名空间包,允许没有 __init__.py 的目录被识别为包——但仅限于特定场景,不能当作默认做法。

性能 / 兼容性影响:不放 __init__.py 会让包失去明确边界,IDE 和静态检查工具(如 mypy、pylint)可能无法正确解析相对导入或类型提示。

  • 如果你的包要发布到 PyPI,必须包含 __init__.py,否则安装后无法导入
  • 多个分散目录组成一个逻辑包(比如插件目录)时,才可以考虑不用 __init__.py,但这是例外,不是常规
  • 团队协作中,显式优于隐式;少一个 __init__.py 带来的“简洁”,远不如它带来的可维护性损失

setup.py / pyproject.toml 里怎么配合包初始化

构建配置文件不会自动帮你补 __init__.py,但它会决定 Python 最终从哪找包——这两者必须对齐。

常见错误现象:本地能 import mypkg,打包后安装却报错,大概率是 setuptools.find_packages() 没扫到你的包目录,或者 packages 列表漏了。

  • find_packages(where="src") 时,确保 src/mypkg/__init__.py 存在,且 src 是实际根目录
  • pyproject.toml[project] packages = ["mypkg"] 要和磁盘上 mypkg/__init__.py 的路径严格对应
  • 不要依赖 package-dir 魔改路径来绕过 __init__.py 缺失问题,这会让调试和 IDE 支持变差
真正容易被忽略的是:包初始化不是“有没有”的问题,而是“谁在什么时候、以什么方式触发了它的加载”。哪怕只差一层目录、一个路径配置、一次没注意的 cd__init__.py 就形同虚设。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1557

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

443

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2270

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

39

2026.01.19

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

374

2023.06.29

如何删除数据库
如何删除数据库

删除数据库是指在MySQL中完全移除一个数据库及其所包含的所有数据和结构,作用包括:1、释放存储空间;2、确保数据的安全性;3、提高数据库的整体性能,加速查询和操作的执行速度。尽管删除数据库具有一些好处,但在执行任何删除操作之前,务必谨慎操作,并备份重要的数据。删除数据库将永久性地删除所有相关数据和结构,无法回滚。

2094

2023.08.14

vb怎么连接数据库
vb怎么连接数据库

在VB中,连接数据库通常使用ADO(ActiveX 数据对象)或 DAO(Data Access Objects)这两个技术来实现:1、引入ADO库;2、创建ADO连接对象;3、配置连接字符串;4、打开连接;5、执行SQL语句;6、处理查询结果;7、关闭连接即可。

356

2023.08.31

MySQL恢复数据库
MySQL恢复数据库

MySQL恢复数据库的方法有使用物理备份恢复、使用逻辑备份恢复、使用二进制日志恢复和使用数据库复制进行恢复等。本专题为大家提供MySQL数据库相关的文章、下载、课程内容,供大家免费下载体验。

259

2023.09.05

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

796

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号