python中的utils模块_使用Python的package机制如何简化utils包设计详解-程序员宅基地

技术标签： python中的utils模块

package 机制

package是模块的集合，每一个Package的根目录下面都应当有一个__init__.py 文件。当解释器发现目录下有这个文件时，他就会认为这是一个Package，而不是一个普通的目录。

对于 package 机制的说明，其实官方文档已经有非常详尽的论述了，本文并不着眼于此。

简单来说，一个目录下如果包含 __init__.py ，则被 Python 视作一个 Python package。其中：

__init__.py 中的东西，在初始化这个包时，会首先被加载

package 中还可以定义 sub package

初衷

为了概念统一，我们把写代码的人，大致分为两种角色：

Library Author

Caller 即 API 使用者

有时候我们会是 1 或者 2,有时候我们可能既是 1 又是 2 ( 比如负责一个较大的系统时)

很显然，本文的角度是从 1 出发的（即我们只扮演库作者，并且不知道我们的调用者是谁）。

最开始时，utils 可能仅仅是一个 utils.py 就可以了，然后调用者 from utils import XXUtils 就完事了，这自然没有本文什么事。

然而大部分情况不是这样的，所有 Utils 都放到一个文件里面是 stupid 的（一个源码文件最多 400~500行）。所以我们的目录结构会是这样的：

utils/

__init__.py

a_util.py

b_util.py

......

调用者怎么使用呢？from utils.a_util import AUtils

这种方式有一个假定：调用者要很清楚他所需要的 Utils 位于哪个 py 文件中。但是这种假定并不总是成立，大家对于同一概念的理解，极有可能是千差万别的。比如 utils，你觉得叫做 utils 合适，别人还觉得叫做 tools 合适呢，其实都是同一个东西。

显然，这加重了调用者的心智负担。更加显然的是，作为库作者，我们有义务来优化调用者的使用体验！（不然你的库再牛逼，没有人爱用也是空弹琴。）

HOW

合理利用 package 机制，就能马上优化这一体验。

我们只要在 __init__.py 中这么写即可：

__init__.py

from .a_util import AUtils

from .b_util import BUtils

调用者则仍然是这么使用：

from utils import AUtils,BUtils

即：调用者根本不关心你的实现在哪里，你只要给我一个 utils 的命名空间即可，而且确保所有的 Utils 都在这个命名空间里面。

为了更加符合 PEP8 的规范，作为库作者，我们的目录结构可能会变成这样：

utils/

__init__.py

_a_util.py 不对外界公开,仅限本package的其他模块使用

_b_util.py

应用

不仅是对于 utils 包，对与 constants 包，exceptions 包也可以应用此方法。在许多开源库中，大牛们经常使用这一手法来优化我们的体验（太常见了，几乎大部分开源库的 __init__.py 中都会写东西）

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对编程小技巧的支持。

本文链接：https://blog.csdn.net/weixin_39530557/article/details/110076696

原作者删帖不实内容删帖广告或垃圾文章投诉

智能推荐

vue2封装对话框el-dialog组件_<el-dialog 封装成组件 vue2-程序员宅基地

文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_

MFC 文本框换行_c++ mfc同一框内输入二行怎么换行-程序员宅基地

文章浏览阅读4.7k次，点赞5次，收藏6次。MFC 文本框换行标签： it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行

redis-desktop-manager无法连接redis-server的解决方法_redis-server doesn't support auth command or ismis-程序员宅基地

文章浏览阅读832次。检查Linux是否是否开启所需端口，默认为6379，若未打开，将其开启：以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决，修改redis.conf，修改主机地址：bind 192.168.85.**；然后使用该配置文件，重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try

实验四数据选择器及其应用-程序员宅基地

文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用

角谷猜想 C++实现_角谷猜想c++代码-程序员宅基地

文章浏览阅读1w次，点赞3次，收藏5次。题目描述所谓角谷猜想，是指对于任意一个正整数，如果是奇数，则乘3加1，如果是偶数，则除以2，得到的结果再按照上述规则重复处理，最终总能够得到1。如，假定初始整数为5，计算过程分别为16、8、4、2、1。程序要求输入一个整数，将经过处理得到1的过程输出来。输入一个正整数N(N <= 2,000,000) 输出从输入整数到1的步骤，每一步为一行，每一部中描述计算过程。最后一行输出"En..._角谷猜想c++代码

XNA学习笔记——用顶点缓冲和索引缓冲创建地形_positions indices 自动创建地形-程序员宅基地

文章浏览阅读1k次。1: private float[,] LoadHeightData(Texture2D heightMap) 2: { 3: float minimumHeight = 255; 4: float maximumHeight = 0; 5: 6: int width = heightMap.Width; _positions indices 自动创建地形

随便推点

Java加密与解密_java 加密解密-程序员宅基地

文章浏览阅读5.5w次，点赞3次，收藏41次。加密方式主要有3种，摘要加密、对称加密与非对称加密。_java 加密解密

sql判断以逗号分隔的字符串中是否包含某个字符串，不是模糊查询_sql server 逗号分隔包含-程序员宅基地

文章浏览阅读6.5k次，点赞2次，收藏9次。sql语句中，以逗号分隔的字符串中是否包含某个特定字符串，类似于判断一个数组中是否包含某一个元素，例如：判断 ,a,b,c,d,e,f,g,中是否包含 a ，sql语句如何实现？SQL中没有类似VB中的Split的函数。此时，如要匹配 ,6,3,9,22,中的6。可用charindex函数巧妙实现：（注意红色的逗号）charindex( ',' +cast(6 as varchar)+ ',',‘,6,3,9,22,’)>0sqlserver：sqlserver中没有封装好的方法可以实现._sql server 逗号分隔包含