python历险记之模块导入

最近在学习用 python3 写测试用例，在导入包和模块中踩到了坑。在网上找资料，发现不太全面，有些还有错漏。于是决定自己总结，希望也能给遇到问题的小伙伴们带来帮助。 注：使用python版本为3.7。

在任何语言中，依赖管理都是最基础的。在 python 中也不例外。这里我们要从模块和包说起。

模块和包

• 模块 .py 为后缀的文件视为一个模块。模块可以在其他 python 文件中被导入和使用。
• 包 包含多个模块的文件夹，导入该包即导入该包内的模块。必须有 __init__.py文件。
  • __init__.py 文件：导入某个包时，会首先执行__init__.py 文件，因此可以在里面先行导入需要用到的模块或者模块内的定义、方法。

python 如何找到导入的模块

python会按顺序来查找导入的模块：从sys.modules 查找 -> 查找器查找。

• sys.modules：缓存了之前导入的所有模块。
• 查找器：默认有3个，按照内置模块（python官方模块等）-> 冻结模块-> import path（来自 sys.path，包括当前模块所在目录，以及自行加入的目录等）的路径查找。

如何导入模块

• 导入语法
  • import xxx：直接导入，xxx 为包/模块。
  • from xxx import yyy：从 xxx 中导入 yyy。xxx 为包/模块，yyy 可以为子包、模块、模块内的内容（类、方法）等。这种方式结合__init__.py，可以让包和模块导入更简单，便于管理。
• 导入方式
  • 相对路径 使用 . 或者 .. 的方式来包含指定导入模块。. 代表当前包所在目录，.. 为上级目录。只能使用 from xxx import xxx 的方式导入。因为 .moduleY 不是一个有效表达式。
  • 绝对路径 使用 xxx.yyy.zzz 导入。以当前包目录为顶层目录。

实例说明

• 项目结构 my_project 为项目文件夹，下图为 my_project 的结构：

• my_project：包含 module_one 模块，package_a、package_b 子包。
• package_a：包含 a_module_one、a_module_two 模块，a_inner_package 子包。
• package_b：包含 b_module_one 模块。

每个模块中都会有一个方法，打印 “i am xxx_method”，来明确显示我们的模块导入和调用是成功的。

使用 import xxx 方式

• 示例一 在 a_module_one.py 中引入上级、同级、下级包中模块。

# my_project/package_a/a_module_one.py 

import sys

sys.path.append("..")
import module_one # 引入上级包中的模块
import a_module_two # 引入同级包中的模块
import a_inner_package.a_inner_module # 引入下级包中的模块

module_one.module_one_method() # 结果：i am module_one_method
a_module_two.a_module_two_method() # 结果：i am a_module_two_method
a_inner_package.a_inner_module.a_inner_package_method() # 结果：i am a_inner_package_method

注意，引入上级包中模块需要将 .. 加入 sys.path 中，否则会找不到，因为python仅会从当前包的目录开始查找。

使用 from xxx import yyy 方式

• 示例二：在包的__init__.py 中 import 进需要的包内含有的子包和模块

# my_project/package_a/__init__.py

from .a_module_two import a_module_two_method # 导入当前包的模块的方法
from package_a.a_inner_package import a_inner_module # 导入子包中的模块

• 示例三：在模块中引用包，使用其模块和方法

# my_project/module_one.py
# 引入 my_project/package_a 包
from package_a import a_inner_module
from package_a import a_module_two_method

a_module_two_method() # 结果：i am a_module_two_method
a_inner_module.a_inner_package_method() # 结果：i am a_inner_package_method

总结和注意事项

• 推荐使用包对模块进行管理。
• 推荐使用 from xxx imoprt yyy 的方式来引入。结合__init__.py文件，引入包时，可以控制引入粒度，不需要引入无用的子包和模块。
• from xxx import yyy 方式说明 若在包 package_a 的 __init__.py 文件中引入了其下具体的类、函数，则在引用 pakcage_a 的包中可以直接引用；若没有，则 xxx 的粒度为包，yyy 必须为子包或直接模块。即yyy必须是能在下能直接找到的。例如：from package_a imoprt a_module_method 是错误的。（可参考示例三）

踩坑记录

• 坑一
  • 现象：执行 my_project/package_a/__init__.py 文件（文件内容参考示例二）报错： ModuleNotFoundError: No module named 'main.a_module_two'; 'main' is not a package
  • 原因：当前模块为 __init__.py。在当前模块执行时，.代表的是__name__变量；在被其他模块导入和执行时，. 表示原模块的文件名。因此在用 . 相对路径引入的时候，直接执行会报错。
• 坑二
  • 引用上级包中的模块，例如：from .. import module_xx。报错：ValueError: attempted relative import beyond top-level package
  • 原因：当前所在包目录为顶层目录，python 会从该目录开始查找被引入的包和模块，因此它无法识别当前层级以上的包和模块。需要引入，要用sys.path.append加入路径。

参考文档

• python3.7官方文档：docs.python.org/zh-cn/3.7/r…