深入理解Python的包机制

╰半夏微凉° 2022-08-11 20:59 218阅读 0赞

最近在重构Python代码时，感觉代码只分割到文件有点不够用了，但以前对Python的包机制一直缺乏比较深入的理解，借此机会提升一下，彻底弄清楚Python的包机制，更好组织代码结构。后面逐渐把Python工具箱使用包组织起来。

Python中的Module是比较重要的概念。常见的情况是，事先写好一个.py文 件，在另一个文件中需要import时，将事先写好的.py文件拷贝 到当前目录，或者是在sys.path中增加事先写好的.py文件所在的目录，然后import。这样的做法，对于少数文件是可行的，但如果程序数目很多，层级很复杂，就很吃力了。

有没有办法，像Java的Package一样，将多个.py文件组织起来，以便在外部统一调用，和在内部互相调用呢？答案是有的。  
主要是用到python的包的概念，python \_\_init\_\_.py在包里起一个比较重要的作用。要弄明白这个问题，首先要知道，python在执行import语句时，到底进行了什么操作，按照python的文档，它执行了如下操作：

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

在执行第3步时，首先要找到module程序所在的位置，其原理为：

如果需要导入的module的名字是m1，则解释器必须找到m1.py，它首先在当前目录查找，然后是在环境变量PYTHONPATH中查找。 PYTHONPATH可以视为系统的PATH变量一类的东西，其中包含若干个目录。如果PYTHONPATH没有设定，或者找不到m1.py，则继续搜索 与python的安装设置相关的默认路径，在Unix下，通常是/usr/local/lib/python。  
事实上，搜索的顺序是：当前路径 （以及从当前目录指定的sys.path），然后是PYTHONPATH，然后是python的安装设置相关的默认路径。正因为存在这样的顺序，如果当前 路径或PYTHONPATH中存在与标准module同样的module，则会覆盖标准module。也就是说，如果当前目录下存在xml.py，那么执 行import xml时，导入的是当前目录下的module，而不是系统标准的xml。  
  
        了解了这些，我们就可以先构建一个package，以普通module的方式导入，就可以直接访问此package中的各个module了。  
  
      Python中的package定义很简单，其层次结构与程序所在目录的层次结构相同，这一点与Java类似，唯一不同的地方在于，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中也可以设置相应的内容，下文详细介绍。  
  
好了，现在我们在module\_11.py中定义一个函数：  
  
def funA():  
     print "funcA in module\_11"  
     return  
  
在顶层目录（也就是package1所在的目录，当然也参考上面的介绍，将package1放在解释器能够搜索到的地方）运行python:  
  
>>>from package1.subPack1.module\_11 import funcA  
>>>funcA()  
funcA in module\_11  
  
这样，我们就按照package的层次关系，正确调用了module\_11中的函数。  
  
细心的用户会发现，有时在import语句中会出现通配符\*，导入某个module中的所有元素，这是怎么实现的呢？  
答案就在\_\_init\_\_.py中。我们在subPack1的\_\_init\_\_.py文件中写  
  
\_\_all\_\_ = \['module\_13', 'module\_12'\]  
  
然后进入python  
>>>from package1.subPack1 import \*  
>>>module\_11.funcA()  
Traceback (most recent call last):  
File "", line 1, in   
ImportError: No module named module\_11  
  
也就是说，以\*导入时，package内的module是受\_\_init\_\_.py限制的。  
  
好了，最后来看看，如何在package内部互相调用。  
如果希望调用同一个package中的module，则直接import即可。也就是说，在module\_12.py中，可以直接使用  
import module\_11  
  
如果不在同一个package中，例如我们希望在module\_21.py中调用module\_11.py中的FuncA，则应该这样：  
from module\_11包名.module\_11 import funcA  
  
包机制  
\# a.py  
def add\_func(a,b):  
return a+b  
\# b.py  
from a import add\_func \# Also can be : import a  
  
print ("Import add\_func from module a")  
print ("Result of 1 plus 2 is: ")  
print (add\_func(1,2)) \# If using "import a" , then here should be "a.add\_func"  
  
module可以定义在包里面.Python定义包的方式稍微有点古怪,假设我们有一个parent文件夹,该文件夹有一个child子文件夹.child中有一个module a.py . 如何让Python知道这个文件层次结构?很简单,每个目录都放一个名为\_init\_.py 的文件.该文件内容可以为空.这个层次结构如下所示:  
parent   
\--\_\_init\_.py  
\--child  
\-- \_\_init\_.py  
\--a.py  
  
b.py  
那么Python如何找到我们定义的module?在标准包sys中,path属性记录了Python的包路径.你可以将之打印出来:  
import sys  
  
print(sys.path)  
通常我们可以将module的包路径放到环境变量PYTHONPATH中,该环境变量会自动添加到sys.path属性.另一种方便的方法是编程中直接指定我们的module路径到sys.path 中:

import sys
    import os
    sys.path.append(os.getcwd()+'\\parent\\child')
    print(sys.path)
    from a import add_func
    print (sys.path)
    print ("Import add_func from module a")
    print ("Result of 1 plus 2 is: ")
    print (add_func(1,2))

知识点:  
如何定义模块和包  
如何将模块路径添加到系统路径,以便python找到它们  
如何得到当前路径