在程序开发过程中，遇到代码比较多时，为了便于维护和阅读，我们一般会把代码按照功能和相关性分别放到多个文件里。另外有些类或函数是用在多个项目中的，为了减少重复编码和便于集中维护，也会把这些代码单独存放到一个文件中。

Python引入了模块和包来管理更多的代码，.py文件就是一个模块 (module)，包含一到多个模块的目录则被称为包 (package)。普通目录和包目录的区别在于包目录必须包含一个文件名为__init__.py的模块，此文件可以为空，也可以包含代码，模块的名称为目录名。

模块是一组Python代码的集合，可以调用其他模块，也可以被其他模块调用。模块名要遵循Python变量命名规范，不使用中文、特殊字符，供其他模块调用的模块不要和系统内置的模块名冲突，否则会将系统自带的模块屏蔽。

在项目中导入自定义模块一般分为三种情况：程序导入同级目录下的模块，程序导入子目录下的模块，程序导入其他目录下的模块（包括导入父目录下的模块）。

导入同级目录下的模块

在上图中，weibo.py用到了标号2处的utils模块中的函数extend_date，我们可以导入整个模块，也可以导入模块的部分函数（函数名之间用逗号分隔）。两者的区别在于导入后的函数调用，前者函数名需要包含模块名，后者直接使用函数名。模块的导入和函数调用可以参考下面的实例。

导入整个模块

import utils

date = utils.extend_date('5分钟前')
print(date)     # 输出时间戳

导入模块的部分函数

from utils import extend_date

date = extend_date('5分钟前')
print(date)     # 输出时间戳

导入子目录下的模块

在上图中，weibo.py用到了标号1处的utils模块中的函数extend_date，下面以导入模块部分函数为例来说明。

from libs.utils import extend_date

date = extend_date('5分钟前')
print(date)     # 输出时间戳

在这种情况下，经大器测试，libs目录下的__init__.py文件不是必要的，不会影响utils模块的导入。

导入任意目录下的模块

Python导入包时默认是从sys.path中搜索的。导入其他目录的方法有两种：在sys.path添加模块路径和创建.pth文件。两者都是在sys.path中添加路径，区别是前者是临时添加路径下的模块，只在当前的模块中导入有效，后者是添加路径为默认路径，在任意模块都可以导入路径下的模块。大器推荐用创建.pth文件的方法，只需设置一次路径，便可以在任意模块直接导入路径下的模块。

sys.path添加模块路径

先导入sys模块，然后通过sys.path.append(path)添加模块所在目录的路径。

ListVideo.py调用标号1处的utils模块中的函数extend_date的示例如下。

import sys
sys.path.append(r'I:\work\work')
from libs.utils import extend_date

date = extend_date('5分钟前')
print(date)     # 输出时间戳

创建.pth文件

打开Python安装目录下的site-packages目录，使用pip命令安装的第三方库便存放于此，python的安装路径根据安装时的选择可能会不一样。

D:\Program\Python\Python38\Lib\site-packages

在site-packages目录下创建mylibs.pth文件，文件名可以取别的名称，文件的内容填写模块或包所在目录的路径。此文件是纯文本文件，可以填写多个路径，路径之间用回车分隔，可以用记事本、VS Code编辑器等文本编辑器打开编辑。

I:\work\work

文件创建后，Python会扫描.pth文件中填写的路径，导入目录下的模块。ListVideo.py调用标号1处的utils模块中的函数extend_date的示例如下。

from libs.utils import extend_date

date = extend_date('5分钟前')
print(date)     # 输出时间戳

__init__.py文件

Python包由__init__.py文件、模块文件和子目录组成，__init__.py文件定义了包的属性和方法。如果子目录中也有__init__.py，那么它就是这个包的子包。当我们将包作为模块导入时，实际上导入了__init__.py文件。

__init__.py文件可以是空文件，也可以写包的初始化相关代码，或者定义__all__变量。__all__变量是一个列表，列举了这个包包含的子模块名称。在使用from libs import *时，会把列表中的模块全部导入，此时必须定义__all__变量才能调用包中模块的函数，其他情况则无须定义__all__变量。__all__变量的定义如下。

__all__ = ['abc', 'utils']

ListVideo.py调用标号1处的utils模块中的函数extend_date的示例如下。注意函数前面依然需要指定模块名称。

from libs import *

date = utils.extend_date('5分钟前')
print(date)     # 输出时间戳

通常不建议用from libs import *这种形式，因为会导致代码可读性降低，并且当前模块中的名称有可能覆盖导入模块中的名称。 改进的方法是将*用当前所用到的类名或函数名称代替，多个名称之间用逗号隔开，也可以将多个名称放到元组中，以便于换行。

我是大器，正在建立自己的知识库，并将这些经验分享给你，请关注我，一起交流学习。

相关阅读：

用Python获取子目录或文件列表

Python pip包管理工具