python init文件 all___init__.py文件与__all__变量

首先，在讲__init__.py文件之前，先介绍一下module和package。module其实就是一个.py文件，中文名为模块，其内置有各种函数和类与变量等。而package就是一个包含很多subpackage或者module(.py文件)的一个包。

如下图所示

值得注意的是，一个directories 只有包含__init__.py文件才会被python识别成package。(摘自官方文档)

只有在import package时，才会执行package目录下的__init__.py文件。

若文件结构如下

mypackage

——__init__.py

——subpackage_1

——__init__.py

——test11.py

——test12.py

——subpackage_2

——__init__.py

——test21.py

——test22.py

在mypackage目录下的__init__.py写入

from mypackage.subpackage_2 import *

而在subpackage_2目录下的__init__.py写入

__all__ = ['test21']

则可以在test11文件下导入module test21.py

import mypackage

#注意，因为只import了mypackage，则不管用什么module，前面都必须加上mypackage，相当于限定了命名空间

mypackage.test21

如果test21.py文件里有定义函数say()

def say():

print "Hi"

那么也可以在test11.py里调用该函数

mypackage.test21.say()

这里__all__变量相当于一个请示表，表示在import *时允许package下的哪个subpackage或者哪个module导入。另外，如果有__all__变量的存在，则在__init__.py文件里导入哪些package或module都没效果。

再来讲mypackage下的__init__.py改为

from mypackage.subpackage_2.test21 import say

则在test11.py内可以更加简洁的调用say()函数

import mypackage

mypackage.say()

#或者

from mypackage improt say

say()

网上有人说__init__.py的好处就是可以使导入包简洁化，即在一个有很多子目录的包中，若你想用其中一个module的function，则通过__init__.py，在主程序中你只需要先import 根目录，再用根目录(最外层的包)去访问该function即可。(此时的根目录像是一个全局入口)但是我觉得这样会引起一些路劲混乱的问题，我还是比较支持用绝对路径导包。

一个验证组织__init__.py结构是否正确的方法是，对根目录使用dir()方法，如以下目录结构：

PCV

——__init__.py

——tools

——__init__.py

——graphcut.py

——imregistration.py

——imtools.py

——localdescriptors

——__init__.py

——dsift.py

——harris.py

——geometry

——camera.py

——warp.py

主程序为

import PCV

想要看看主程序中是否导入imtools这个模块，只需要dir(PCV)，看看返回的列表包不包括imtools，若包括，则说明PCV可以访问imtools,即PCV.imtools即可访问

最后要小心一点的是，

Remember, there is nothing wrong with using from package import specific_submodule! In fact, this is the recommended notation unless the importing module needs to use submodules with the same name from different packages.

即

from package.subpackage import module

//或者

from module import item(include *)

//或者

import module

是永远不会错的,而

from package import subpackage

则以subpackage重新作为全局入口，即以subpackage.来访问包或模块

而from package import *，若package中的__init__.py有__all__变量，则导入该变量中的包或模块；若__init__.py为空，则直接导入该package；若没有__all__变量，但是有import 其他对象(如package,module,function)等，则导入该对象。

追加要点

from PCV.tools import *

实际上执行了PCV目录下的__init__.py和tools目录下的__init__.py文件。

这个也挺好理解，因为想要导入tools目录下的package或者module，则必须要先导入PCV和tools这两个packages。

另外，导入过的包不会重新再执行其下的__init__.py文件，否则会造成无限循环

例如在主程序

import PCV

而在PCV目录的__init__.py

from PCV.tools import *

则只会执行一次PCV目录的__init__.py，否则会无限循环。

总结

一个folder(文件夹)只有拥有__init__.py文件，它才会python识别为包(package)

若在主程序内有命令from package import *，则该package下的__init__.py文件里的__all__变量决定能够导入package里的哪些subpackage或者module。

若主程序中有from package1 import subpackage或者import package2，则在配置完各个package的__init__.py文件后，subpackage或package2可以作为全局入口变量，要看看该变量可以访问哪些包或模块，则可以用dir(subpackage)或dir(package2)

最后，如果只是from package import module或from module import item,则以上的内容都无需考虑，即不需要考虑__init__.py文件。

参考资料: