Python中模块与包有相同名字的处理方法


Posted in Python onMay 05, 2017

前言

在编程开发中,个人觉得,只要按照规范去做,很少会出问题。刚开始学习一门技术时,的确会遇到很多的坑。踩的坑多了,这是好事,会学到更多东西,也会越来越觉得按照规范做的重要性,规范的制定就是用来规避问题的。有时候确实应该听听有经验人的建议,不要一意孤行。这好像不是本文的重点,其实我重点是想表达,尽量按规范做事,这样会少走很多弯路。

我现在使用的主力编程语言是 Python,在接触 Python 至今,我感觉我踩的坑还是极少的,基本上没有遇到什么奇怪的问题。实际上,这并不是一件好事,不踩坑,很多躺在暗处的知识点你不会了解,所以也很难成长。幸好,有一些会踩坑的同事。

一同事问我,在 Python 中,如果一个模块和一个包同名时,是不是只能导入包,如果要导入模块该怎么办。他的意思大概是这样的,在项目的同一级目录下,有一个 foo.py 文件和一个 foo/ 目录,如果 import foo 会导入 foo/ 的内容而不是 foo.py 的内容。

被问到这个问题时,我首先感觉到的是诧异,这明显是存在歧义的。如果是我,肯定不会把模块名和包名设计成一样的名字,因为本质上来说在导入的时候没法区分到底要导入谁。除非系统有特别的规定,例如,规定这种情况只能导入包。

我的潜意识里认为这里应该报错,Python 解释器不知道要导入谁。但是,同事告诉我,别人的代码是这么写的,而且在这种情况下会默认导入包。那就是可以的咯,而且解释器已经规定这种情况会总是导入包。

为了验证下这一点,我写了个简单的项目,项目结构如下:

.
├── main.py
└── same
 ├── api
 │ └── __init__.py
 ├── auth
 │ └── __init__.py
 ├── auth.py
 └── __init__.py

其中:

same/api/__init__/py 的内容:

from .. import auth

same/auth/__init__.py 的内容:

auth_str = "This is str in package!"

same/auth.py 的内容:

auth_str = "This is str in module!"

main.py 的内容:

from __future__ import print_function

from same.api import auth

# Script starts from here

if __name__ == "__main__":
 print(auth.auth_str)

稍微有些复杂,哈哈,主要是同事那儿大致的结构是这样的,这里是为更好的模拟下。我在 same.auth 包中定义了一个 auth_str 字符串,又在同名的 same.auth 模块中定义了一个同名的 auth_str 字符串,然后在 same.api 包尝试导入 auth,最后在 main.py 尝试输出 same.api.auth.auth_str,看看到底哪个字符串会被打印。同时尝试用 Python2 和 Python3 执行 main.py,得到的结果都是:

This is str in package!

这里验证了我们的猜想是正确的,解释器的确只导入了包中内容。但是,我并不知道是否有官方的资料说明就是这样的,所以我不敢确信,万一这只是巧合呢。

于是,我开始查资料来验证这一结论。我就说实话吧,对于一个英文水平烂到你无法想象的我,只能先尝试用百度搜索下答案了。事实是,用百度往往都是遗憾的。片刻后,无果,我只能硬着头皮尝试英文搜索了。于是,在 stackoverflow 上找到了如下提问:

How python deals with module and package having the same name?

其中有一个人回答说 Python 官方文档中在描述模块搜索路径时提到了这一点:https://docs.python.org/3/tutorial/modules.html#the-module-search-path.

文档中有如下一段描述:

After initialization, Python programs can modify sys.path. The directory containing the script being run is placed at the beginning of the search path, ahead of the standard library path. This means that scripts in that directory will be loaded instead of modules of the same name in the library directory. This is an error unless the replacement is intended. See section Standard Modules for more information.

也就是说,目录在库的搜索路径下会首先被搜索,这就意味着目录会代替同名的模块被加载。

这下终于放心了,之前的结论得到证实。在 Python 中,如果尝试导入同名的模块和包时,包会被导入。这种情况下,如果想要导入模块,恐怕要用一些 ‘hack' 的方法,上面提到的 stackoverflow 帖下有一些示例可以参考。当然,最好的方法是避免这样的设计,这样你就不会花那么长时间去查资料,也不会花那么长时间来写类似于本文的文章。

总结

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

Python 相关文章推荐
Python实现基本数据结构中栈的操作示例
Dec 04 Python
django+echart绘制曲线图的方法示例
Nov 26 Python
ZABBIX3.2使用python脚本实现监控报表的方法
Jul 02 Python
Pytorch之卷积层的使用详解
Dec 31 Python
Jupyter Notebook 文件默认目录的查看以及更改步骤
Apr 14 Python
Django ORM实现按天获取数据去重求和例子
May 18 Python
使用keras实现非线性回归(两种加激活函数的方式)
Jul 05 Python
Python爬虫如何破解JS加密的Cookie
Nov 19 Python
Selenium 安装和简单使用的实现
Dec 04 Python
Python 找出英文单词列表(list)中最长单词链
Dec 14 Python
Python爬虫爬取微博热搜保存为 Markdown 文件的源码
Feb 22 Python
Python re.sub 反向引用的实现
Jul 07 Python
详解python 字符串和日期之间转换 StringAndDate
May 04 #Python
Pycharm学习教程(7)虚拟机VM的配置教程
May 04 #Python
python 统计代码行数简单实例
May 04 #Python
利用PyInstaller将python程序.py转为.exe的方法详解
May 03 #Python
Pycharm学习教程(6) Pycharm作为Vim编辑器使用
May 03 #Python
利用numpy+matplotlib绘图的基本操作教程
May 03 #Python
利用matplotlib+numpy绘制多种绘图的方法实例
May 03 #Python
You might like
php 动态执行带有参数的类方法
2009/04/10 PHP
php连接数据库代码应用分析
2011/05/29 PHP
ThinkPHP水印功能实现修复PNG透明水印并增加JPEG图片质量可调整
2014/11/05 PHP
php自定义中文字符串截取函数substr_for_gb2312及substr_for_utf8示例
2016/05/28 PHP
NodeJS学习笔记之Http模块
2015/01/13 NodeJs
JavaScript页面模板库handlebars的简单用法
2015/03/02 Javascript
javascript操作Cookie(设置、读取、删除)方法详解
2015/03/18 Javascript
jQuery实现将div中滚动条滚动到指定位置的方法
2016/08/10 Javascript
vue bootstrap小例子一枚
2017/06/09 Javascript
JS+canvas实现的五子棋游戏【人机大战版】
2017/07/19 Javascript
ubuntu编译nodejs所需的软件并安装
2017/09/12 NodeJs
vue.js简单配置axios的方法详解
2017/12/13 Javascript
使用vue点击li,获取当前点击li父辈元素的属性值方法
2018/09/12 Javascript
小程序实现列表多个批量倒计时
2021/01/29 Javascript
javascript实现5秒倒计时并跳转功能
2019/06/20 Javascript
Vue实现点击当前元素以外的地方隐藏当前元素(实现思路)
2019/12/04 Javascript
学习python处理python编码问题
2011/03/13 Python
详细介绍Python语言中的按位运算符
2013/11/26 Python
Python最火、R极具潜力 2017机器学习调查报告
2017/12/11 Python
PyQt4 treewidget 选择改变颜色,并设置可编辑的方法
2019/06/17 Python
python输出电脑上所有的串口名的方法
2019/07/02 Python
在Python中等距取出一个数组其中n个数的实现方式
2019/11/27 Python
文件上传服务器-jupyter 中python解压及压缩方式
2020/04/22 Python
详解Python模块化编程与装饰器
2021/01/16 Python
HTML5 canvas基本绘图之文字渲染
2016/06/27 HTML / CSS
高级运动鞋:GREATS
2019/07/19 全球购物
Richards网上商店:当代时尚,遍布巴西
2019/11/03 全球购物
Python中pass语句的作用是什么
2016/06/01 面试题
会计毕业生自我鉴定
2013/11/04 职场文书
2014年党员公开承诺践诺书
2014/03/25 职场文书
同居协议书范本
2014/04/23 职场文书
商铺门面租房协议书
2014/10/21 职场文书
2014年团支部年度工作总结
2014/12/24 职场文书
门卫管理制度范本
2015/08/05 职场文书
利用python做表格数据处理
2021/04/13 Python
如何在Python中妥善使用进度条详解
2022/04/05 Python