解析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的Django框架完成视频处理任务的教程
Apr 02 Python
使用pdb模块调试Python程序实例
Jun 02 Python
PyTorch基本数据类型(一)
May 22 Python
python3实现单目标粒子群算法
Nov 14 Python
pytorch ImageFolder的覆写实例
Feb 20 Python
Python3.9又更新了:dict内置新功能
Feb 28 Python
Django DRF认证组件流程实现原理详解
Aug 17 Python
selenium如何定位span元素的实现
Jan 13 Python
python实现scrapy爬虫每天定时抓取数据的示例代码
Jan 27 Python
浅谈Python类的单继承相关知识
May 12 Python
Python的三个重要函数详解
Jan 18 Python
68行Python代码实现带难度升级的贪吃蛇
Jan 18 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
Smarty局部缓存的几种方法简介
2014/06/17 PHP
PHP函数nl2br()与自定义函数nl2p()换行用法分析
2016/04/02 PHP
phpmyadmin下载、安装、配置教程
2017/05/16 PHP
php实现评论回复删除功能
2017/05/23 PHP
如何直接访问php实例对象中的private属性详解
2017/10/12 PHP
thinkphp5引入公共部分header、footer的方法详解
2018/09/14 PHP
javascript 读取图片文件的大小
2009/06/25 Javascript
JavaScript 获取用户客户端操作系统版本
2009/08/25 Javascript
使用js在页面中绘制表格核心代码
2013/09/16 Javascript
使用原生js写的一个简单slider
2014/04/29 Javascript
利用JavaScript判断浏览器类型及版本
2016/08/23 Javascript
微信小程序movable view移动图片和双指缩放实例代码
2017/08/08 Javascript
vue动态路由实现多级嵌套面包屑的思路与方法
2017/08/16 Javascript
微信小程序以ssm做后台开发的实现示例
2020/04/08 Javascript
vue项目中使用rem,在入口文件添加内容操作
2020/11/11 Javascript
vue穿梭框实现上下移动
2021/01/29 Vue.js
three.js如何实现3D动态文字效果
2021/03/03 Javascript
[22:07]DOTA2-DPC中国联赛 正赛 iG vs Magma 选手采访
2021/03/11 DOTA
python中使用urllib2获取http请求状态码的代码例子
2014/07/07 Python
Python线程中对join方法的运用的教程
2015/04/09 Python
详解Django框架中用户的登录和退出的实现
2015/07/23 Python
python 计算文件的md5值实例
2017/01/13 Python
django+js+ajax实现刷新页面的方法
2017/05/22 Python
Python微信公众号开发平台
2018/01/25 Python
利用python脚本如何简化jar操作命令
2019/02/24 Python
python 实现将多条曲线画在一幅图上的方法
2019/07/07 Python
关于PyTorch 自动求导机制详解
2019/08/18 Python
通过Python pyecharts输出保存图片代码实例
2020/11/25 Python
python+selenium爬取微博热搜存入Mysql的实现方法
2021/01/27 Python
ALDO加拿大官网:加拿大女鞋品牌
2018/12/22 全球购物
中级会计职业生涯规划书
2014/03/01 职场文书
应届大专生自荐书
2014/06/16 职场文书
工作年限证明模板
2014/11/01 职场文书
教师年度考核个人总结
2015/02/12 职场文书
《异世界四重奏》剧场版6月10日上映 PV视觉图原创角色发表
2022/03/20 日漫
clear 万能清除浮动(clearfix:after)
2023/05/21 HTML / CSS