浅谈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 RuntimeError: thread.__init__() not called解决方法
Apr 28 Python
Python 使用os.remove删除文件夹时报错的解决方法
Jan 13 Python
Python通过matplotlib画双层饼图及环形图简单示例
Dec 15 Python
windows10下python3.5 pip3安装图文教程
Apr 02 Python
详解Python字符串切片
May 20 Python
python生成特定分布数的实例
Dec 05 Python
Python实现读取并写入Excel文件过程解析
May 27 Python
python实现图片转换成素描和漫画格式
Aug 19 Python
python 读取串口数据的示例
Nov 09 Python
python制作一个简单的gui 数据库查询界面
Nov 19 Python
如何利用python生成MD5并去重
Dec 07 Python
pandas中对文本类型数据的处理小结
Nov 01 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
东芝TOSHIBA RP-F11电路分析
2021/03/02 无线电
PHP中在数据库中保存Checkbox数据(2)
2006/10/09 PHP
PHP中strtr字符串替换用法详解
2014/11/26 PHP
PHP实现数组转JSon和JSon转数组的方法示例
2018/06/14 PHP
PHP时间戳和日期相互转换操作实例小结
2018/12/18 PHP
JS之小练习代码
2008/10/12 Javascript
JavaScript Sort 表格排序
2009/10/31 Javascript
弹出层之1:JQuery.Boxy (一) 使用介绍
2011/10/06 Javascript
jQuery实现跨域iframe接口方法调用
2015/03/14 Javascript
JavaScript Window浏览器对象模型方法与属性汇总
2015/04/20 Javascript
利用jQuery中的ajax分页实现代码
2016/02/25 Javascript
JS复制对应id的内容到粘贴板(Ctrl+C效果)
2017/01/23 Javascript
ES6中module模块化开发实例浅析
2017/04/06 Javascript
深入理解vue-loader如何使用
2017/06/06 Javascript
vue.js组件之间传递数据的方法
2017/07/10 Javascript
VUE2实现事件驱动弹窗示例
2017/10/21 Javascript
Vue基础学习之项目整合及优化
2019/06/02 Javascript
[41:17]VG vs Optic 2018国际邀请赛小组赛BO2 第二场 8.19
2018/08/21 DOTA
Python程序中使用SQLAlchemy时出现乱码的解决方案
2015/04/24 Python
详解Python函数作用域的LEGB顺序
2016/05/14 Python
python算法演练_One Rule 算法(详解)
2017/05/17 Python
Python进阶_关于命名空间与作用域(详解)
2017/05/29 Python
python3爬取数据至mysql的方法
2018/06/26 Python
Django Form and ModelForm的区别与使用
2019/12/06 Python
用Python自动清理系统垃圾的实现
2021/01/18 Python
Python .py生成.pyd文件并打包.exe 的注意事项说明
2021/03/04 Python
英国玛莎百货美国官网:Marks & Spencer美国
2018/11/06 全球购物
戴森比利时官方网站:Dyson BE
2020/10/03 全球购物
杭州龙健科技笔试题.net部分笔试题
2016/01/24 面试题
Can a struct inherit from another class? (结构体能继承类吗)
2014/07/22 面试题
餐厅筹备计划书
2014/04/25 职场文书
幼儿体育课教学反思
2016/02/16 职场文书
高三物理教学反思
2016/02/20 职场文书
2016年第二十五次全国助残日活动总结
2016/04/01 职场文书
SQL实现LeetCode(176.第二高薪水)
2021/08/04 MySQL
Spring boot admin 服务监控利器详解
2022/08/05 Java/Android