python开发1. __init__.py与导包

Posted 2021-12-19 所向披靡的张大刀

@

python开发

开始拿着github上的python代码狂啃时，发现很多知道干嘛又不知道为啥这样的代码，开始疯狂补漏。💪💪💪

package 导包

用处1：导入包

比如这样的架构：

  package1/
    -- subPack1/
       -- __init__.py
       --  module_11.py
       --  module_12.py
       --  module_13.py
    --subPack2/
        --  __init__.py
        --  module_21.py
        --  module_22.py
    ……

  如果想在module_21.py中导入module_11.py的某一个class或者function时，则需要subPack1中包含__init__.py，即使__init__.py是空的也可以，否则会报错找不到module。

2. 原理

根据python的开发文档，模块导入主要有以下的步骤：
1，创建一个新空的module对象（它可能包含多个module）
2，把这个module对象插入sys.module中
3，装载module的代码（如果需要，首先必须编译）
4，执行新的module中对应的代码。
在执行第3步时，首先要找到module程序所在位置，其查找顺序如下

1.在当前路径以及当前目录指定的sys.path
2.从环境变量PYTHONPATH进行查找
3.python的安装设置相关的默认路径

  如果当前路径或者PYTHONPATH存在与标准module相同的module,则会覆盖标准module,也就是说，如果当下目录存在xml.py 那么执行import xml.py时，导入的当前目录下的module,而不是系统标准的xml。
  那现在问题来了，怎么知道去哪儿找这些模块呢，有的文件夹我想被搜索，有的文件夹不想被搜索，这里就需要__init__.py文件了，在文件夹下面有这个文件，则默认该文件夹是个package，可以被搜索到。这是__init__.py的用处之一。

用处2：简化包的导入

  比如有个python文件依赖上面的所有文件：

from package1.subPack1 import module_11
from package1.subPack1 import module_12
from package1.subPack1 import module_21
from package1.subPack2 import module_22
from package1.subPack2 import module_23

 这个例子里面文件比较少，如果模块比较大，目录比较深的话，可能自己都记不清该如何导入。这种情况下，__init__.py 就很有作用了。我们先来看看该文件是如何工作的。
  实际上，如果目录中包含了 __init__.py 时，当用 import 导入该目录时，会优先执行 __init__.py 里面的代码。

  我们在package1目录下增加一个__init__.py 文件：

  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里面print一句话print('the package1 is loaded ')，再在python下导入包

>>python
>>import package1
the package1 is loaded

控制模块导入

这样我们就可以在__init__.py里面导入需要文件包：
from package1.subPack1 import module_11
然后在python里面导入整个包：
import package1
如果要导入package1下面整个文件夹下面的包，则偷懒一点：
from package1 import *
这里引出了另外一个问题，为啥* 能导入所有的模块呢，这里涉及到一个变量__all__（这里后续补充）
综上，在了解了 __init__.py 的工作原理后，应该能理解该文件就是一个正常的python代码文件。　因此可以将初始化代码放入该文件中。