python绝对导入_绝对导入&相对导入

[toc]

Python 相对导入与绝对导入，这两个概念是相对于包内导入而言的。包内导入即是包内的模块导入包内部的模块。

Python2.x 缺省为相对路径导入，Python3.x 缺省为绝对路径导入。绝对导入可以避免导入子包覆盖掉标准库模块(由于名字相同，发生冲突)。

## Python import 的搜索路径

* 在当前目录下搜索该模块

* 在环境变量 PYTHONPATH 中指定的路径列表中依次搜索

* 在 Python 安装路径的 lib 库中搜索

## Python import 的步骤

python 所有加载的模块信息都存放在 sys.modules 结构中，当 import 一个模块时，会按如下步骤来进行

* 如果是 import A，检查 sys.modules 中是否已经有 A，如果有则不加载，如果没有则为 A 创建 module 对象，并加载 A

* 如果是 from A import B，先为 A 创建 module 对象，再解析A，从中寻找B并填充到 A 的 \_\_dict\_\_ 中

## 相对导入与绝对导入

绝对导入的格式为 import A.B 或 from A import B

相对导入格式为 from . import B 或 from ..A import B，.代表当前模块，..代表上层模块，...代表上上层模块，依次类推。

相对导入可以避免硬编码带来的维护问题，例如我们改了某一顶层包的名，那么其子包所有的导入就都不能用了。但是存在相对导入语句的模块，不能直接运行，否则会有异常：

`ValueError: Attempted relative import in non-package`

* 如果是绝对导入，一个模块只能导入自身的子模块或和它的顶层模块同级别的模块及其子模块

* 如果是相对导入，一个**模块必须有包结构**且**只能导入它的顶层模块内部的模块**

所以，**如果一个模块被直接运行，则它自己为顶层模块，不存在层次结构，所以找不到其他的相对路径**，所以如果直接运行python xx.py ，而xx.py有相对导入就会报错

### 案例：

```

package

├── __init__.py

├── sub_pkg1

│ ├── __init__.py

│ ├── moduleX.py

│ ├── moduleY.py

└── sub_pkg2

├── __init__.py

└── moduleZ.py`

```

moduleX.py

```

# import moduleY

# from sub_pkg1 import moduleY

from . import moduleY

print "X __name__", __name__

```

moduleY.py

```

print "Y __name__", __name__

```

当我们直接运行 `python sub_pkg1/moduleX.py`的时候，会报错

```

ValueError: Attempted relative import in non-package

```

当我们这样运行的时候 `python -m sub_pkg1.moduleX`， 才能正常运行

```

Y __name__ sub_pkg1.moduleY

X __name__ __main__

```

### 原理解释

简单地说，直接运行 .py 文件和 import 这个文件有很大区别。Python 解释器判断一个 py 文件属于哪个 package 时并不完全由该文件所在的文件夹决定。它还取决于这个文件是如何 load 进来的(**直接运行 or import**)。

### 有两种方式加载一个 py 文件

* 作为 top-level 脚本

作为 top-level 脚本指的是直接运行脚本，比如 python myfile.py。有且只能有一个 top-level 脚本，就是最开始执行的那个(比如 python myfile.py 中的 myfile.py)。

* 作为 module

作为 module 是指，执行 python -m myfile，或者在其它 py 文件中用 import 语句来加载，那么它就会被当作一个 module。

当一个 py 文件被加载之后，它会被赋予一个名字，保存在` __name__ `属性中。

如果是 top-level 脚本，那么名字就是` __main__`。

如果是作为 module，名字就是把它所在的 packages/subpackages 和文件名用 . 连接起来,如` package.moduleA`。

所以上面的moduleX的`__name__`是`__main__`， 因为他是直接运行的， moduleY的`__name__`是`sub_pkg1.moduleY`，因为他是被import 来使用的。

## 总结

**相对导入与绝对导入仅用于包内部,相对与绝对仅针对包内导入而言**

最后再次强调，相对导入与绝对导入仅针对于包内导入而言，要不然本文所讨论的内容就没有意义。**所谓的包，就是包含` __init__.py` 文件的目录**，该文件在包导入时会被首先执行，该文件可以为空，也可以在其中加入任意合法的 Python 代码。

相对导入可以避免硬编码，对于包的维护是友好的。绝对导入可以避免与标准库命名的冲突。