使用Python的package机制如何简化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 中都会写东西）

总结

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

赞 (0)

相关推荐

  • python一键升级所有pip package的方法

    pip_ungrade_all.py代码如下: # -*- coding: utf-8 -*- import pip from subprocess import call for dist in pip.get_installed_distributions(): call("pip install --upgrade " + dist.project_name, shell=True) 以管理身份执行脚本pip_ungrade_all.py # python pip_ungrade

  • Python上传package到Pypi(代码简单)

    废话不多说了,直接给大家贴代码了. 编写setup.py后 $ python setup.py register $ python setup.py sdist upload 以上是针对Python上传package到Pypi(代码简单)的全部内容,本文写的不好,还请大家多多指教,在此小编祝大家新年快乐.

  • 对Python进行数据分析_关于Package的安装问题

    对Python进行数据分析_关于Package的安装问题

    一.为什么要使用Python进行数据分析? python拥有一个巨大的活跃的科学计算社区,拥有不断改良的库,能够轻松的集成C,C++,Fortran代码(Cython项目),可以同时用于研究和原型的构建以及生产系统的构建. 二.Python的优势与劣势: 1.Python是一种解释型语言,运行速度比编译型数据慢. 2.由于python有一个全局解释器锁(GIL),防止解释器同时执行多条python字节码,所以python不适用于高并发.多线程的应用程序. 三.使用Python进行数据分析常用的扩

  • Python开发常用的一些开源Package分享

    一般安装完Python后,我会先装一些常用的Package.做个笔记,记录下来,以备查询: Web FrameWorks Tornado,访问:http://www.tornadoweb.org/en/stable/ Flask,访问:http://flask.pocoo.org/ Web.py,访问:http://webpy.org/ Tools xlrd,Excel处理利器,访问:http://www.python-excel.org/ lxml,XML处理,访问:http://lxml.d

  • 使用Python的package机制如何简化utils包设计详解

    package 机制 package是模块的集合,每一个Package的根目录下面都应当有一个__init__.py 文件.当解释器发现目录下有这个文件时,他就会认为这是一个Package,而不是一个普通的目录. 对于 package 机制的说明,其实官方文档已经有非常详尽的论述了,本文并不着眼于此. 简单来说,一个目录下如果包含 __init__.py ,则被 Python 视作一个 Python package.其中: __init__.py 中的东西,在初始化这个包时,会首先被加载 pac

  • Python企业编码生成系统之系统主要函数设计详解

    本文实例讲述了Python企业编码生成系统之系统主要函数设计.分享给大家供大家参考,具体如下: 一 主要函数功能描述 函数 功能 mkdir 判断保存防伪码或补充防伪码的文件夹是否存在,如果不存在则建立文件夹. openfile 读取文本文件函数,主要读取保存产品编码和生成数量的文件mrsoft.mri,以及用户选择的已生成的编码文件. inputbox 输入验证判断函数,根据参数判断输入的是哪种类型,是否合法 wfile 编码输出显示函数,通过屏幕输出和文件输出两种方式输出生成的防伪码信息.

  • python 接口_从协议到抽象基类详解

    python 接口_从协议到抽象基类详解

    抽象基类的常见用途:实现接口时作为超类使用.然后,说明抽象基类如何检查具体子类是否符合接口定义,以及如何使用注册机制声明一个类实现了某个接口,而不进行子类化操作.最后,说明如何让抽象基类自动"识别"任何符合接口的类--不进行子类化或注册. Python文化中的接口和协议 接口在动态类型语言中是怎么运作的呢?首先,基本的事实是,Python语言没有 interface 关键字,而且除了抽象基类,每个类都有接口:类实现或继承的公开属性(方法或数据属性),包括特殊方法,如__getitem_

  • 对Python 中矩阵或者数组相减的法则详解

    最近在做编程练习,发现有些结果的值与答案相差较大,通过分析比较得出结论,大概过程如下: 定义了一个计算损失的函数: def error(yhat,label): yhat = np.array(yhat) label = np.array(label) error_sum = ((yhat - label)**2).sum() return error_sum 主要出现问题的是 yhat - label 部分,要强调的是一定要保证两者维度是相同的!这点很重要,否则就会按照python的广播机制进

  • 对python PLT中的image和skimage处理图片方法详解

    用PLT比较轻量级,用opencv是比较重量级 import numpy as np from PIL import Image if __name__ == '__main__': image_file = '/Users/mac/Documents/学习文档/机器学习/5.Package/son.png' height = 100 #假定写入图片的高度是100 img = Image.open(image_file) img_width, img_height = img.size #获取i

  • 如何在python开发工具PyCharm中搭建QtPy环境(教程详解)

    在Python的开发工具PyCharm中安装QtPy5(版本5):打开"File"--"Settings"--"Project Interpreter",点击窗口中右侧点添加按钮,然后在弹出的窗口添加PyQt5模块包,单击Install Package按钮,如图所示: 安装好安装PyQt5后,需要用同样的方法安装pyqt5-tools,安装PyQt5后没有designer.exe就是因为没有安装pyqt5-tools.安装好PyQt5后,desi

  • Python中使用threading.Event协调线程的运行详解

    threading.Event机制类似于一个线程向其它多个线程发号施令的模式,其它线程都会持有一个threading.Event的对象,这些线程都会等待这个事件的"发生",如果此事件一直不发生,那么这些线程将会阻塞,直至事件的"发生". 对此,我们可以考虑一种应用场景(仅仅作为说明),例如,我们有多个线程从Redis队列中读取数据来处理,这些线程都要尝试去连接Redis的服务,一般情况下,如果Redis连接不成功,在各个线程的代码中,都会去尝试重新连接. 如果我们想

  • Python日志打印里logging.getLogger源码分析详解

    实践环境 WIN 10 Python 3.6.5 函数说明 logging.getLogger(name=None) getLogger函数位于logging/__init__.py脚本 源码分析 _loggerClass = Logger # ...略 root = RootLogger(WARNING) Logger.root = root Logger.manager = Manager(Logger.root) # ...略 def getLogger(name=None): "&quo

  • python数据可视化使用pyfinance分析证券收益示例详解

    python数据可视化使用pyfinance分析证券收益示例详解

    目录 pyfinance简介 pyfinance包含六个模块 returns模块应用实例 收益率计算 CAPM模型相关指标 风险指标 基准比较指标 风险调整收益指标 综合业绩评价指标分析实例 结语 pyfinance简介 在查找如何使用Python实现滚动回归时,发现一个很有用的量化金融包--pyfinance.顾名思义,pyfinance是为投资管理和证券收益分析而构建的Python分析包,主要是对面向定量金融的现有包进行补充,如pyfolio和pandas等. pyfinance包含六个模块

  • Python OpenCV学习之特征点检测与匹配详解

    Python OpenCV学习之特征点检测与匹配详解

    目录 背景 一.Harris角点 二.Shi-Tomasi角点检测 三.SIFT关键点 四.SIFT描述子 五.SURF 六.ORB 七.暴力特征匹配(BF) 八.FLANN特征匹配 九.图像查找 总结 背景 提取图像的特征点是图像领域中的关键任务,不管在传统还是在深度学习的领域中,特征代表着图像的信息,对于分类.检测任务都是至关重要的: 特征点应用的一些场景: 图像搜索:以图搜图(电商.教育领域) 图像拼接:全景拍摄(关联图像拼接) 拼图游戏:游戏领域 一.Harris角点 哈里斯角点检测主要

随机推荐