Python Tips: __init__.py的作用
本文内容纲要:
-1.标识该目录是一个python的模块包(modulepackage)
-2.简化模块导入操作
-2.1__init__.py是怎么工作的?
-2.2控制模块导入
-2.3偷懒的导入方法
-3.配置模块的初始化操作
我们经常在python的模块目录中会看到"__init__.py"这个文件,那么它到底有什么作用呢?
1.标识该目录是一个python的模块包(modulepackage)
如果你是使用python的相关IDE来进行开发,那么如果目录中存在该文件,该目录就会被识别为modulepackage。
2.简化模块导入操作
假设我们的模块包的目录结构如下:
.
└──mypackage
├──subpackage_1
│ ├──test11.py
│ └──test12.py
├──subpackage_2
│ ├──test21.py
│ └──test22.py
└──subpackage_3
├──test31.py
└──test32.py
如果我们使用最直接的导入方式,将整个文件拷贝到工程目录下,然后直接导入:
frommypackage.subpackage_1importtest11
frommypackage.subpackage_1importtest12
frommypackage.subpackage_2importtest21
frommypackage.subpackage_2importtest22
frommypackage.subpackage_3importtest31
frommypackage.subpackage_3importtest32
当然这个例子里面文件比较少,如果模块比较大,目录比较深的话,可能自己都记不清该如何导入。(很有可能,哪怕只想导入一个模块都要在目录中找很久)
这种情况下,__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("Youhaveimportedmypackage")
下面直接用交互模式进行import
>>>importmypackage
Youhaveimportedmypackage
很显然,__init__.py在包被导入时会被执行。
2.2控制模块导入
我们再做一个实验,在mypackage/__init__.py添加以下语句:
fromsubpackage_1importtest11
我们导入mypackage试试:
>>>importmypackage
Traceback(mostrecentcalllast):
File"<stdin>",line1,in<module>
File"/home/taopeng/Workspace/Test/mypackage/__init__.py",line2,in<module>
fromsubpackage_1importtest11
ImportError:Nomodulenamed'subpackage_1'
报错了。。。怎么回事?
原来,在我们执行import时,当前目录是不会变的(就算是执行子目录的文件),还是需要完整的包名。
frommypackage.subpackage_1importtest11
综上,我们可以在**__init__.py**指定默认需要导入的模块
2.3偷懒的导入方法
有时候我们在做导入时会偷懒,将包中的所有内容导入
frommypackageimport*
这是怎么实现的呢?**__all__**变量就是干这个工作的。
__all__关联了一个模块列表,当执行**fromxximport***时,就会导入列表中的模块。我们将__init__.py修改为。
__all__=['subpackage_1','subpackage_2']
这里没有包含subpackage_3,是为了证明**__all__**起作用了,而不是导入了所有子目录。
>>>frommypackageimport*
>>>dir()
['__builtins__','__doc__','__loader__','__name__','__package__','__spec__','subpackage_1','subpackage_2']
>>>
>>>dir(subpackage_1)
['__doc__','__loader__','__name__','__package__','__path__','__spec__']
子目录的中的模块没有导入!!!
****该例子中的导入等价于
frommypackageimportsubpackage_1,subpackage_2
因此,导入操作会继续查找subpackage_1和subpackage_2中的__init__.py并执行。(但是此时不会执行import*)
我们在subpackage_1下添加__init__.py文件:
__all__=['test11','test12']
#默认只导入test11
frommypackage.subpackage_1importtest11
再来导入试试
>>>frommypackageimport*
>>>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']
如果想要导入子包的所有模块,则需要更精确指定。
>>>frommypackage.subpackage_1import*
>>>dir()
['__builtins__','__doc__','__loader__','__name__','__package__','__spec__','test11','test12']
3.配置模块的初始化操作
在了解了__init__.py的工作原理后,应该能理解该文件就是一个正常的python代码文件。
因此可以将初始化代码放入该文件中。
本文内容总结:1.标识该目录是一个python的模块包(modulepackage),2.简化模块导入操作,2.1init.py是怎么工作的?,2.2控制模块导入,2.3偷懒的导入方法,3.配置模块的初始化操作,
原文链接:https://www.cnblogs.com/tp1226/p/8453854.html