Python 学习 第十五篇：模块搜索路径和包导入

在导入自定义的模块时，除了指定模块名以外，也须要指定目录，因为Python把目录称做包，所以，这类导入被称为包导入。包导入把计算机上的目录变成Python的命名空间，而目录中所包含的子目录和模块文件则对应命名空间中的属性。

Python已经导入的模块保存在一个内置的sys.modules字典中，以便记录哪些模块已经记录了。

一，模块搜索路径

导入过程首先须要定位导入文件的位置，也就是，告诉Python到何处去找到要导入的文件，所以，须要设置模块的搜索路径。在大多数状况下，Python会自动到默认的目录下去搜索模块；若是要在默认的目录以外导入模块，就须要知道Pyhon搜索模块路径的机制。

Python搜索模块的路径是由四部分构成的：程序的主目录、PATHONPATH目录、标准连接库目录和.pth文件的目录，这四部分的路径都存储在sys.path 列表中。

1，程序的主目录

主目录是指包含程序的顶层脚本的目录，Python首先会到主目录中搜索模块。

由于主目录老是第一个被搜索，若是模块彻底处于主目录中，全部的导入都会自动完成，而不须要单独配置路径。

2，PATHONPATH目录

PATHONPATH目录是指PATHONPATH环境变量中配置的目录，是第二个被搜索的目录，Python会从左到右搜索PATHONPATH环境变量中设置的全部目录。

3，标准连接库目录

标准连接库目录是Python按照标准模块的目录，是在安装Python时自动建立的目录，一般不须要添加到PYTHONPATH目录中。

4，路径文件（.pth文件）

在模块搜索目录中，建立路径文件，后缀名为.pth，该文件每一行都是一个有效的目录。Python会读取路径文件中的内容，每行都做为一个有效的目录，加载到模块搜索路径列表中。简而言之，当路径文件存放到搜索路径中时，其做用和PYT)HONPATH环境变量的做用相同。

若是运行在Windows和Python3.0中，若是Python安装目录的顶层是C:\Python30，那么能够把自定义的路径文件 mypath.pth 放到该目录中。

也能够放到标准库所在位置的sitepackages子目录中（C:\Python30\Lib\sitepackages），来扩展模块的搜搜路径。

二，配置搜索路径 

上述四种模块搜索路径，可以配置的选项只有PYTHONPATH环境变量和路径文件。例如，在Windows平台上，建立PYTHONPATH环境变量，设置变量的值，两个目录使用分号隔开：

C:\pycode\utilities;D:\pycode\package1

也能够建立一个名为 C:\Python30\pydirs.pth的文本文件，其内容以下所示：

C:\pycode\utilities
D:\pycode\package1

三，sys.path列表

若是想看模块搜索路径在机器上的实际配置，能够经过打印内置的sys.path列表来查看，这个列表是sys模块的path属性。

import sys
print(sys.path)

其实，sys.path是模块搜索的路径，Pytho在程序启动时进行配置，自动把顶级文件的主目录，PYTHONPATH环境变量中配置的目录，.pth文件中目录以及标准链接库目录加载到sys.path列表中，Python每次导入一个新的模块，都是从sys.path列表中查找搜索目录。

四，包导入基础

搜索路径是指Python搜索模块的路径前缀，在import 语句的路径上添加这些路径，以构成模块的绝对路径。一般把存储模块的根目录称做容器目录，记做dir0，容器目录dir0必须包含在搜搜路径中。

例如，在dir0目录下，存在dri1/dir2/mod.py模块，那么导入该模块须要设置搜索路径为dir0，并使用import  和路径导入该模块：

import dir1.dir2.mod
from dir1.dir2.mod import mod_fun

在import语句中列举目录名，以点号分隔，"."路径是对应于dir0内的目录，经过这个目录能够找到mod.py模块。

五，__init__.py包文件

若是选择使用包导入，就必须多遵循一条约束：包导入语句的路径中，每一个目录内都必须有__init__.py文件，不然包导入失败。

对于目录结构 dir0/dri1/dir2/mod.py 

import dir1.dir2.mod

必须遵照如下规则：

• dir0是容器目录，不须要__init__.py文件，若是有，也会被忽略。
• dir0必须列在模块搜索路径列表中，也就是说，dir0必须是主目录，或者列在PYTHONPATH环境变量中等。
• dir1和dir2都必须包含一个__init__.py文件

__init__.py文件是当 import 第一次遍历一个包目录时所运行的文件，能够包含Python程序代码，也能够彻底是空的。一般状况下，__init__.py文件扮演了包初始化的钩子，替目录产生模块命名空间以及使用目录导入时实现from*行为的角色。

1，包的初始化

Python在首先导入某个目录时，会自动执行该目录下的__init__.py文件中的全部程序代码。

2，模块命名空间的初始化

在包导入模型中，脚本内的目录路径，在导入后会变成真实的对象路径，即，为目录建立的模块对象提供了命名空间。

3，from *语句的行为

在__init__.py文件内使用__all__列表，来定义目录以from * 语句形式导入时，须要导出的属性清单。若是没有设置__all__，from *语句不会自动加载潜逃与该目录内的子模块，也就是说，只加载该目录下的__init__.py文件中罗列在__all__列表中的变量。

 

 

 

参考文档：

python引入导入自定义模块和外部文件

Python3导入自定义模块的3种方式