python - 模块使用详解

前言

Python有非常强大的第三方库，也有非常多的内置模块帮助开发人员实现某些功能，无需开发人员自己造轮子。本文介绍Python的模块。

什么是模块

模块简单来说就是一系列功能的集合体，如果将程序的开发比喻成拼图，模块就是各种各样的拼图的碎片，准备好拼图碎片后，剩下的工作就是将需要的碎片按照顺序拼起来。

在Python中，一个py文件就是一个模块，Python中的模块分为三种，分别是：

1. 内置模块 - Python解释器自带
2. 第三方模块 - 需要手动安装
3. 自定义模块 - 比如一个python文件

为啥要使用模块

自定义模块：可以将程序中的公用功能抽取出来放到一个模块中供大家使用，减少了代码冗余的前提下还能够使程序组织结构更加清晰。

内置模块和第三方模块：安装后直接使用模块的相关功能，无需自己造轮子，可以极大的提升开发效率。

自定义模块

自定义模块也是py文件，可以作为普通的python脚本执行，也可以作为模块来使用。比如新建一个test.py，该文件既是脚本程序也是一个模块，test就是模块名。

# test.py
x = 100
print(x)
def get():
    print(x)
    
def change():
    global x
    x = 0

自定义模块的使用

import语句

想要在其他文件中引用test.py中的数据和函数，可以使用import 模块名 进行模块导入，其他文件首次导入模块的时候会分为三步：

首先，执行模块文件中的代码；

然后，产生一个新的名称空间用来存放执行模块文件过程中产生的名字；

最后，在当前执行文件所在的名称空间中产生一个名字就是导入的模块名，该名字会指向模块执行时产生的名称空间，如果想要引用模块名称空间的名字，需要加上前缀用来区分当前文件的名称空间与模块的名称空间，防止名字的混淆。

具体代码如下：

import test  # import的语法是：import 模块名
# 引用test模块中的x，赋值给a变量
a = test.x
print(a)  # 1

# 调用test模块中的change函数
test.change()

加上test.作为前缀就相当于指名道姓的说明要引用test名称空间中的名字，所以肯定不会与当前执行文件所在名称空间中的名字相冲突，并且若当前执行文件的名称空间中存在x，执行test.change()操作的都是模块文件中的全局变量x。

需要注意的是，在导入模块时只有第一次导入时会执行模块中的代码将其加载到内存空间，之后重复的导入直接引用内存中已存在的模块，不会重复执行。

使用import导入多个模块时可以书写多行import语句。

import module1
import module2
...

也可以通过import一行导入，将不同模块用逗号隔开。

import module1, module2....

虽然两种格式都可以，但是前一种形式更加规范，推荐使用。在一个py文件中可能会包含多种模块，内置模块、第三方模块、自定义模块，为了增加代码可读性以及更好的符合PEP8规范(python开发中编写代码的规范)通常在文件开头导入模块，并且将三种不同模块中间用空行隔开。

import python内置模块
import python内置模块

import 第三方模块
import 第三方模块

import 自定义模块
import 自定义模块

from...import语句

from 模块名 import 名字，也可以实现导入模块，不同的是import 模块名 导入模块后，引用模块中的名字都需要加上模块名.作为前缀，而使用from 模块名 import 名字则可以在当前执行文件中直接引用模块中的名字，如下:

from test import x, change  # 将模块test名称空间中的x和change导入到当前名称空间

b = x  # 将模块test中的x赋值给b
change()  # 执行test模块中的change方法，修改的是模块中的x变量

这种方式在引用其他自定义模块的名字时不需要加模块名的前缀，使代码更加整洁，但是缺点也很明显，就是容易和当前py文件的名称空间中的名字冲突。

另外此种导入模块的方式也支持如下写法，表示将模块中所有的名字都导入到当前位置。

from 模块名 import *

使用此种导入模块的方式导入模块也会发生三件事：

首先，运行模块中的代码；

然后，运行模块文件将运行过程中产生的名字都放到模块的名称空间；

最后，被当前文件引用的模块中的名字也会导入到当前文件的名称空间，这些名字分别指向被导入的模块名称空间中的某一个内存地址。

两种导入方式对比

优缺点	import 模块名	from 模块名 import 名字
优点	肯定不会与当前名称空间的名字冲突	不加前缀，代码更精简
缺点	加前缀显得代码不简洁	容易与当前名称空间的名字混淆

其他语法 - as

可以为导入的模块起一个别名，例如：

import test as t

print(t.x)
t.change()

也可以为导入的名字起别名，例如:

from test import change as change_x

change_x()

当被导入的名字过长时就可以使用起别名的方式来精简代码，而且起别名可以很好地避免与当前文件的名称空间中的名字发生冲突。

循环导入

循环导入的问题指的是在一个模块加载/导入的过程中导入另外一个模块，而另一个模块中又返回来导入第一个模块中的名字，由于第一个模块尚未加载完毕，所以引用失败，抛出异常。以下述文件为例分析循环导入出现的异常的原因及解决方案。

 如果直接运行module1.py或者module2.py同样也会报错，报错的原因都是由于循环导入。解决循环导入问题有以下两种方案：

第一种，将导入语句放到代码最后，保证在导入的时候，模块中的所有名字都已经加载到名称空间中。

第二种，将导入语句放到函数中，只有调用函数时才会执行其内部代码。

这里需要补充一点，理论上来讲，在函数内导入模块，这个模块是在局部名称空间的，当函数调用结束之后模块对应的名称空间应该被回收，但是当函数调用结束之后，再次导入模块，模块文件却不会运行。如下述代码：

def test():
    import foo  # 在函数内导入模块
test()

import foo  # 执行函数后，再次导入，发现已经不会运行模块文件了，说明不是第一次导入

print(sys.modules)  # 查看加载到内存中的模块

产生这种现象的原因：python解释器内部优化机制，默认导入的模块在执行文件中会被大量使用，所以即便是在局部名称空间中也不会被回收。

循环导入问题大多数情况下都是因为程序设计失误导致的，上述方案也只是在设计失误额前提下的无奈之举，在设计程序的时候应尽可能避免出现循环导入的问题。

查找模块路径及优先级

无论是import 还是from...import...导入模块都涉及到查找模块路径的问题，模块查找顺序按照如下规则进行：

首先，在内存中查找，在导入一个模块时，如果该模块已经加载到内存中，就直接引用。可以通过导入sys模块(import sys)，打印sys.modules查看已经加载到内存中的模块名称。

然后，如果内存中没有，再去查找内置模块。

最后，如果内置模块中没有，就按照从左到右的顺序依次检索sys.path(称为模块的搜索路径，是一个列表)中的路径，直到找到模块对应的文件，否则抛出异常。

通过下面的例子，来说明模块查找的优先级：创建一个test.py文件作为模块，创建一个run.py文件作为执行文件。

在执行文件休息10s的时间内，快速将模块文件foo.py删除，10s结束后再次调用foo.py中的foo函数，如果能够调用成功，那么就说明是在内存中导入的foo文件。经过验证，10s后的foo函数可以被调用，但是如果重新运行执行文件就会报错，提示没有foo模块。

# test.py
def test():
    print('我是test')
print('test')

# run.py
import time
from test import test

test()
time.sleep(10)
test()  

如果内存中没有找到模块，也不属于内置模块，就按照从左到右的顺序依次检索sys.path列表中路径下的文件。需要注意的是，sys.path在pycharm和python解释器中得到的结果不同，使用pycharm查看sys.path时会将当前项目路径自动加入到sys.path列表中。

# pycharm运行结果
import sys
print(sys.path)

['F:\\FullStack\\Python_based', 'F:\\FullStack\\Python_based', 'E:\\python3.9\\python39.zip', 'E:\\python3.9\\DLLs', 'E:\\python3.9\\lib', 'E:\\python3.9', 'E:\\python3.9\\lib\\site-packages']


# python解释器运行结果
>>> import sys
>>> sys.path

['', 'E:\\python3.9\\python39.zip', 'E:\\python3.9\\DLLs', 'E:\\python3.9\\lib', 'E:\\python3.9', 'E:\\python3.9\\lib\\site-packages']

使用python解释器得到的sys.path的结果第一个元素通常为空，代表执行文件所在的路径，所以在被导入模块与执行文件在同一目录下时肯定是可以正常导入的，而针对被导入的模块与执行文件在不同路径下的情况，为了确保模块对应的源文件仍可以被找到，需要将模块文件所在的路径添加到sys.path中，假设模块文件test.py所在的路径为D:/modules。

import sys

sys.path.append(r'D:/modules')  # 也可以使用insert方法
import test

py文件的两种用途

一个py文件有两种用途，一种是当做程序或者脚本执行，另一种是被当做模块，为了区分同一个py文件的不同用途，每个py文件都内置了__name__变量，该变量在py文件被当做脚本执行时赋值为__main__，在py文件被当做模块导入时赋值为模块名。

可以在模块文件的末尾基于__name__来测试模块功能代码，当文件被当做脚本运行时，会执行if后的代码块，当做模块导入时则不执行。

# test.py
...  # 代码
...  # 代码

if __name__ == '__main__':
    test.py被当做脚本文件执行时运行的代码