详解Python中的相对导入和绝对导入


Posted in Python onJanuary 06, 2017

前言

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

Python import 的搜索路径

  1. 在当前目录下搜索该模块
  2. 在环境变量 PYTHONPATH 中指定的路径列表中依次搜索
  3. 在 Python 安装路径的 lib 库中搜索

Python import 的步骤

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

  1. 如果是 import A,检查 sys.modules 中是否已经有 A,如果有则不加载,如果没有则为 A 创建 module 对象,并加载 A
  2. 如果是 from A import B,先为 A 创建 module 对象,再解析A,从中寻找B并填充到 A 的 __dict__

相对导入与绝对导入

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

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

ValueError: Attempted relative import in non-package

这是什么原因呢?我们需要先来了解下导入模块时的一些规则:

在没有明确指定包结构的情况下,Python 是根据 __name__ 来决定一个模块在包中的结构的,如果是 __main__ 则它本身是顶层模块,没有包结构,如果是A.B.C 结构,那么顶层模块是 A。基本上遵循这样的原则:

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

如果一个模块被直接运行,则它自己为顶层模块,不存在层次结构,所以找不到其他的相对路径。

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

from __future__ import absolute_import

from __future__ import absolute_import

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

那么到底什么是隐式相对导入,什么又是显示的相对导入呢?我们来看一个例子,假设有如下包结构:

thing
├── books
│ ├── adventure.py
│ ├── history.py
│ ├── horror.py
│ ├── __init__.py
│ └── lovestory.py
├── furniture
│ ├── armchair.py
│ ├── bench.py
│ ├── __init__.py
│ ├── screen.py
│ └── stool.py
└── __init__.py

那么如果在 stool 中引用 bench,则有如下几种方式:

import bench     # 此为 implicit relative import
from . import bench   # 此为 explicit relative import
from furniture import bench # 此为 absolute import

隐式相对就是没有告诉解释器相对于谁,但默认相对与当前模块;而显示相对则明确告诉解释器相对于谁来导入。以上导入方式的第三种,才是官方推荐的,第一种是官方强烈不推荐的,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 文件都是一个独立的、可以直接被其他模块导入的模块,就像你导入标准库一样,它们不存在相对导入和绝对导入的问题。相对导入与绝对导入仅用于包内部。

总结

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

Python 相关文章推荐
python实现的jpg格式图片修复代码
Apr 21 Python
利用Fn.py库在Python中进行函数式编程
Apr 22 Python
在GitHub Pages上使用Pelican搭建博客的教程
Apr 25 Python
Python 使用os.remove删除文件夹时报错的解决方法
Jan 13 Python
python字符串过滤性能比较5种方法
Jun 22 Python
virtualenv 指定 python 解释器的版本方法
Oct 25 Python
Python装饰器语法糖
Jan 02 Python
Django实现基于类的分页功能
Oct 31 Python
使用OpenCV-python3实现滑动条更新图像的Canny边缘检测功能
Dec 12 Python
详解从Django Allauth中进行登录改造小结
Dec 18 Python
Python如何使用内置库matplotlib绘制折线图
Feb 24 Python
Python3.7在anaconda里面使用IDLE编译器的步骤详解
Apr 29 Python
Python中取整的几种方法小结
Jan 06 #Python
Python正则表达式实现截取成对括号的方法
Jan 06 #Python
关于Python元祖,列表,字典,集合的比较
Jan 06 #Python
Python线程指南详细介绍
Jan 05 #Python
Python爬虫代理IP池实现方法
Jan 05 #Python
在 Python 应用中使用 MongoDB的方法
Jan 05 #Python
深入理解python对json的操作总结
Jan 05 #Python
You might like
php中操作memcached缓存进行增删改查数据的实现代码
2014/08/15 PHP
PHP中通过trigger_error触发PHP错误示例
2015/06/23 PHP
编写跨浏览器的javascript代码必备[js多浏览器兼容写法]
2008/10/29 Javascript
javascript 关闭IE6、IE7
2009/06/01 Javascript
JSON 编辑器实现代码
2009/12/06 Javascript
jquery的Tooltip插件 qtip使用详细说明
2010/09/08 Javascript
基于jQuery的实现简单的分页控件
2010/10/10 Javascript
理解Javascript_15_作用域分配与变量访问规则,再送个闭包
2010/10/20 Javascript
给页面渲染时间加速 干掉Dom Level 0 Event
2012/12/19 Javascript
JavaScript表达式:URL 协议介绍
2013/03/10 Javascript
js的[defer]和[async]属性
2014/11/24 Javascript
node.js中的emitter.on方法使用说明
2014/12/10 Javascript
js判断手机号是否正确并返回的实现代码
2017/01/17 Javascript
element-ui 中的table的列隐藏问题解决
2018/08/24 Javascript
纯javascript前端实现base64图片下载(兼容IE10+)
2018/09/14 Javascript
webpack4实现不同的导出类型
2019/04/09 Javascript
layui表格内放置图片,并点击放大的实例
2019/09/10 Javascript
vue-cli3使用mock数据的方法分析
2020/03/16 Javascript
jQuery HTML设置内容和属性操作实例分析
2020/05/20 jQuery
Vue移动端项目实现使用手机预览调试操作
2020/07/18 Javascript
JS运算符优先级与表达式示例详解
2020/09/04 Javascript
[01:37]全新的一集《真视界》——TI7总决赛
2017/09/21 DOTA
Python3一行代码实现图片文字识别的示例
2018/01/15 Python
Python 中的Selenium异常处理实例代码
2018/05/03 Python
简单了解Python读取大文件代码实例
2019/12/18 Python
Python图像处理库PIL的ImageFilter模块使用介绍
2020/02/26 Python
python关于变量名的基础知识点
2020/03/03 Python
django-csrf使用和禁用方式
2020/03/13 Python
使paramiko库执行命令时在给定的时间强制退出功能的实现
2021/03/03 Python
英国二手iPhone、音乐、电影和游戏商店:musicMagpie
2018/10/26 全球购物
法国亚马逊官方网站:Amazon.fr
2020/12/19 全球购物
自荐信怎么写呢?
2013/12/09 职场文书
安全生产责任书
2014/03/12 职场文书
校园活动宣传方案
2014/03/28 职场文书
社会治安综合治理管理责任书
2014/04/16 职场文书
mysql序号rownum行号实现方式
2022/12/24 MySQL