如何在Python大型项目中合理设计__init__.py文件

酷婷同学_1516

酷婷同学_1516

2026-09-21

260人浏览

原创

__init__.py 是包的接口声明文件,用于控制对外暴露的api、初始化轻量配置,并确保工具链正常工作;它必须存在且应显式精简导出,而非填充实现或执行耗时操作。

如何在python大型项目中合理设计__init__.py文件

直接说结论:__init__.py 不是用来“填满”的,而是用来“收口”和“声明”的——它决定别人怎么用你的包,而不是你怎么组织文件。

__init__.py 必须存在,哪怕它是空的

Python 3.3+ 虽然支持隐式命名空间包,但空的 __init__.py 仍是事实标准。没有它,IDE 可能无法正确识别包路径,pytest 可能跳过测试目录,CI 构建时也可能因导入失败而中断。

  • 所有子包目录(如 src/api/v1/src/core/utils/)都必须有 __init__.py,哪怕内容为空
  • 不建议依赖隐式包——团队协作中,显式即可靠
  • Git 中保留空文件:用 touch src/core/__init__.py,别删

用 __all__ 显式控制 from package import *

不声明 __all__ 时,from mypkg import * 会把 __init__.py 里所有非下划线开头的名称全拉进来,包括临时变量、调试函数、未完成的重构残留——这是大型项目里最隐蔽的命名污染源。

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载
  • __all__ 应该只包含你**明确承诺对外公开**的接口,比如 ["Client", "Config", "load_config"]
  • 避免写 from .submodule import * 再配 __all__——这会让实际导出内容脱离控制,难以审计
  • 推荐写法:from .config import Config, load_config,然后 __all__ = ["Config", "load_config"]

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

包首次被导入时,__init__.py 全局代码会执行一次。这适合设常量、配日志、注册插件,但绝不适合连接数据库、加载大模型或读取 GB 级配置文件。

  • 常见安全初始化:logging.getLogger(__name__).addHandler(...)VERSION = "2.4.0"__version__ = VERSION
  • 禁止在 __init__.py 里调用 requests.get()open("huge.yaml") —— 这会导致任何导入该包的单元测试变慢甚至失败
  • 若需动态初始化(如自动发现子模块),用惰性函数封装,而非直接执行:def get_drivers(): ...,不在顶层调用

通过 __init__.py 暴露统一入口,但别掩盖真实结构

用户从 myproject.api 导入 create_user,不等于这个函数必须物理存在于 api/__init__.py。合理做法是让它留在 api/endpoints/user.py,再由 api/__init__.py 显式导入并暴露。

  • 好处:IDE 能跳转到真实实现;git blame 清晰;重构时只需改一处导入
  • 坏做法:from .endpoints.user import * —— 会把 user.py 里所有公有名都拖进来,破坏封装
  • 更清晰的写法:from .endpoints.user import create_user, delete_user,再列进 __all__

真正难的不是写 __init__.py,而是每次新增一个模块时,想清楚:“这个东西,我打算让谁、在什么场景下、以什么方式来用它?”——__init__.py 就是那个回答问题的地方。写得太满,别人不敢动;写得太空,别人不知道怎么开始。平衡点就在“最小必要暴露”上。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3624

7

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

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

2023.07.31

1549

3

python教程
python教程

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

2023.08.03

20617

23

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

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

2023.08.04

2547

5

python eval
python eval

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

2023.08.04

2607

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2023

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程