Python import机制深度解析：语法、加载流程与相对导入陷阱

前言

前言

Python模块与包的组织形式

Python中的模块主要有两种组织形式：一种是独立的Python文件，文件名即模块名；另一种是包，即包含多个Python文件的目录。包目录下必须存在一个名为__init__.py的文件，此时目录名即为模块名。包内的Python文件可以通过“包名.文件名”的方式进行导入。

import语法详解

import语法

import语句主要包含两种形式。

第一种是直接导入整个模块。

 import Module
 import Module as xx

第二种是从模块中导入特定对象，如下级模块、类、函数或变量等。

 from Module import Name
 from Module immport Name as yy

as语法用于为导入的对象（泛指模块、类、函数等）设置别名。import语句会将对象名称引入当前文件的作用域（名字空间）。

假设存在如下目录结构。

├── A.py
└── pkg
 ├── B.py
 └── __init__.py

在当前目录下，以下导入语句均有效。

import A 
import pkg
import pkg.B
from pkg import B

为简化讨论，下文暂不举例说明as语法的具体用法。

模块加载步骤与sys.modules机制

import步骤

Python将所有已加载模块的信息存储在sys.modules数据结构中。当执行import操作时，系统按以下步骤进行：

1. 若执行import A，首先检查sys.modules中是否已存在A。若存在则直接复用，否则为A创建module对象并加载该模块。
2. 若执行from A import B，系统先为A创建module对象，然后解析A，从中查找B并将其填充到A的__dict__中。

嵌套导入与循环依赖问题

嵌套import

在导入模块时，我们常担心模块是否会被重复导入。假设存在A、B、C三个模块，A需要import B和C，而B内部又import C。此时A会触发两次对C的import：一次是A直接导入，另一次是通过B间接导入。但根据上述import步骤，第二次导入时会发现模块已加载，因此不会重复执行导入操作。

然而，以下情况却会引发报错。

#filename: A.py
from B import BB
class AA:pass

#filename: B.py
from A import AA
class BB:pass

此时无论执行A.py还是B.py，都会抛出ImportError异常。假设我们执行的是A.py，具体原因分析如下。

1. 文件A.py执行from B import BB时，系统先扫描B.py，同时在A的名字空间中为B创建module对象，并试图从B中查找BB。
2. 扫描B.py第一行执行from A import AA时，系统又会去扫描A.py。
3. 扫描A.py第一行执行from B import BB时，由于步骤1已为B创建module对象，系统会直接从B的module对象的__dict__中获取BB。此时显然BB尚未定义，因此抛出异常。

解决这种情况有两种办法。

1. 将from B import BB改为import B，或将from A import AA改为import A。
2. 将A.py或B.py中的这两行代码交换执行顺序。

总之，使用import时需注意：尽量在真正需要使用时再进行导入。

包的导入规则

包的import

当一个目录下存在__init__.py文件时，该目录即被视为Python的包。

import包与import单个文件的机制类似，我们可以这样类比：

• 导入单个文件时，文件内的类、函数、变量均可作为import的对象。
• 导入包时，包内的子包、文件，以及__init__.py中定义的类、函数、变量均可作为import的对象。

假设存在如下目录结构。

pkg
├── __init__.py
└── file.py

其中__init__.py内容如下。

argument = 0
class A:pass

在与pkg同级目录下执行以下语句均可成功。

>>> import pkg
>>> import pkg.file
>>> from pkg import file
>>> from pkg import A
>>> from pkg import argument

但以下语句是错误的。

>>> import pkg.A
>>> import pkg.argument

报错ImportError: No module named xxx，因为当我们执行import A.B时，A和B都必须是模块（文件或包）。

绝对导入与相对导入的区别

相对导入和绝对导入

绝对导入的格式为import A.B或from A import B，相对导入格式为from . import B或from ..A import B。其中.代表当前模块，..代表上层模块，...代表上上层模块，以此类推。当存在多个包时，可能需要从一个包导入另一个包的内容，这会产生绝对导入需求，而这往往也是错误高发区。以下通过具体例子说明。

目录结构如下。

app
├── __inti__.py
├── mod1
│ ├── file1.py
│ └── __init__.py
├── mod2
│ ├── file2.py
│ └── __init__.py
└── start.py

其中app/start.py内容为import mod1.file1 。

app/mod1/file1.py内容为from ..mod2 import file2。

为便于分析，我们在所有py文件（包括__init__.py）第一行加入print __file__, __name__以打印调试信息。

现在app/mod1/file1.py里用到了相对导入，我们在app/mod1下执行python file1.py或者在app下执行python mod1/file1.py都会报错ValueError: Attempted relative import in non-package。

在app下执行python -m mod1.file1或python start.py都会报错ValueError: Attempted relative import beyond toplevel package。

包结构判定与__name__的作用

具体原因稍后解释，我们先来看导入模块时的一些规则。

在未明确指定包结构的情况下，Python根据__name__来决定模块在包中的结构。若__name__为__main__，则它本身是顶层模块，无包结构；若为A.B.C结构，则顶层模块为A。

基本遵循以下原则。

1. 若是绝对导入，一个模块只能导入自身的子模块，或与它顶层模块同级别的模块及其子模块。
2. 若是相对导入，一个模块必须有包结构，且只能导入其顶层模块内部的模块。

有目录结构如下。

A
├── B1
│ ├── C1
│ │ └── file.py
│ └── C2
└── B2

其中A、B1、B2、C1、C2均为包。为简化展示，此处未列出__init__.py文件。当file.py的包结构为A.B1.C1.file（注意，这是根据__name__确定的，而非磁盘目录结构。在不同目录下执行file.py时，对应的包目录结构会有所不同）时，在file.py中可采用如下绝对导入。

import A.B1.C2
import A.B2

和如下相对导入。

from .. import C2
from ... import B2

什么情况下会让file.py的包结构为A.B1.C1.file呢？主要有以下两种情况。

1. 在A的上层目录执行python -m A.B1.C1.file，此时明确指定了包结构。
2. 在A的上层目录建立文件start.py，在start.py里有import A.B1.C1.file，然后执行python start.py。此时包结构是根据file.py的__name__变量来的。

再看前面出错的两种情况。第一种执行python file1.py和python mod1/file1.py时，此时file.py的__name__为__main__，也就是说它本身就是顶层模块，并没有包结构，所以会报错。

第二种情况，在执行python -m mod1.file1和python start.py时，前者明确告诉解释器mod1是顶层模块，后者需要导入file1。而file1.py的__name__为mod1.file1，顶层模块也为mod1。所以在file1.py中执行from ..mod2 import file2时会报错，因为mod2并不在顶层模块mod1内部。通过错误堆栈可以看出，并不是在start.py中绝对导入时报错，而是在file1.py中相对导入报的错。

解决导入错误的方案

那么如何才能正确执行呢？有两种方法：一种是在app上层目录执行python -m app.mod1.file1；另一种是改变目录结构，将所有包放在一个大包中，如下。

app
├── pkg
│ ├── __init__.py
│ ├── mod1
│ │ ├── __init__.py
│ │ └── file1.py
│ └── mod2
│ ├── __init__.py
│ └── file2.py
└── start.py

将start.py内容改成import pkg.mod1.file1，然后在app下执行python start.py。

总结

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家学习或者使用Python能带来一定的帮助。如有疑问，欢迎大家留言交流。