解析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 相关文章推荐
在ironpython中利用装饰器执行SQL操作的例子
May 02 Python
Python函数式编程指南(一):函数式编程概述
Jun 24 Python
Python抓取电影天堂电影信息的代码
Apr 07 Python
Python基于列表模拟堆栈和队列功能示例
Jan 05 Python
pycharm下查看python的变量类型和变量内容的方法
Jun 26 Python
Python定义二叉树及4种遍历方法实例详解
Jul 05 Python
使用Python横向合并excel文件的实例
Dec 11 Python
Python中使用双下划线防止类属性被覆盖问题
Jun 27 Python
python如何读取bin文件并下发串口
Jul 05 Python
如何提高python 中for循环的效率
Apr 15 Python
django自带的权限管理Permission用法说明
May 13 Python
BeautifulSoup中find和find_all的使用详解
Dec 07 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守护进程类
2015/12/30 PHP
PHP array_key_exists检查键名或索引是否存在于数组中的实现方法
2016/06/13 PHP
PHP中SQL查询语句的id=%d解释(推荐)
2016/12/10 PHP
javascript实现面向对象类的功能书写技巧
2010/03/07 Javascript
jquery 学习之二 属性 文本与值(text,val)
2010/11/25 Javascript
jQuery操作input值的各种方法总结
2013/11/21 Javascript
跟我学习javascript的undefined与null
2015/11/17 Javascript
详解JavaScript的变量和数据类型
2015/11/27 Javascript
javascript自动恢复文本框点击清除后的默认文本
2016/01/12 Javascript
Node.js下自定义错误类型详解
2016/10/17 Javascript
JQuery.dataTables表格插件添加跳转到指定页
2017/06/09 jQuery
vue组件中使用iframe元素的示例代码
2017/12/13 Javascript
React Native 真机断点调试+跨域资源加载出错问题的解决方法
2018/01/18 Javascript
Vue 配合eiement动态路由,权限验证的方法
2018/09/26 Javascript
vue element动态渲染、移除表单并添加验证的实现
2019/01/16 Javascript
layui 实现自动选择radio单选框(checked)的方法
2019/09/03 Javascript
layui之数据表格--与后台交互获取数据的方法
2019/09/29 Javascript
JS如何实现手机端输入验证码效果
2020/05/13 Javascript
基于JavaScript或jQuery实现网站夜间/高亮模式
2020/05/30 jQuery
详解js中的几种常用设计模式
2020/07/16 Javascript
js实现拖拽与碰撞检测
2020/09/18 Javascript
Python比较两个图片相似度的方法
2015/03/13 Python
python类和函数中使用静态变量的方法
2015/05/09 Python
python学习基础之循环import及import过程
2018/04/22 Python
python中enumerate() 与zip()函数的使用比较实例分析
2019/09/03 Python
python基于gevent实现并发下载器代码实例
2019/11/01 Python
PyCharm 无法 import pandas 程序卡住的解决方式
2020/03/09 Python
python基于Kivy写一个图形桌面时钟程序
2021/01/28 Python
html5使用canvas实现弹幕功能示例
2017/09/11 HTML / CSS
英国手机零售商:Carphone Warehouse
2018/06/06 全球购物
几道数据库的概念性面试题
2014/05/30 面试题
入股合作协议书
2014/10/12 职场文书
开展批评与自我批评发言稿
2014/10/16 职场文书
工作保证书怎么写
2015/02/28 职场文书
2015年采购员工作总结
2015/04/27 职场文书
初中班长竞选稿
2015/11/20 职场文书