详解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 相关文章推荐
Python3.x和Python2.x的区别介绍
Feb 12 Python
跟老齐学Python之有容乃大的list(3)
Sep 15 Python
python根据路径导入模块的方法
Sep 30 Python
python实现搜索本地文件信息写入文件的方法
Feb 22 Python
Python编程中归并排序算法的实现步骤详解
May 04 Python
Python中使用多进程来实现并行处理的方法小结
Aug 09 Python
Python实现字符串匹配算法代码示例
Dec 05 Python
解决python中用matplotlib画多幅图时出现图形部分重叠的问题
Jul 07 Python
Django 开发环境与生产环境的区分详解
Jul 26 Python
基于python的itchat库实现微信聊天机器人(推荐)
Oct 29 Python
python判断元素是否存在的实例方法
Sep 24 Python
Django生成数据库及添加用户报错解决方案
Oct 09 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
博士208HAF收音机实习报告
2021/03/02 无线电
PHP命令行脚本接收传入参数的三种方式
2014/08/20 PHP
php工具型代码之印章抠图
2018/07/18 PHP
javascript String 对象
2008/04/25 Javascript
jquery tools 系列 scrollable学习
2009/09/06 Javascript
javascript 学习笔记(onchange等)
2010/11/14 Javascript
jquer之ajaxQueue简单实现代码
2011/09/15 Javascript
jquery animate实现鼠标放上去显示离开隐藏效果
2013/07/21 Javascript
javascript计算当月剩余天数(天数计算器)示例代码
2014/01/09 Javascript
jQuery实现隔行背景色变色
2014/11/24 Javascript
JavaScript中的时间处理小结
2016/02/24 Javascript
利用jsonp跨域调用百度js实现搜索框智能提示
2016/08/24 Javascript
利用jQuery实现滑动开关按钮效果(附demo源码下载)
2017/02/07 Javascript
详解在Vue中通过自定义指令获取dom元素
2017/03/04 Javascript
完美实现js焦点轮播效果(二)(图片可滚动)
2017/03/07 Javascript
ES6新特性之解构、参数、模块和记号用法示例
2017/04/01 Javascript
使用OPENLAYERS3实现点选的方法
2020/09/24 Javascript
mui 打开新窗口的方式总结及注意事项
2017/08/20 Javascript
vue 循环加载数据并获取第一条记录的方法
2018/09/26 Javascript
vue学习笔记之slot插槽用法实例分析
2020/02/29 Javascript
浅谈es6中的元编程
2020/12/01 Javascript
数据挖掘之Apriori算法详解和Python实现代码分享
2014/11/07 Python
在Python的Django框架中用流响应生成CSV文件的教程
2015/05/02 Python
sublime text 3配置使用python操作方法
2017/06/11 Python
Python实现打印实心和空心菱形
2019/11/23 Python
python 实现方阵的对角线遍历示例
2019/11/29 Python
python如何把字符串类型list转换成list
2020/02/18 Python
Gweniss格温妮丝女包官网:英国纯手工制造潮流包包品牌
2018/02/07 全球购物
简述网络文件系统NFS,并说明其作用
2016/10/19 面试题
应届毕业生求职信
2014/05/26 职场文书
司法工作人员群众路线对照检查材料思想汇报
2014/09/30 职场文书
一年级班主任工作总结2014
2014/11/08 职场文书
当幸福来敲门观后感
2015/06/01 职场文书
2015年学校消防安全工作总结
2015/10/14 职场文书
创业方案:赚钱的烧烤店该怎样做?
2019/07/05 职场文书
vue项目打包后路由错误的解决方法
2022/04/13 Vue.js