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

为什么Python项目根目录下需要一个空的__init__.py?

梦辰大大_2837

梦辰大大_2837

发布时间:2026-06-19 14:31:15

|

687人浏览过

|

来源于php中文网

原创

根目录放__init__.py通常没必要且错误:它使项目被识别为包,破坏pytest/unittest模块发现、导致相对导入崩溃;仅当项目需作为可安装包发布且用pip install -e .时才考虑,但更推荐将包置于src/子目录。

为什么python项目根目录下需要一个空的__init__.py?

根目录下放空的 __init__.py 通常**没必要,而且多数时候是错的**——它会让 Python 把整个项目当成一个包,反而破坏模块发现逻辑、干扰测试运行、导致 from . import xxx 报错。

为什么根目录加 __init__.py 会破坏 pytest / unittest 运行?

pytest 默认把当前工作目录(即项目根目录)加入 sys.path,再按文件路径导入测试模块。一旦根目录有 __init__.py,Python 就把它识别为包,而 pytest 会尝试以包方式导入测试文件(比如 python -m pytest tests/test_api.py),此时 test_api.py 的 __package__ 变成 "" 或 None,相对导入直接崩溃:

  • SystemError: Parent module '' not loaded, cannot perform relative import
  • 即使测试文件里没写 from .. import xxx,只要它所在目录被当成包,__package__ 就可能被错误推导
  • 某些 IDE(如 PyCharm)在“Run as pytest”时也会因该文件误判包结构,跳过测试发现

什么情况下根目录才需要 __init__.py?

仅当你的项目本身要被其他项目当作可安装包使用,且你明确用 setuptools 打包发布(比如 pip install -e .),才可能考虑在根目录放 __init__.py ——但更推荐的做法是:把真正要发布的包放在子目录里(如 src/mylib/),根目录保持干净。

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • ✅ 推荐结构:myproject/(无 __init__.py) → src/mylib/__init__.py(有) → tests/(无)
  • ❌ 反模式:myproject/__init__.py + myproject/main.py + myproject/tests/;这会让 import myproject 成立,但 pytest 和 python -m 行为变得不可预测
  • 构建工具如 poetry 或 hatch 默认不依赖根目录 __init__.py,它们靠 pyproject.toml 中的 [project] 配置定位源码

__init__.py 应该出现在哪些位置?

只在**明确需要被 import 的子目录**里放 __init__.py,比如:

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

  • 业务代码包:app/、api/、models/、utils/
  • 测试辅助模块:tests/conftest.py 所在的 tests/ 目录(如果测试里用了 from tests.utils import fake_db)
  • 子包嵌套:api/v1/__init__.py、api/v2/__init__.py
  • 空文件完全 OK,不需要写任何代码;但若想简化导入(如让 from api import login 可用),就在对应 __init__.py 里写 from .login_api import login

最容易被忽略的一点:根目录有没有 __init__.py,和你的代码能不能被导入,根本无关——真正起作用的是 Python 如何解析 sys.path 和模块路径,而不是根目录是否“自封为包”。别被旧教程带偏,删掉它,世界更清净。

热门AI工具

更多
WorkBuddy

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

蛙蛙写作

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

DeepSeek

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

豆包大模型

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

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

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

1771

2023.07.20

python能做什么
python能做什么

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

4584

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

27117

2023.08.03

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

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

3287

2023.08.04

python eval
python eval

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

3287

2023.08.04

scratch和python区别
scratch和python区别

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

1203

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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