python模块搜索路径和包导入
- 0. 查看模块实际搜索路径
- 一、模块搜索路径
- 二、包导入
- 三、__init__.py
Python把目录称作包,py文件称作模块,在导入自定义的模块时,除了指定模块名之外,也需要指定目录,这类导入被称为 包导入。包导入 把计算机上的目录变成Python的命名空间, 目录中所包含的子目录和模块文件则对应命名空间中的属性。
0. 查看模块实际搜索路径
import sys
print(sys.path)
sys.path是模块搜索的路径,Python在程序启动时进行配置,自动把顶层文件的主目录,PYTHONPATH环境变量中配置的目录,.pth文件中目录以及标准连接库目录加载到sys.path列表中,每次导入一个新的模块,都是从sys.path列表中查找搜索目录。
一、模块搜索路径
-
程序的主目录
主目录是指包含程序的顶层脚本的目录,Python首先会到主目录中搜索模块。 -
PATHONPATH目录
PATHONPATH环境变量中配置的目录是第二个被搜索的目录,Python会从左到右搜索PATHONPATH环境变量中设置的所有目录。 -
标准链接库目录
标准链接库目录是Python按照标准模块的目录,是在安装Python时自动创建的目录,通常不需要添加到PYTHONPATH目录中。 -
路径文件(.pth文件)
在模块搜索目录中创建路径文件,后缀名为.pth。Python会读取路径文件中的内容,每行都作为一个有效的目录,加载到模块搜索路径列表中。可以放在按安装Python的顶层目录或标准库所在位置的sitepackages子目录中。
二、包导入
搜索路径是指Python搜索模块的路径前缀,在import 语句的路径上添加这些路径,以构成模块的绝对路径。通常把存储模块的根目录称作容器目录,记作dir0,容器目录dir0必须包含在搜索路径中。
例如,在dir0目录下,存在dri1/dir2/mod.py模块,那么导入该模块需要设置搜索路径为dir0,并使用import和路径导入该模块:
import dir1.dir2.mod
from dir1.dir2.mod import mod_fun
三、init.py
包导入语句的路径中,每个目录内都必须有__init__.py文件,否则包导入失败。
必须遵守以下规则:
- dir0是容器目录,不需要__init__.py文件,如果有,也会被忽略
- dir0必须列在模块搜索路径列表中
- dir1和dir2都必须包含一个__init__.py文件
__init__.py文件可以为空,或具备一下功能:
-
包的初始化
Python在首先导入某个目录时,会自动执行该目录下的__init__.py文件中的所有程序代码。 -
模块命名空间的初始化
在包导入模型中,脚本内的目录路径,在导入后会变成真实的对象路径,为目录创建的模块对象提供了命名空间。 -
from xx语句的行为
在__init__.py文件内使用__all__列表,来定义目录以from * 语句形式导入时,需要导出的属性清单。