解析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进行异常值分析实例代码
Dec 07 Python
python利用socketserver实现并发套接字功能
Jan 26 Python
python3学习笔记之多进程分布式小例子
Feb 13 Python
Linux下安装python3.6和第三方库的教程详解
Nov 09 Python
在python环境下运用kafka对数据进行实时传输的方法
Dec 27 Python
Python Flask 搭建微信小程序后台详解
May 06 Python
Django实现跨域的2种方法
Jul 31 Python
Python常用库大全及简要说明
Jan 17 Python
python实现翻译word表格小程序
Feb 27 Python
python为QT程序添加图标的方法详解
Mar 09 Python
django为Form生成的label标签添加class方式
May 20 Python
python游戏开发之pygame实现接球小游戏
Apr 22 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
采用thinkphp自带方法生成静态html文件详解
2014/06/13 PHP
PHP基于CURL进行POST数据上传实例
2014/11/10 PHP
PHP中捕获超时事件的方法实例
2015/02/12 PHP
PHP两种快速排序算法实例
2015/02/15 PHP
PHP异常处理浅析
2015/05/12 PHP
PHP框架自动加载类文件原理详解
2017/06/06 PHP
jquery foreach使用示例
2013/09/12 Javascript
利用javascript判断文件是否存在
2013/12/31 Javascript
Javascript URI 解析介绍
2015/03/15 Javascript
jQuery拖拽插件gridster使用指南
2015/04/21 Javascript
JavaScript实现删除,移动和复制文件的方法
2015/08/05 Javascript
js判断某个字符出现的次数的简单实例
2016/06/03 Javascript
ajax的分页查询示例(不刷新页面)
2017/01/11 Javascript
原生js实现打字动画游戏
2017/02/04 Javascript
JS去掉字符串前后空格或去掉所有空格的用法
2017/03/25 Javascript
详解React开发必不可少的eslint配置
2018/02/05 Javascript
vue实现简单的日历效果
2020/09/24 Javascript
jquery实现拖拽添加元素功能
2020/12/01 jQuery
Windows8下安装Python的BeautifulSoup
2015/01/22 Python
极简的Python入门指引
2015/04/01 Python
django 创建过滤器的实例详解
2017/08/14 Python
Python实现解析Bit Torrent种子文件内容的方法
2017/08/29 Python
django项目运行因中文而乱码报错的几种情况解决
2017/11/07 Python
Python实现八皇后问题示例代码
2018/12/09 Python
python里dict变成list实例方法
2019/06/26 Python
Python 内置函数globals()和locals()对比详解
2019/12/23 Python
Python常用模块sys,os,time,random功能与用法实例分析
2020/01/07 Python
Python中内建模块collections如何使用
2020/05/27 Python
大学生军训感想
2014/02/16 职场文书
经济信息系毕业生自荐信
2014/06/02 职场文书
六年级学生期末评语
2014/12/26 职场文书
初中中等生评语
2014/12/29 职场文书
导游词300字
2015/02/13 职场文书
中小企业员工手册范本
2015/05/14 职场文书
2016入党积极分子考察评语
2015/12/01 职场文书
原生Javascript+HTML5一步步实现拖拽排序
2021/06/12 Javascript