解析Python3中的Import


Posted in Python onOctober 13, 2019

Python import的搜索路径

import的搜索路径为:

  • 搜索「内置模块」(built-in module)
  • 搜索 sys.path 中的路径
  • 而sys.path在初始化时,又会按照顺序添加以下路径:

foo.py 所在目录(如果是软链接,那么是真正的 foo.py 所在目录)或当前目录;

环境变量 PYTHONPATH中列出的目录(类似环境变量 PATH,由用户定义,默认为空);
site 模块被 import 时添加的路径1(site 会在运行时被自动 import)。

import site 所添加的路径一般是 XXX/site-packages。如果懒得记 sys.path 的初始化过程,可以简单的认为 import 的查找顺序是:

内置模块

.py 文件所在目录
pip 或 easy_install 安装的包

绝对导入和相对导入

绝对导入和相对导入的关系可以类比绝对路径和相对路径。

绝对导入的格式为:

import A.B
或
from A import B

相对导入格式为:

from . import B
或
from ..A import B

其中,点号.代表当前模块,..代表上层模块,…代表上上层模块,依次类推。

模块的执行方式

模块的执行可以有两种方式:直接执行和以模块执行,即:

python example/foo.py
或
python -m example.foo

注意,以模块执行时,一定要有包的概念,即example一定是个包,而foo是这个包下的模块,这样才能顺利执行。

包和模块

模块: 一个 .py 文件就是一个模块(module)

包: init .py 文件所在目录就是包(package)

各种情形测试

模块直接导入

即模块所在的目录都不是一个包结构,各个模块都是独立的,比如以下的目录结构:

D:\LEARN\IMPORT_TEST\TEST1
├─pack1
│  modu1.py
└─pack2
  modu2.py

modu1.py中的内容为:

import sys
sys.path.append("D:\\learn\\import_test\\TEST1\\pack2")
from modu2 import hello2
hello2()

modu2.py中的内容为:

def hello2():
 print("hello, I am module 2")

注意在modu1中一定加上sys.path.append那部分内容,即根据上面的描述,一定要让modu1能找到modu2才行,否则就会出现如下错误:

ModuleNotFoundError: No module named 'modu2'

此时进入pack1目录下,以直接执行或模块执行的方式都可以顺利输出。

包外导入

将上面两个模块所在的目录都变为包结构,即:

D:\LEARN\IMPORT_TEST\TEST2
├─pack1
│  modu1.py
│  __init__.py
└─pack2
  modu2.py
  __init__.py

此时也能顺利执行,同时比上面非包结构的多出来一条执行方式,即:

python -m pack1.modu1

即以包名+模块名的方式执行。

上面两种情形,即模块与模块、包与包都是相互独立的关系,也就没有相对导入的意义。

如果是在一个包内的不同模块的导入,那么最自然的就是使用相对导入。

包内相对导入

D:\LEARN\IMPORT_TEST\Test3
│ __init__.py
│
├─pack1
│  modu1.py
│  __init__.py
│
└─pack2
  modu2.py
  __init__.py

此时modu1.py中的内容为:

from ..pack2.modu2 import hello2
hello2()

即将sys.path.append去掉,因为是在一个包内相互引用,此时这样写没有意义。

此时正确运行的方式是进入Test3上一层的文件夹,然后:

python -m Test3.pack1.modu1

即明确地告诉解释器模块的层次结构。

而如果采用直接运行的方式,比如:

python Test3\pack1\modu1.py

就会报如下错误:

ValueError: attempted relative import beyond top-level package

这是因为,相对导入使用模块的 name (这里的name和下面的main都是有两个下划线的,但是网页显示不出来。。)属性来决定模块在包结构中的位置。当 name 属性不包含包信息(i.e. 没有用'.'表示的层次结构,比如' main ‘),则相对导入将模块解析为顶层模块,而不管模块在文件系统中的实际位置。这里模块被直接运行,则它自己为顶层模块,不存在层次结构,所以找不到其他的相对路径。

因此,直接运行带有相对导入的模块是不行的,需要通过模块运行的方式,将包结构明确告诉它才行。

这个原理也适用于下面这种错误,比如将modu2移动到pack1中,即与modu1在同一个目录下,然后将modu1的内容改为这样的相对引用:

from .modu2 import hello2
hello2()

此时使用模块执行的方式没有问题,如果还是想尝试直接运行,那么就会出现:

ModuleNotFoundError: No module named '__main__.modu2'; '__main__' is not a package

原因就是此时没有包结构, main 也不是个包。

那么解决方法就是或者使用模块运行的方式运行,或者将它改成下面的绝对导入的方式就可以直接运行。

包内绝对导入

那么,如果将modu1.py中的内容改为绝对导入,即:

from Test3.pack2.modu2 import hello2
hello2()

此时正确运行方式也是进入Test3上一层文件夹,然后使用模块执行的方式运行:

python -m Test3.pack1.modu1

如果此时采用直接运行的方式:

python Test3\pack1\modu1.py

那么就会报错:

ModuleNotFoundError: No module named 'Test3'

这主要是因为Test3没有被找到,即按照第一部分所说,Test3没有在import的搜索路径中。所以,只要将它加入进去即可,比如:

set PYTHONPATH=D:\learn\import_test\

此时再直接运行就没有问题了。

总结

以上所述是小编给大家介绍的Python3中的Import理解,希望对大家有所帮助!

Python 相关文章推荐
Python和Ruby中each循环引用变量问题(一个隐秘BUG?)
Jun 04 Python
Python的组合模式与责任链模式编程示例
Feb 02 Python
Python简单实现enum功能的方法
Apr 25 Python
从源码解析Python的Flask框架中request对象的用法
Jun 02 Python
Python中函数及默认参数的定义与调用操作实例分析
Jul 25 Python
Python3 模块、包调用&路径详解
Oct 25 Python
详解Python异常处理中的Finally else的功能
Dec 29 Python
Django中反向生成models.py的实例讲解
May 30 Python
Python绘制正余弦函数图像的方法
Aug 28 Python
如何在Django配置文件里配置session链接
Aug 06 Python
浅谈numpy中np.array()与np.asarray的区别以及.tolist
Jun 03 Python
python 星号(*)的多种用途
Sep 21 Python
Python英文文章词频统计(14份剑桥真题词频统计)
Oct 13 #Python
Python 转换RGB颜色值的示例代码
Oct 13 #Python
Django中自定义查询对象的具体使用
Oct 13 #Python
PyCharm导入python项目并配置虚拟环境的教程详解
Oct 13 #Python
Python 用三行代码提取PDF表格数据
Oct 13 #Python
Python3离线安装Requests模块问题
Oct 13 #Python
详解使用Python下载文件的几种方法
Oct 13 #Python
You might like
php设计模式 Builder(建造者模式)
2011/06/26 PHP
PHP动态生成指定大小随机图片的方法
2016/03/25 PHP
PHP基于PDO扩展操作mysql数据库示例
2018/12/24 PHP
PHP中$GLOBALS与global的区别详解
2019/03/21 PHP
php设计模式之备忘模式分析【星际争霸游戏案例】
2020/03/24 PHP
JavaScript中的null和undefined解析
2012/04/14 Javascript
JS删除数组元素的函数介绍
2013/03/27 Javascript
jquery的幻灯片图片切换效果代码分享
2015/09/07 Javascript
Jqgrid之强大的表格插件应用
2015/12/02 Javascript
javaScript中的原型解析【推荐】
2016/05/05 Javascript
JS实现的跨浏览器解析XML文件实例
2016/06/21 Javascript
基于vue.js实现图片轮播效果
2016/12/01 Javascript
Bootstrap导航条学习使用(一)
2017/02/08 Javascript
vue2 前后端分离项目ajax跨域session问题解决方法
2017/04/27 Javascript
详解webpack+es6+angular1.x项目构建
2017/05/02 Javascript
javascript trie前缀树的示例
2018/01/29 Javascript
实例讲解JS中pop使用方法
2019/01/27 Javascript
微信小程序利用swiper+css实现购物车商品删除功能
2019/03/06 Javascript
Vue keepAlive 数据缓存工具实现返回上一个页面浏览的位置
2019/05/10 Javascript
浅谈webpack构建工具配置和常用插件总结
2020/05/11 Javascript
vue中activated的用法
2021/01/03 Vue.js
Python实现短网址ShortUrl的Hash运算实例讲解
2015/08/10 Python
Python基于list的append和pop方法实现堆栈与队列功能示例
2017/07/24 Python
使用python将请求的requests headers参数格式化方法
2019/01/02 Python
django删除表重建的实现方法
2019/08/28 Python
python利用openpyxl拆分多个工作表的工作簿的方法
2019/09/27 Python
jupyter修改文件名方式(TensorFlow)
2020/04/21 Python
tensorflow指定CPU与GPU运算的方法实现
2020/04/21 Python
HTML5实现预览本地图片
2016/02/17 HTML / CSS
大学本科毕业生的自我鉴定范文
2013/11/19 职场文书
初中家长寄语
2014/04/02 职场文书
《天安门广场》教学反思
2014/04/23 职场文书
教师师德师风自我剖析材料
2014/09/29 职场文书
幼儿园教师个人总结
2015/02/05 职场文书
借款民事起诉状范文
2015/05/19 职场文书
幼儿园教师暑期培训心得体会
2016/01/09 职场文书