使用Python的package机制如何简化utils包设计详解
package机制
package是模块的集合,每一个Package的根目录下面都应当有一个__init__.py文件。当解释器发现目录下有这个文件时,他就会认为这是一个Package,而不是一个普通的目录。
对于package机制的说明,其实官方文档已经有非常详尽的论述了,本文并不着眼于此。
简单来说,一个目录下如果包含__init__.py,则被Python视作一个Pythonpackage。其中:
- __init__.py中的东西,在初始化这个包时,会首先被加载
- package中还可以定义subpackage
初衷
为了概念统一,我们把写代码的人,大致分为两种角色:
- LibraryAuthor
- Caller即API使用者
有时候我们会是1或者2,有时候我们可能既是1又是2(比如负责一个较大的系统时)
很显然,本文的角度是从1出发的(即我们只扮演库作者,并且不知道我们的调用者是谁)。
最开始时,utils可能仅仅是一个utils.py就可以了,然后调用者fromutilsimportXXUtils就完事了,这自然没有本文什么事。
然而大部分情况不是这样的,所有Utils都放到一个文件里面是stupid的(一个源码文件最多400~500行)。所以我们的目录结构会是这样的:
utils/ __init__.py a_util.py b_util.py ......
调用者怎么使用呢?fromutils.a_utilimportAUtils
这种方式有一个假定:调用者要很清楚他所需要的Utils位于哪个py文件中。但是这种假定并不总是成立,大家对于同一概念的理解,极有可能是千差万别的。比如utils,你觉得叫做utils合适,别人还觉得叫做tools合适呢,其实都是同一个东西。
显然,这加重了调用者的心智负担。更加显然的是,作为库作者,我们有义务来优化调用者的使用体验!(不然你的库再牛逼,没有人爱用也是空弹琴。)
HOW
合理利用package机制,就能马上优化这一体验。
我们只要在__init__.py中这么写即可:
__init__.py from.a_utilimportAUtils from.b_utilimportBUtils
调用者则仍然是这么使用:
fromutilsimportAUtils,BUtils
即:调用者根本不关心你的实现在哪里,你只要给我一个utils的命名空间即可,而且确保所有的Utils都在这个命名空间里面。
为了更加符合PEP8的规范,作为库作者,我们的目录结构可能会变成这样:
utils/ __init__.py _a_util.py不对外界公开,仅限本package的其他模块使用 _b_util.py
应用
不仅是对于utils包,对与constants包,exceptions包也可以应用此方法。在许多开源库中,大牛们经常使用这一手法来优化我们的体验(太常见了,几乎大部分开源库的__init__.py中都会写东西)
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对毛票票的支持。