浅谈Python __init__.py的作用


Posted in Python onOctober 28, 2020

我们经常在python的模块目录中会看到 "__init__.py"  这个文件,那么它到底有什么作用呢?

1. 标识该目录是一个python的模块包(module package)

如果你是使用python的相关IDE来进行开发,那么如果目录中存在该文件,该目录就会被识别为 module package 。

2. 简化模块导入操作

假设我们的模块包的目录结构如下:

.
└── mypackage
  ├── subpackage_1
  │  ├── test11.py
  │  └── test12.py
  ├── subpackage_2
  │  ├── test21.py
  │  └── test22.py
  └── subpackage_3
    ├── test31.py
    └── test32.py

如果我们使用最直接的导入方式,将整个文件拷贝到工程目录下,然后直接导入:

from mypackage.subpackage_1 import test11
from mypackage.subpackage_1 import test12
from mypackage.subpackage_2 import test21
from mypackage.subpackage_2 import test22
from mypackage.subpackage_3 import test31
from mypackage.subpackage_3 import test32

当然这个例子里面文件比较少,如果模块比较大,目录比较深的话,可能自己都记不清该如何导入。(很有可能,哪怕只想导入一个模块都要在目录中找很久)

这种情况下,__init__.py 就很有作用了。我们先来看看该文件是如何工作的。

2.1 __init__.py 是怎么工作的?

实际上,如果目录中包含了 __init__.py 时,当用 import 导入该目录时,会执行 __init__.py 里面的代码。

我们在mypackage目录下增加一个 __init__.py 文件来做一个实验:

.
└── mypackage
  ├── __init__.py
  ├── subpackage_1
  │  ├── test11.py
  │  └── test12.py
  ├── subpackage_2
  │  ├── test21.py
  │  └── test22.py
  └── subpackage_3
    ├── test31.py
    └── test32.py

mypackage/__init__.py 里面加一个print,如果执行了该文件就会输出:

print("You have imported mypackage")

下面直接用交互模式进行 import

>>> import mypackage
You have imported mypackage

很显然,__init__.py 在包被导入时会被执行。

2.2  控制模块导入

我们再做一个实验,在 mypackage/__init__.py 添加以下语句:

from subpackage_1 import test11

我们导入 mypackage 试试:

>>> import mypackage
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
 File "/home/taopeng/Workspace/Test/mypackage/__init__.py", line 2, in <module>
  from subpackage_1 import test11
ImportError: No module named 'subpackage_1'

报错了。。。怎么回事?

原来,在我们执行import时,当前目录是不会变的(就算是执行子目录的文件),还是需要完整的包名。

from mypackage.subpackage_1 import test11

综上,我们可以在__init__.py 指定默认需要导入的模块

2.3  偷懒的导入方法

有时候我们在做导入时会偷懒,将包中的所有内容导入

from mypackage import *

这是怎么实现的呢? __all__ 变量就是干这个工作的。

__all__ 关联了一个模块列表,当执行 from xx import * 时,就会导入列表中的模块。我们将 __init__.py 修改为 。

__all__ = ['subpackage_1', 'subpackage_2']

这里没有包含 subpackage_3,是为了证明 __all__ 起作用了,而不是导入了所有子目录。

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__doc__', '__loader__', '__name__', '__package__', '__path__', '__spec__']

子目录的中的模块没有导入!!!

该例子中的导入等价于

from mypackage import subpackage_1, subpackage_2

因此,导入操作会继续查找 subpackage_1 和 subpackage_2 中的 __init__.py 并执行。(但是此时不会执行 import *)

我们在 subpackage_1 下添加 __init__.py 文件:

__all__ = ['test11', 'test12']

# 默认只导入test11
from mypackage.subpackage_1 import test11

再来导入试试

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'test11']

如果想要导入子包的所有模块,则需要更精确指定。

>>> from mypackage.subpackage_1 import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'test11', 'test12']

3. 配置模块的初始化操作

在了解了 __init__.py 的工作原理后,应该能理解该文件就是一个正常的python代码文件。

因此可以将初始化代码放入该文件中。

到此这篇关于浅谈Python __init__.py的作用的文章就介绍到这了,更多相关Python __init__.py内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python实现115网盘自动下载的方法
Sep 30 Python
深入解析Python中的descriptor描述器的作用及用法
Jun 27 Python
python实现石头剪刀布程序
Jan 20 Python
python3+pyqt5+itchat微信定时发送消息的方法
Feb 20 Python
django如何实现视图重定向
Jul 24 Python
python requests更换代理适用于IP频率限制的方法
Aug 21 Python
OpenCV+face++实现实时人脸识别解锁功能
Aug 28 Python
python实现的发邮件功能示例
Sep 11 Python
Windows 下python3.8环境安装教程图文详解
Mar 11 Python
宝塔面板成功部署Django项目流程(图文)
Jun 22 Python
python查询MySQL将数据写入Excel
Oct 29 Python
matplotlib绘制鼠标的十字光标的实现(自定义方式,官方实例)
Jan 10 Python
详解Selenium-webdriver绕开反爬虫机制的4种方法
Oct 28 #Python
详解Python流程控制语句
Oct 28 #Python
详解selenium + chromedriver 被反爬的解决方法
Oct 28 #Python
手把手教你从PyCharm安装到激活(最新激活码),亲测有效可激活至2089年
Nov 25 #Python
Python字典实现伪切片功能
Oct 28 #Python
python使用selenium爬虫知乎的方法示例
Oct 28 #Python
怎么解决pycharm license Acti的方法
Oct 28 #Python
You might like
轻松入门: 煮好咖啡的七个诀窍
2021/03/03 冲泡冲煮
关于php程序报date()警告的处理(date_default_timezone_set)
2013/10/22 PHP
php模拟post提交数据的方法
2015/02/12 PHP
PHP培训要多少钱
2017/06/06 PHP
laravel接管Dingo-api和默认的错误处理方式
2019/10/25 PHP
Aster vs KG BO3 第三场2.18
2021/03/10 DOTA
从零开始学习jQuery (十一) 实战表单验证与自动完成提示插件
2011/02/23 Javascript
文本框input聚焦失焦样式实现代码
2012/10/12 Javascript
javascript 原型链维护和继承详解
2014/11/26 Javascript
基于javascript的COOkie的操作实现只能点一次
2014/12/26 Javascript
浅谈JavaScript 浏览器对象
2016/06/03 Javascript
Mvc提交表单的四种方法全程详解
2016/08/10 Javascript
微信小程序 video详解及简单实例
2017/01/16 Javascript
js实现分页功能
2017/05/24 Javascript
js单页hash路由原理与应用实战详解
2017/08/14 Javascript
基于ajax和jsonp的原生封装(实例)
2017/10/16 Javascript
详解vue-cli快速构建vue应用并实现webpack打包
2017/12/13 Javascript
基于vue-cli 打包时抽离项目相关配置文件详解
2018/03/07 Javascript
vue实现密码显示与隐藏按钮的自定义组件功能
2019/04/23 Javascript
vue 实现模糊检索并根据其他字符的首字母顺序排列
2019/09/19 Javascript
微信小程序 flexbox layout快速实现基本布局的解决方案
2020/03/24 Javascript
深入理解Python 代码优化详解
2014/10/27 Python
在Python中移动目录结构的方法
2016/01/31 Python
python excel使用xlutils类库实现追加写功能的方法
2018/05/02 Python
Python编写合并字典并实现敏感目录的小脚本
2019/02/26 Python
Python numpy数组转置与轴变换
2019/11/15 Python
用Python做一个久坐提醒小助手的示例代码
2020/02/10 Python
荷兰超市:DEEN
2018/03/14 全球购物
abstract class和interface有什么区别?
2012/01/03 面试题
工程造价与财务管理专业应届生求职信
2013/10/06 职场文书
校园创业策划书
2014/01/14 职场文书
党的群众路线教育实践活动制度建设计划
2014/11/03 职场文书
三严三实·严以修身心得体会
2016/01/15 职场文书
《风娃娃》教学反思
2016/02/18 职场文书
浅析CSS在DevTools 中架构演变
2021/10/05 HTML / CSS
instantclient客户端 连接oracle数据库
2022/04/26 Oracle