解析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新手经常遇到的17个错误分析
Jul 30 Python
对python 各种删除文件失败的处理方式分享
Apr 24 Python
详解Python3的TFTP文件传输
Jun 26 Python
python将控制台输出保存至文件的方法
Jan 07 Python
对python:threading.Thread类的使用方法详解
Jan 31 Python
Python实现的读取文件内容并写入其他文件操作示例
Apr 09 Python
Django学习笔记之为Model添加Action
Apr 30 Python
windows环境中利用celery实现简单任务队列过程解析
Nov 29 Python
详解Python中的分支和循环结构
Feb 11 Python
Django认证系统user对象实现过程解析
Mar 02 Python
Appium+Python实现简单的自动化登录测试的实现
Jan 26 Python
python编程项目中线上问题排查与解决
Nov 01 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
vBulletin HACK----显示话题大小和打开新窗口于论坛索引页
2006/10/09 PHP
php 变量定义方法
2009/06/14 PHP
php 模拟POST|GET操作实现代码
2010/07/20 PHP
解析php中static,const与define的使用区别
2013/06/18 PHP
PHP中数组的分组排序实例
2014/06/01 PHP
ThinkPHP使用PHPExcel实现Excel数据导入导出完整实例
2014/07/22 PHP
php原生导出excel文件的两种方法(推荐)
2016/11/19 PHP
NodeJS 模块开发及发布详解分享
2012/03/07 NodeJs
js与jquery获取父元素,删除子元素的两种不同方法
2014/01/09 Javascript
小米公司JavaScript面试题
2014/12/29 Javascript
js 截取或者替换字符串中的数字实现方法
2016/06/13 Javascript
Javascript OOP之面向对象
2016/07/31 Javascript
基于jQuery和Bootstrap框架实现仿知乎前端动态列表效果
2016/11/09 Javascript
简单理解js的冒泡排序
2016/12/19 Javascript
JS实现浏览器打印、打印预览示例
2017/02/28 Javascript
prototype.js简单实现ajax功能示例
2017/10/18 Javascript
分享ES6的7个实用技巧
2018/01/18 Javascript
除Console.log()外更多的Javascript调试命令
2018/01/24 Javascript
详解JSON Web Token 入门教程
2018/07/30 Javascript
vue 弹框产生的滚动穿透问题的解决
2018/09/21 Javascript
Vue实现固定定位图标滑动隐藏效果
2019/05/30 Javascript
发布订阅模式在vue中的实际运用实例详解
2019/06/09 Javascript
简述ES6新增关键字let与var的区别
2019/08/23 Javascript
Node Mongoose用法详解【Mongoose使用、Schema、对象、model文档等】
2020/05/13 Javascript
微信小程序实现导航栏和内容上下联动功能代码
2020/06/29 Javascript
Vue 解决父组件跳转子路由后当前导航active样式消失问题
2020/07/21 Javascript
centos下更新Python版本的步骤
2013/02/12 Python
Python操作sqlite3快速、安全插入数据(防注入)的实例
2014/04/26 Python
进一步探究Python中的正则表达式
2015/04/28 Python
Python在信息学竞赛中的运用及Python的基本用法(详解)
2017/08/15 Python
Python3远程监控程序的实现方法
2019/07/15 Python
python实现读取excel文件中所有sheet操作示例
2019/08/09 Python
Pygame的程序开始示例代码
2020/05/07 Python
商家认证委托书格式
2014/10/16 职场文书
2016年小学“我们的节日·中秋节”活动总结
2016/04/05 职场文书
Logback 使用TurboFilter实现日志级别等内容的动态修改操作
2021/08/30 Java/Android