python中模块查找的原理与方法详解


Posted in Python onAugust 11, 2017

前言

本文主要给大家介绍了关于python模块查找的原理与方式,分享出来供大家参考学习,下面话不多说,来一起看看详细的介绍:

基础概念

module

模块, 一个 py 文件或以其他文件形式存在的可被导入的就是一个模块

package

包,包含有 __init__ 文件的文件夹

relative path

相对路径,相对于某个目录的路径

absolute path

绝对路径,全路径

路径查找

python 解释器查找被引入的包或模块

Python 解释器是如何查找包和模块的

Python 执行一个 py 文件,无论执行的方式是用绝对路径还是相对路径,interpreter 都会把文件所在的 directory 加入 sys.path 这个 list 中,Python 就是在 sys.path 中查找包和模块的,sys.path 中的内容本身又是又 Python 的环境变量决定。

code-1

#test.py
import os
import sys
print sys.path[0]
# execute
python test.py
python /Users/x/workspace/blog-code/p2016_05_28_python_path_find/test.py

执行表明相对路径和绝对路径都输出相同的结果,而且无论哪种执行方式,test.py 所在的文件夹都会被加入 sys.path 的首位,也就是索引为0的位置。

Python 解释器查找包的顺序是什么

解释器查找包,首先搜索 built-in module,其次搜索 sys.path ,这样的查找顺序将会导致同名包或模块被遮蔽。

code-2

#ls
├── os.py
├── test2.py
├── redis.py
#test2.py
import os
from redis import Redis
#execute test2.py
Traceback (most recent call last):
 File "/Users/x/workspace/blog-code/p2016_05_28_python_path_find/test2.py", line 1, in <module>
 from redis import Redis
ImportError: cannot import name Redis

由于 os 是 built-in module,即使在同目录下有同名模块,解释器依然可以找到正确的 os 模块,可以证实 built-in module 不会被遮蔽,而 redis 属于第三方模块,默认安装位置是 Python 环境变量中的 site-packages,解释器启动之后会将此目录中的内容加入 sys.path,由于当前目录会在 sys.path 的首位,当前目录的 redis 优先被找到,site-packages 中的 redis 模块被遮蔽了。

交互式执行环境的查找顺序

进入交互式执行环境,解释器会自动把当前目录加入 sys.path, 这时当前目录是以相对路径的形式出现在 sys.path 中:

>>> import os.path
>>> import sys
>>> os.path.abspath(sys.path[0])
'/Users/x/workspace/blog-code'
>>>

除此之外,其他与执行一个文件是相同的。

模块中的 __file__ 变量

__file__ is the pathname of the file from which the module was loaded, if it was loaded from a file. 如果一个模块是从文件加载的,__file__ 就是该模块的路径名?Python Doc:

顾名思义,当模块以文件的形式出现 __file__ 指的是模块文件的路径名,以相对路径执行 __file__ 是相对路径,以绝对路径执行 __file__ 是绝对路径。

#test3.py
print __file__
#相对路径执行
python test3.py
test3.py
#绝对路径执行
python /Users/x/workspace/blog-code/p2016_05_28_python_path_find/test3.py
/Users/x/workspace/blog-code/p2016_05_28_python_path_find/test3.py

为了保证__file__ 每次都能准确得到模块的正确位置,最好对其再取一次绝对路径 os.path.abspath(__file__)

交互式 shell 中的 __file__

>>> __file__
Traceback (most recent call last):
 File "<input>", line 1, in <module>
NameError: name '__file__' is not defined

这是因为当前交互式shell的执行并不是以文件的形式加载,所以不存在__file__ 这样的属性。

sys.argv[0] 变量

sys.argv[0] 是它用来获取主入口执行文件。

#test.py
import sys
print __file__
print sys.argv[0]

以上 print 输出相同的结果,因为主执行文件和__file__所属的模块是同一个,当我们改变入口文件,区别就出现了。

#test.py
import sys
print __file__
print sys.argv[0]
#test2.py
import test
#execute test2.py
/Users/x/workspace/blog-code/p2016_05_28_python_path_find/child/test.py #__file__
test2.py #sys.argv[0]

总的来说,sys.argv[0] 是获得入口执行文件路径,__file__ 是获得任意模块文件的路径。

sys.modules 的作用

既然 Python 是在 sys.path 中搜索模块的,那载入的模块存放在何处?答案就是 sys.modules。模块一经载入,Python 会把这个模块加入 sys.modules 中供下次载入使用,这样可以加速模块的引入,起到缓存的作用。

>>> import sys
>>> sys.modules['tornado']
Traceback (most recent call last):
 File "<input>", line 1, in <module>
KeyError: 'tornado'
>>> import tornado
>>> sys.modules['tornado']
<module 'tornado' from '/Users/x/python_dev/lib/python2.7/site-packages/tornado/__init__.pyc'>

前面说过 Python 解释器启动之后,会把预先载入 built-in module,可以通过 sys.modules 验证。

>>> sys.modules['os']
<module 'os' from '/Users/x/python_dev/lib/python2.7/os.pyc'>
>>>

借助 sys.modules 和 __file__,可以动态获取所有已加载模块目录和路径。

>>> import os
>>> os.path.realpath(sys.modules['os'].__file__)
'/Users/x/python_dev/lib/python2.7/os.pyc'
>>> import tornado
>>> os.path.realpath(sys.modules['tornado'].__file__)
'/Users/x/python_dev/lib/python2.7/site-packages/tornado/__init__.pyc'
def get_module_dir(name):
 path = getattr(sys.modules[name], '__file__', None)
 if not path
 raise AttributeError('module %s has not attribute __file__'%name)
 return os.path.dirname(os.path.abspath(path))

summary

总的来说,Python 是通过查找 sys.path 来决定包的导入,并且系统包优先级>同目录>sys.path,Python 中的特有属性 __file__ 以及 sys.argv[0]sys.modules 都能帮助我们理解包的查找和导入概念,只要能正确理解 sys.path 的作用和行为,理解包的查找就不是难题了。

文中所有代码见:github

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
举例讲解Python程序与系统shell交互的方式
Apr 09 Python
Python实现控制台输入密码的方法
May 29 Python
Python 搭建Web站点之Web服务器与Web框架
Nov 06 Python
Django如何实现内容缓存示例详解
Sep 24 Python
基于python代码实现简易滤除数字的方法
Jul 17 Python
python 3.6.5 安装配置方法图文教程
Sep 18 Python
解决Django加载静态资源失败的问题
Jul 28 Python
Django 实现xadmin后台菜单改为中文
Nov 15 Python
python双端队列原理、实现与使用方法分析
Nov 27 Python
tensorflow中tf.reduce_mean函数的使用
Apr 19 Python
python 异步async库的使用说明
May 04 Python
Python实现上下文管理器的方法
Aug 07 Python
python利用lxml读写xml格式的文件
Aug 10 #Python
Python编程实现及时获取新邮件的方法示例
Aug 10 #Python
Python中函数eval和ast.literal_eval的区别详解
Aug 10 #Python
Python基础之getpass模块详细介绍
Aug 10 #Python
Python中字典(dict)合并的四种方法总结
Aug 10 #Python
详解Python 模拟实现生产者消费者模式的实例
Aug 10 #Python
Python 操作文件的基本方法总结
Aug 10 #Python
You might like
PHP5 操作MySQL数据库基础代码
2009/09/29 PHP
php实现微信公众平台账号自定义菜单类
2014/12/02 PHP
php实现计数器方法小结
2015/01/05 PHP
PHP多个图片压缩成ZIP的方法
2020/08/18 PHP
Fixie.js 自动填充内容的插件
2012/06/28 Javascript
js实现网站首页图片滚动显示
2013/02/04 Javascript
JS获得QQ号码的昵称,头像,生日的简单实例
2013/12/04 Javascript
基于jQuery实现复选框的全选 全不选 反选功能
2014/11/24 Javascript
JavaScript的事件代理和委托实例分析
2015/03/25 Javascript
面向切面编程(AOP)的理解
2015/05/01 Javascript
Jquery easyui开启行编辑模式增删改操作
2016/01/14 Javascript
js实现页面跳转的五种方法推荐
2016/03/10 Javascript
如何在Linux上安装Node.js
2016/04/01 Javascript
easyui简介_动力节点Java学院整理
2017/07/14 Javascript
详解angular笔记路由之angular-router
2017/09/12 Javascript
vue实现自定义多选与单选的答题功能
2018/07/05 Javascript
在Vue methods中调用filters里的过滤器实例
2018/08/30 Javascript
了解JavaScript中的选择器
2019/05/24 Javascript
[02:21]DOTA2英雄基础教程 蝙蝠骑士
2013/12/16 DOTA
教你用Python写安卓游戏外挂
2018/01/11 Python
Python+OpenCV 实现图片无损旋转90°且无黑边
2019/12/12 Python
Python操作注册表详细步骤介绍
2020/02/05 Python
python PyAUtoGUI库实现自动化控制鼠标键盘
2020/09/09 Python
python 实现socket服务端并发的四种方式
2020/12/14 Python
CSS3属性box-sizing使用指南
2014/12/09 HTML / CSS
canvas仿写贝塞尔曲线的示例代码
2017/12/29 HTML / CSS
医科大学生的自我评价
2013/12/04 职场文书
会计人员岗位职责
2015/02/03 职场文书
2015年安全生产月活动总结
2015/03/26 职场文书
2015年乡镇纪委工作总结
2015/05/26 职场文书
2016国庆节67周年寄语
2015/12/07 职场文书
2019最新婚庆对联集锦!
2019/07/10 职场文书
少儿励志名言(80句)
2019/08/14 职场文书
详解vue身份认证管理和租户管理
2021/05/25 Vue.js
Windows Server 2012 R2 磁盘分区教程
2022/04/29 Servers
Django框架模板用法详解
2022/06/10 Python