自从有了它,我就再也没有用过函数重写

前言

了解过编程的人应该对函数重写 ( override ) 不陌生,但其实,这个普适的方法并不适用于所有的应用场景。举个简单的例子,当多个项目代码贡献方都想参与同一程序的修改时,频繁的函数重写会使代码变得异常混乱,让整个项目变得难以维护。

那么,有没有更优雅的方法能够兼顾代码的扩展性与稳定性呢?

有的,pytest ( python 单元测试框架 ) 的作者就意识到了这个问题。在其源码中,可以发现许多经过 @pytest.hookimpl 关键字装饰的函数,这代表这个函数是一个插件的实现,其作用是通过用插件调用的形式来替代函数重写。

pytest 部分源码:

@pytest.hookimpl(hookwrapper=True)
def pytest_load_initial_conftests(early_config: Config):
    ns = early_config.known_args_namespace
    if ns.capture == "fd":
        _py36_windowsconsoleio_workaround(sys.stdout)
    _colorama_workaround()
    _readline_workaround()
    pluginmanager = early_config.pluginmanager
    capman = CaptureManager(ns.capture)
    pluginmanager.register(capman, "capturemanager")

    # make sure that capturemanager is properly reset at final shutdown
    early_config.add_cleanup(capman.stop_global_capturing)

    # finally trigger conftest loading but while capturing (issue93)
    capman.start_global_capturing()
    outcome = yield
    capman.suspend_global_capture()
    if outcome.excinfo is not None:
        out, err = capman.read_global_capture()
        sys.stdout.write(out)
        sys.stderr.write(err)

早前在 pytest 中这只是一个插件工具库,而随着这个库的日益发展, 作者把它从 pytest 中分离了出来,并将其命名为了 pluggy

什么是 pluggy ?

pluggy 是 pytest 中插件管理和钩子函数调用的核心组件。它已经让 500 多个插件自由扩展和自定义了 pytest 的默认行为。甚至可以说 pytest 本身就是根据良好的规范协议依次调用的插件的集合。

通过为主程序安装插件,它使用户能够扩展或修改主程序的行为。插件代码将作为正常程序执行的一部分运行,从而更改或增强程序的某些功能。

本质上,pluggy 让所有函数 "钩子化",因此使用者可以用其轻松构建 "可插拔" 系统。

为什么要用 pluggy ?

当有多方想要定制化扩展程序时,使用函数重写的方式将会导致程序代码异常混乱。而通过 pluggy 可以使得到主程序与插件之间松耦合。

pluggy 也让主程序的设计者去仔细考虑钩子函数实现中需要用到哪些对象。而这为插件创建者提供了一个清晰的框架,因为它说明了如何通过一组定义良好的函数和对象来扩展主程序,最终让整个项目代码框架结构越来越清晰。

pluggy 是如何工作的?

首先我们需要了解两个概念:

  • 主程序:通过指定钩子函数并在程序执行过程中调用其实现来提供可扩展性的程序;

  • 插件:程序实现指定的钩子(的一部分)并在主程序调用实现时参与程序执行。

而 pluggy 的作用则是通过使用以下几个方面 联通主程序与插件

  • 定义主程序提供的调用签名对应的钩子规范;
  • 由注册插件提供的钩子实现(也称为hookimpl-可参阅回调);
  • 钩子调用者 - 在主程序中适当的位置触发的调用循环,调用实现并收集结果。

一个简单的例子

来演示一下 pluggy 的核心功能 - 即插即用。

import pluggy

hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")


class MySpec(object):
    """A hook specification namespace."""

    @hookspec
    def myhook(self, arg1, arg2):
        """My special little hook that you can customize."""


class Plugin_1(object):
    """A hook implementation namespace."""

    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2


class Plugin_2(object):
    """A 2nd hook implementation namespace."""

    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2


# create a manager and add the spec
pm = pluggy.PluginManager("myproject")
pm.add_hookspecs(MySpec)
# register plugins
pm.register(Plugin_1())
pm.register(Plugin_2())
# call our `myhook` hook
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

在上述代码中,开发者

  • 定义了主程序提供的调用签名 (myproject)对应的钩子规范 - hookspec;

  • 定义了钩子实现 - hookimpl;

  • 在 MySpec 中定义了 myhook 的入参;

  • 在 Plugin_1 和 Plugin_2 中定义了 myhook 具体实现;

  • 新建了插件管理对象 pm;

  • 在 pm 中添加设置好的钩子规格 MySpec;

  • 在 pm 中注册了定义好的 Plugin_1 和 Plugin_2;

  • 通过 pm 进行了 myhook 的调用。

运行代码后控制台输出如下:

inside Plugin_2.myhook()
inside Plugin_1.myhook()
[-1, 3]

为什么输出是 [-1,3] 呢? 其实我们可以看出两个插件中实现了相同的函数名,根据插件调用的先进后出原则,在调用 myhook 后程序会先执行后注册的 Plugin_2.myhook(),后执行先注册的 Plugin_1.myhook()。所以在最终的返回结果中,会获得按执行顺序排列的返回值列表,其值分别是 -1 和 3。

结尾

经过了一段时间的学习,在亲身实践中确实领会到了插件化给系统带来的益处。它不仅给予了程序无限扩展的可能,也为代码赋予了稳定的基础结构。这非常重要,因为如果地基不够稳固,程序大厦将会在某个时刻瞬间崩塌。

现实中,其实所有的程序都在跟随着实际业务不停地发展。所以从来都没有一劳永逸的设计模式,只有不停地在优化着的代码结构。当一种编码方式无法满足现状、满足需求时。总会有人去推翻它,去构建属于这个时代的新模式。而这,正是编程的魅力所在。

image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容

  • 目录: 安装及入门 使用和调用方法 原有TestSuite使用方法 断言的编写和报告 Pytest fixture...
    韩志超阅读 5,328评论 0 5
  • Pytest 是一个比较成熟且功能完备的 Python 测试框架。其提供完善的在线文档,并有着大量的第三方插件和内...
    派派森森阅读 4,356评论 0 12
  • 血色婚礼(下) 六、家庭变故 冷兵器盛行的...
    那一只鲸阅读 707评论 0 4
  • 蒴果是干果中的裂果的一种,由合生心皮的复雌蕊发育而成。心皮是雌蕊的构成单位,一枚雌蕊可以由一枚心皮构成,也可以由两...
    空空_5343阅读 2,442评论 3 5
  • 2011年10月14日(阴历),这是父亲离开我们的日子,到今天是8周年。 我们买了很多纸钱、冥币、金条等。妈妈折...
    青莲红阅读 165评论 0 1