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

梦辰大大_2837

梦辰大大_2837

2026-06-19

687人浏览

原创

根目录放__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学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
  • ✅ 推荐结构: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,比如:

  • 业务代码包: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 和模块路径,而不是根目录是否“自封为包”。别被旧教程带偏,删掉它,世界更清净。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4624

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27317

23

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

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

2023.08.04

3307

5

python eval
python eval

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

2023.08.04

3307

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

596

4

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

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

2023.08.11

2563

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习