python 中 import 语句可以往当前 py 文件中导入外部模块,从而使用外部模块中的函数与类。 如果想要导入 python 内置模块和 pip install 安装的模块,可以直接使用 “import …” 的形式导入。 如果想要导入自己本地定义的模块(即跨文件夹导入),则有一些其他注意事项。
1. import 导入模块原理
在说明如何跨文件夹导入模块之前,首先应该介绍一下 import 导入的原理: import 语句导入模块时,会根据系统环境变量指示的路径,在对应文件夹中查找与 要导入的模块名 相符合的模块,若在所有路径指示的文件夹中都没有找到对应模块,则会引发 ModuleNotFoundError。
跨文件夹导入本地模块时也是同理,若想要正确导入本地模块,则需要将该模块所在文件夹路径加入当前环境变量。 使用 sys 库中 “sys.path.append(‘对应路径’)” 可以做到(具体使用示例见下文)。
2. 区分包 (package) 与模块 (module)
模块 (module) 是一个 py 文件的形式,里面可能包含多个函数、类,通常用来实现某种或某几种特定功能。
包 (package) 是一个文件夹的形式,文件夹中包含许多模块 (py文件),这些模块通常有着共同点,都是为了实现某类功能。
2.1. 包文件夹中的 __init__.py 文件
在 python3.2 及之前的版本,包中必须包含 __init__.py 文件(即使为空),在 python3.3 之后的版本,若 __init__.py 文件为空,则没有必要加入。
若在包文件夹中加入 __init__.py 文件,则可以直接使用 “from 包名 import 函数名” 的形式导入模块中的某个函数(具体使用示例见下文)。
3. 导入同级模块
可直接使用 “import 模块名” 形式进行导入。 如下图,b.py 为当前运行的 py 文件,导入 a.py 中定义的函数并运行。
4. 导入同级文件夹中的模块
可使用 “import 包名.模块名” 形式进行导入。 如下图,b.py 为当前运行的 py 文件,导入 文件夹 dir_a 中 aa.py 中定义的函数并运行。
若包中含有 “__init__.py” 文件,可直接使用 “import 模块名” 形式进行导入。 如下图,b.py 为当前运行的 py 文件,导入 文件夹 dir_b 中 aa.py 中定义的函数并运行。
5. 导入上级文件夹中的模块
导入上级文件夹中的模块,需要将所需模块所在文件夹路径加入当前环境变量。
5.1. 使用 sys.path.append 添加被导入模块路径
文件夹 dir_b 中 bb.py 为当前运行的 py 文件,想要导入 上级文件夹中 a.py 中定义的函数,因此需将 a.py 所在文件夹路径加入当前环境变量。 如下图,使用 sys 库中 “sys.path.append(‘对应路径’)” 实现。
红框中为当前 py 文件所在文件夹路径,在执行当前 py 文件时,会自动添加到环境变量中,因此可直接导入同级模块。 蓝框中为所需导入的模块所在的文件夹路径,添加到环境变量成功。
5.2. 导入上级文件夹中的模块
将所需模块所在文件夹路径加入当前环境变量后,可直接使用 “import 模块名” 形式进行导入。 如下图,文件夹 dir_b 中 bb.py 为当前运行的 py 文件,导入 上级文件夹中 a.py 中定义的函数并运行。