引言
上一篇文章中,只是简单介绍了模块化思想的好处,以及简单演示了一下模块的使用。其实,在简单的项目中,我们不需要太在意“模块”这个概念,就是独立的Python文件,Python的内置模块也是同样。
但是,当涉及到团队协作、模块复用时,可能还是需要稍微深入了解一下模块的相关内容的。所以,这篇文章开始,我们就模块相关的细节做一些必要的补充说明。
本文的主要内容大概有:
1、模块导入的常用形式
2、模块的查找路径
3、模块的绝对定位与相对定位
模块导入的常用形式
模块导入的语法,其实属于一个应用型的语法,其实大部分人没有专门学过这块,但基本都能满足日常的使用。以下简单介绍下模块导入的各种方法,根据实际使用场景,可以自行选择。
1、import 模块名
此时,要使用模块中的变量、函数等,都需要以模块名为前缀进行访问。
import math
# 使用模块中定义的变量
print(math.pi)
print(math.e)
# 使用模块中定义的函数
print(math.ceil(2.5))
print(math.floor(2.5))
执行结果:
2、import 模块名 as 别名
有时,模块名比较长,访问所有的变量、函数都要加模块名作为前缀比较玛法,所以,可以使用别名来简化模块中功能的访问。需要注意的是,此时,只能使用别名作为前缀,而不能再使用原模块名进行访问了。
比较常见的numpy、pandas模块的导入:
import numpy as np
import pandas as pd
print(np.array([1, 2, 3]))
df = pd.read_csv('./data.csv')
print(df)
执行结果:
3、from 模块名 import 功能名
有时候模块中的功能比较多,而我们实际上只需要使用其中某一个特定的功能,或者某几个特定的功能,多个功能以半角逗号分隔。比如,前面我们使用PyQt6/PySide6进行GUI程序的开发时。这种方式的好处是无需在使用模块名作为前缀了。
from PySide6.QtGui import QAction, QIcon, QPixmap
from PySide6.QtCore import Qt, QTimer
from PySide6.QtWidgets import QWidget, QLabel, QMenu, QApplication, QSystemTrayIcon
当然,这种方式,也是可以给功能名取别名的:
from 模块名 import 功能名 as 别名
4、from 模块名 import *
使用*表示导入模块的“所有功能”,不使用模块名作为前缀。
比如,我们将PySide几个模块中的功能都导入进来:
from PySide6.QtGui import *
from PySide6.QtCore import *
from PySide6.QtWidgets import *
当然,这种导入的方式属于比较偷懒的做法,不建议轻易使用。因为如果是一个不小心可能会导致全局命名空间会被污染(内置功能与三方模块的功能重名导致),可能导致出现不可预料的行为结果。
而且,模块的功能比较多的话,也会导致全局命名空间的字典会变得过大。
需要注意的是,上面提到的*表示导入“所有功能”,并不完全准确,所以加了引号。使用*的方式导入模块时,如果模块文件中定义了__all__变量,改变量是一个列表,可以用于控制*方式导入的范围。
5、import 包名.模块名
当有包对模块进行组织时,使用这种方式进行模块的导入,但是,模块中的任何功能都需要使用“包名.模块名”作为前缀。
也可以如同单纯的模块导入一样,又如下改写方式:
import 包名.模块名 as 别名
from 包名 import 模块名
from 包名 import 模块名 as 别名
from 包名.模块名 import 功能
from 包名.模块名 import 功能 as 别名
模块的查找路径
Python解释器要进行模块的导入、加载,一个前提条件是,必须能找到对应的模块。Python解释器默认会按照如下路径查找顺序进行模块的查找,找到则直接加载,最终都没有找到则会抛异常:ModuleNotFoundError: No module named xxx。
查找顺序:
1、当前目录:首先会从当前执行脚本所在的目录开始查找。
2、环境变量PYTHONPATH:如果设置了改变量,则会查找该变量中存储的路径,多个以相应操作系统的分割符进行查找。
3、标准库目录:Python自身的标准库的目录。
4、安装的第三方库目录:如通过pip安装的库通常会在site-packages目录中。
5、*.pth文件:一些三方库或者我们自定义的公共模块,可以将路径存储在某个*.pth文件,并放置在上述的某个目录中。这些文件中存储的路径也会参与到模块的查找解析的路径中。
所有的模块查找路径,都会存储在sys.path这个列表中,比如,笔者Mac上的默认查找路径是:
import sys
for pth in sys.path:
print(pth)
执行结果:
需要说明的是,如果是在PyCharm中执行代码,如果项目的根目录与当前目录不是同一个路径的话,PyCharm会在当前目录之后,把项目的根目录也追加到sys.path中,作为模块的查找路径之一。
其中warehouse-tools.pth文件,我放置在了site-packages路径中:
此外,如同标准库路径中出现了python311.zip这种压缩文件的形式,我们也可以把几个模块放到一个压缩文件中,同时,通过在sys.path中追加查找路径来动态添加查找模块的路径。
比如,有两个模块:
module_1.py:
a = 10
b = 20
module_2.py:
def my_add(a, b):
return a + b
然后将这两个模块放到一个my_modules.zip中,尝试导入模块并引用:
import sys
sys.path.append('./my_modules.zip')
from module_1 import a, b
from module_2 import my_add
print(a)
print(b)
print(my_add(a, b))
执行结果:
模块的绝对定位与相对定位
在Python中有两种方式进行导入模块的定位,即:绝对定位和相对定位。
首先说明一下,通常来说,应该尽量使用“绝对定位”。
下面,简单介绍一下顶级包、绝对定位、相对定位的概念。
1、顶级包:是指与入口文件同级的包(即文件夹)。
2、绝对定位:导入的模块路径,是从顶级包开始一路定位到要导入的模块。
3、相对定位:以要导入的模块相对于当前模块的相对位置来进行模块的定位,其中.表示当前目录,..表示上级目录,以此类推。
需要注意的是,虽然Python中支持相对定位,但是,为了避免导入冲突,以及代码的可读性,应当尽量使用绝对导入。
总结
本文首先列举了常用的模块导入的方式,其次,讲解了关于模块导入的前置条件——模块的查找路径,以及sys.path的读取与动态更新。最后,简单介绍了一下相对定位与绝对定位的概念,建议尽量使用绝对定位,从而降低冲突的风险并提高代码的可读性。
感谢您的拨冗阅读,如果对您学习Python有所帮助,欢迎点赞、关注。