__init__.py

Posted 2020-09-09

python中的Module是比较重要的概念。常见的情况是，事先写好一个.py文 件，在另一个文件中需要import时，将事先写好的.py文件拷贝 到当前目录，或者是在sys.path中增加事先写好的.py文件所在的目录，然后import。这样的做法，对于少数文件是可行的，但遇到程序数目多层级复杂时，就很吃力了。
是否可以将多个.py文件组织起来，以便在外部统一调用，和在内部互相调用呢？
主要是用到python的包的概念， __init__.py在包里起一个比较重要的作用。

 

首先了解python在执行import语句时，执行了如下操作：

1. 创建一个新的，空的module对象（它可能包含多个module）；
2. 把这个module对象插入sys.module中；
3. 装载module的代码（如果需要，首先必须编译）；
4. 执行新的module中对应的代码。

在执行第3步时，首先要找到module程序所在的位置，其原理为：如 果需要导入的module的名字是m1，则解释器必须找到m1.py，搜索的顺序是：当前路径 （以及从当前目录指定的sys.path），然后是PYTHONPATH，然后是python的安装设置相关的默认路径。

首先在当前目录查找，然后是在环境变量PYTHONPATH中查找。 PYTHONPATH可以视为系统的PATH变量一类的东西，其中包含若干个目录。如果PYTHONPATH没有设定，或者找不到m1.py，则继续搜索 与python的安装设置相关的默认路径，在Unix下，通常是/usr/local/lib/python。

所以如果当前目录或PYTHONPATH中下存在m1.py，那么执行import m1时，导入的是当前目录下的m1，而不是系统标准的m1(被覆盖)。

 

了解了这些，就可以先构建一个package，以普通module的方式导入，就可以直接访问此package中的各个module了。

 

Python中的package定义很简单，其层次结构与程序所在目录的层次结构相同，python中的package必须包含一个__init__.py的文件。

 

#例如组织这样一个package包
package1/
    __init__.py
    subPack1/
        __init__.py
        module_11.py
        module_12.py
        module_13.py
    subPack2/
        __init__.py
        module_21.py
        module_22.py
    ……

 

 

 

 __init__.py可以为空，只要它存在，就表明此目录应被作为一个package处理。当然，__init__.py中也可以设置相应的内容。

外部调用：

1 #在上面目录中的module_11.py里定义一个函数
2 def funA():
3     print "funcA in module_11"
4     return
5 
6 >>>from package1.subPack1.module_11 import funcA  #运行
7 >>>funcA()
8 funcA in module_11

内部互相调用：

如果希望调用同一个package中的module，则直接import即可。也就是说，在module_12.py中，可以直接使用import module_11.

如果不在同一个package中，例如我们希望在module_21.py中调用module_11.py中的FuncA，则应该这样：from package1.subPack1.module_11 import funcA.

(是否在同一个package看是否有相同__init__)