专栏首页中科院渣渣博肆僧一枚Python的绝对导入和相对导入

Python的绝对导入和相对导入

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

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 和文件名用 . 连接起来。

例如,moduleX 被 import 进来,它的名字就是 package.subpackage1.moduleX。如果 import 了 moduleA,它的名字是 package.moduleA。如果直接运行 moduleX 或 moduleA,那么名字就都是__main__ 了。

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

from future import absolute_import

Python2.x 缺省为相对路径导入,Python3.x 缺省为绝对路径导入。绝对导入可以避免导入子包覆盖掉标准库模块(由于名字相同,发生冲突)。如果在 Python2.x 中要默认使用绝对导入,可以在文件开头加入如下语句:

from __future__ import absolute_import

这句 import 并不是指将所有的导入视为绝对导入,而是指禁用 implicit relative import(隐式相对导入), 但并不会禁掉 explicit relative import(显示相对导入)。

那么到底什么是隐式相对导入,什么又是显示的相对导入呢? 上面的moduleX.py,三种的import moduleY都是可以的

import moduleY # 隐式相对引入
from . import moduleY # 显式相对引入
from sub_pkg1 import moduleY # 绝对引入

隐式相对就是没有告诉解释器相对于谁,但默认相对与当前模块;而显示相对则明确告诉解释器相对于谁来导入。以上导入方式的第三种,才是官方推荐的,第一种是官方强烈不推荐的,Python3 中已经被废弃,这种方式只能用于导入 path 中的模块。

相对与绝对仅针对包内导入而言

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

相对导入可以避免硬编码,对于包的维护是友好的。绝对导入可以避免与标准库命名的冲突,实际上也不推荐自定义模块与标准库命令相同。

前面提到含有相对导入的模块不能被直接运行,实际上含有绝对导入的模块也不能被直接运行,会出现 ImportError:

ImportError: No module named XXX

这与绝对导入时是一样的原因。要运行包中包含绝对导入和相对导入的模块,可以用 python -m A.B.C 告诉解释器模块的层次结构。

有人可能会问:假如有两个模块 a.py 和 b.py 放在同一个目录下,为什么能在 b.py 中 import a 呢?

这是因为这两个文件所在的目录不是一个包,那么每一个 python 文件都是一个独立的、可以直接被其他模块导入的模块,就像你导入标准库一样,它们不存在相对导入和绝对导入的问题。相对导入与绝对导入仅用于包内部。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • #000 Python 入门第一题通过扩展,学到了更多的知识

    创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

    韩旭051
  • PHP函数之日期时间函数date()详解

    format 必需。规定时间戳的格式。 timestamp 可选。规定时间戳。默认是当前的日期和时间。

    乄浪漫经典
  • 【PAT甲级】Linked List Sorting

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 ...

    喜欢ctrl的cxk
  • async/await 原理及执行顺序分析

    之前写了篇文章《这一次,彻底理解Promise原理》,剖析了Promise的相关原理。我们都知道,Promise解决了回调地狱的问题,但是如果遇到复杂的业务,代...

    桃翁
  • 【PAT乙级】Wifi密码

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 ...

    喜欢ctrl的cxk
  • Python“爬”房,带你看最真实的房价!

    人人都说买房难买房难,付完首付付月供,小N身边也有不少朋友在为这个问题烦恼。 A在深圳 ? 姓名:小宇 年龄:25岁 买房难题:工资只有4500,买了房=...

    腾讯NEXT学位
  • 数据分析最有用的 Top 50 Matplotlib 图(附完整的Python代码)(上)

    50个Matplotlib图的汇编,在数据分析和可视化中最有用。此列表允许您使用Python的Matplotlib和Seaborn库选择要显示的可视化对象。

    小草AI
  • Python实现五子棋人机对战

    五子棋是常见的一款小游戏,五子棋问题是人工智能中的一个经典问题。这篇文章主要介绍了python版本五子棋的实现代码,大家可以做个参考,与我的傻儿子对弈一下。

    数据森麟
  • 中文编程为什么没有发展起来?

    我是雪易网的开发者玩蛇的胖纸,当你看到这封信的时候,我想我已经离开易语言界很久了。

    玩蛇的胖纸
  • 【PAT甲级】Sign In and Sign Out

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 ...

    喜欢ctrl的cxk

扫码关注云+社区

领取腾讯云代金券