AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

Python----pluggy模块的用法

2022-05-14 469
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Python----pluggy模块的用法

1 pluggy 简介

  • pluggy 作用：提供了一个简易便捷的插件系统，可以做到插件与主题功能松耦合
  • pluggy 是pytest，tox，devpi的核心框架

2 安装

执行如下命令即可

pip install pluggy

3 使用初体验

import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了一个接口
    @hookspec
    def myhook(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

执行结果如下：

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

4 详解解释

从代码上看比较绕，其实通俗一点理解，其实挺简单的，可以理解为首先定义一个接口类，然后定义很多插件类，插件类想要多少就定义多少，
接口类中要定义接口，上面的例子值定义了一个接口，其实可以定义很多接口，在每个插件类中需要选择接口类中的接口去实现，当然也不需要每个
都需要去实现，可以根据自己的需要有选择的去实现。

举个例子：

比如定义了一个接口类，接口类中定义了10个接口，同时定义了3个类，这三个类分别实现了接口类中3个接口，6个接口和10个接口，然后实例化一个插件管理的对象，实例化对象将接口类加入定义模板中，然后去注册这三个类，注册之后，就可以通过插件管理对象的钩子去调用接口类中的每个方法了，比如调用头三个方法，因为每个插件中都实现了，所以就会有三个结果，调用后面4-6的接口时，因为只有两个插件实现了，所以只会有两个结果返回，调用7-10的接口因为只有一个插件类实现了，所以就会只有一个结果返回，这样插件使用起来就非常灵活，可以真正做到“热插拔”

下面用代码示例演示：

import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了3个接口
    @hookspec
    def myhook1(self, arg1, arg2):
        pass

    @hookspec
    def myhook2(self, arg1, arg2):
        pass

    @hookspec
    def myhook3(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl
    def myhook1(self, arg1, arg2):
        print("inside Plugin_1.myhook1()")
        return arg1 + arg2

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

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

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook1(self, arg1, arg2):
        print("inside Plugin_2.myhook1()")
        return arg1 - arg2

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

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

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook1(arg1=1, arg2=2)
print(results)
results = pm.hook.myhook2(arg1=1, arg2=2)
print(results)
results = pm.hook.myhook3(arg1=1, arg2=2)
print(results)
results = pm.hook.myhook4(arg1=1, arg2=2)
print(results)

执行结果如下：

inside Plugin_2.myhook1()
inside Plugin_1.myhook1()
[-1, 3]
inside Plugin_2.myhook2()
inside Plugin_1.myhook2()
[-2, 4]
inside Plugin_2.myhook3()
[-3]
inside Plugin_1.myhook4()
[5]

从上面的代码示例可以看出：

  • 1）myhook1 和 myhook2 因为两个插件都实现了，所有返回两个结果，而且是倒序的
  • 2）myhook3 因为只有插件2实现了，所以只有一个返回结果
  • 3）myhook4 在spec中未定义，这里却也有结果，目前理解可能是pluggy的bug，待后续看源码后解释

5 HookspeckMarker装饰器支持传入一些特定的参数，当传入firstresult=True时，获取第一个plugin执行结果后就停止继续执行

import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了一个接口
    @hookspec(firstresult=True)
    def myhook(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

执行结果如下：

inside Plugin_2.myhook()
-1

6 HookImplMarker装饰器也支持传入一些特定的参数，常用的有tryfirst和trylast以及hookwrapper

  • 当传入tryfirst=True时，表示这个类的hook函数会优先执行，其他的仍然按照后进先出的顺序执行
import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了一个接口
    @hookspec
    def myhook(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl(tryfirst=True)
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2

# 定义第三个插件
class Plugin_3:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_3.myhook()")
        return arg1 - arg2+10

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
pm.register(Plugin_3())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

执行结果让如下：

inside Plugin_1.myhook()
inside Plugin_3.myhook()
inside Plugin_2.myhook()
[3, 9, -1]
  • 当传入trylast=True，表示当前插件的hook函数会尽可能晚的执行，其他的仍然按照后进先出的顺序执行
import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了一个接口
    @hookspec
    def myhook(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl()
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl(trylast=True)
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook()")
        return arg1 - arg2

# 定义第三个插件
class Plugin_3:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_3.myhook()")
        return arg1 - arg2+10

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
pm.register(Plugin_3())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

执行结果如下：

inside Plugin_3.myhook()
inside Plugin_1.myhook()
inside Plugin_2.myhook()
[9, 3, -1]
  • 当传入hookwrapper=True时，需要在这个plugin中实现一个yield，plugin先执行yield

之前的代码，然后去执行其他的pluggin，然后再回来执行yield之后的代码,同时通过yield可以
获取到其他插件执行的结果

import pluggy

# HookspecMarker 和 HookimplMarker 实质上是一个装饰器带参数的装饰器类，作用是给函数增加额外的属性设置
hookspec = pluggy.HookspecMarker("myproject")
hookimpl = pluggy.HookimplMarker("myproject")

# 定义自己的Spec，这里可以理解为定义接口类
class MySpec:
    # hookspec 是一个装饰类中的方法的装饰器，为此方法增额外的属性设置，这里myhook可以理解为定义了一个接口
    @hookspec
    def myhook(self, arg1, arg2):
        pass

# 定义了一个插件
class Plugin_1:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的和
    @hookimpl()
    def myhook(self, arg1, arg2):
        print("inside Plugin_1.myhook()")
        return arg1 + arg2

# 定义第二个插件
class Plugin_2:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl(hookwrapper=True)
    def myhook(self, arg1, arg2):
        print("inside Plugin_2.myhook() before yield...")
        output=yield
        result=output.get_result()
        print(result)
        print("inside Plugin_2.myhook() after yield...")


# 定义第三个插件
class Plugin_3:
    # 插件中实现了上面定义的接口，同样这个实现接口的方法用 hookimpl装饰器装饰，功能是返回两个参数的差
    @hookimpl
    def myhook(self, arg1, arg2):
        print("inside Plugin_3.myhook()")
        return arg1 - arg2+10

# 实例化一个插件管理的对象，注意这里的名称要与文件开头定义装饰器的时候的名称一致
pm = pluggy.PluginManager("myproject")
# 将自定义的接口类加到钩子定义中去
pm.add_hookspecs(MySpec)
# 注册定义的两个插件
pm.register(Plugin_1())
pm.register(Plugin_2())
pm.register(Plugin_3())
# 通过插件管理对象的钩子调用方法，这时候两个插件中的这个方法都会执行，而且遵循后注册先执行即LIFO的原则，两个插件的结果讲义列表的形式返回
results = pm.hook.myhook(arg1=1, arg2=2)
print(results)

执行结果如下：

inside Plugin_2.myhook() before yield...
inside Plugin_3.myhook()
inside Plugin_1.myhook()
[9, 3]
inside Plugin_2.myhook() after yield...
[9, 3]
文章标签：
前端开发
关键词：
Python模块
Python用法
Python模块用法
redrose2100
目录
相关文章
站大爷
|
5月前
|
SQL 关系型数据库 数据库
Python SQLAlchemy模块：从入门到实战的数据库操作指南
免费提供Python+PyCharm编程环境，结合SQLAlchemy ORM框架详解数据库开发。涵盖连接配置、模型定义、CRUD操作、事务控制及Alembic迁移工具，以电商订单系统为例，深入讲解高并发场景下的性能优化与最佳实践，助你高效构建数据驱动应用。
站大爷
655 7
站大爷
|
5月前
|
监控 安全 程序员
Python日志模块配置：从print到logging的优雅升级指南
从 `print` 到 `logging` 是 Python 开发的必经之路。`print` 调试简单却难维护，日志混乱、无法分级、缺乏上下文；而 `logging` 支持级别控制、多输出、结构化记录，助力项目可维护性升级。本文详解痛点、优势、迁移方案与最佳实践，助你构建专业日志系统，让程序“有记忆”。
站大爷
432 0
AI侠客
|
5月前
|
机器学习/深度学习 PyTorch 算法框架/工具
python torch基础用法
本教程系统讲解PyTorch基础，涵盖张量操作、自动求导、神经网络构建、训练流程、GPU加速及模型保存等核心内容，结合代码实例帮助初学者快速掌握深度学习开发基础，是入门PyTorch的实用指南。
AI侠客
711 6
站大爷
|
5月前
|
JSON 算法 API
Python中的json模块：从基础到进阶的实用指南
本文深入解析Python内置json模块的使用，涵盖序列化与反序列化核心函数、参数配置、中文处理、自定义对象转换及异常处理，并介绍性能优化与第三方库扩展，助你高效实现JSON数据交互。（238字）
站大爷
523 4
站大爷
|
5月前
|
Java 调度 数据库
Python threading模块：多线程编程的实战指南
本文深入讲解Python多线程编程，涵盖threading模块的核心用法：线程创建、生命周期、同步机制（锁、信号量、条件变量）、线程通信（队列）、守护线程与线程池应用。结合实战案例，如多线程下载器，帮助开发者提升程序并发性能，适用于I/O密集型任务处理。
站大爷
504 0
站大爷
|
5月前
|
XML JSON 数据处理
超越JSON：Python结构化数据处理模块全解析
本文深入解析Python中12个核心数据处理模块，涵盖csv、pandas、pickle、shelve、struct、configparser、xml、numpy、array、sqlite3和msgpack，覆盖表格处理、序列化、配置管理、科学计算等六大场景，结合真实案例与决策树，助你高效应对各类数据挑战。（238字）
站大爷
591 0
站大爷
|
6月前
|
安全 大数据 程序员
Python operator模块的methodcaller：一行代码搞定对象方法调用的黑科技
`operator.methodcaller`是Python中处理对象方法调用的高效工具，替代冗长Lambda，提升代码可读性与性能。适用于数据过滤、排序、转换等场景，支持参数传递与链式调用，是函数式编程的隐藏利器。
站大爷
209 4
爱心发电丶
|
7月前
|
Go 调度 Python
Golang协程和Python协程用法上的那些“不一样”
本文对比了 Python 和 Go 语言中协程的区别，重点分析了调度机制和执行方式的不同。Go 的协程（goroutine）由运行时自动调度，启动后立即执行；而 Python 协程需通过 await 显式调度，依赖事件循环。文中通过代码示例展示了两种协程的实际运行效果。
爱心发电丶
308 7
站大爷
|
6月前
|
存储 数据库 开发者
Python SQLite模块：轻量级数据库的实战指南
本文深入讲解Python内置sqlite3模块的实战应用，涵盖数据库连接、CRUD操作、事务管理、性能优化及高级特性，结合完整案例，助你快速掌握SQLite在小型项目中的高效使用，是Python开发者必备的轻量级数据库指南。
站大爷
526 0
francisyu
|
7月前
|
存储 安全 数据处理
Python 内置模块 collections 详解
`collections` 是 Python 内置模块，提供多种高效数据类型，如 `namedtuple`、`deque`、`Counter` 等，帮助开发者优化数据处理流程，提升代码可读性与性能，适用于复杂数据结构管理与高效操作场景。
francisyu
460 0

热门文章

最新文章

  • 1
    PyODPS 中使用 Python UDF
  • 2
    李峋同款爱心Python代码版来了
  • 3
    Python零基础学习笔记（三十八）—— 递归方法、栈、队列模拟遍历目录
  • 4
    An Introduction to Interactive Programming in Python (Part 1) -- Week 2_2 练习
  • 5
    spark-2.2.0-bin-hadoop2.6和spark-1.6.1-bin-hadoop2.6发行包自带案例全面详解（java、python、r和scala）之Basic包下的SparkPageRank.scala（图文详解）
  • 6
    Python快速学习02：基本数据类型 & 序列
  • 7
    在Python中绘制K线图，可以使用matplotlib和mplfinance库
  • 8
    [Python]学习基础篇：文件和目录
  • 9
    写给java程序员看的python快速入门教程
  • 10
    Python为图片加水印
  • 1
    字典在Python中的应用与实例
    336
  • 2
    元组（Tuple）在Python编程中的应用与实例
    941
  • 3
    Python函数：深入理解与应用
    162
  • 4
    Python中的try-except异常处理语句
    1021
  • 5
    可移植性在Python中的优势
    548
  • 6
    Python与C的联姻：探索Python的可移植性与C的底层力量
    405
  • 7
    如何选择适合的Python并行计算库
    325
  • 8
    如何优化Python代码以提高执行效率
    135
  • 9
    Python编程的深入探索与实用案例
    152
  • 10
    聊聊python多线程与多进程
    206

    • 相关课程

    更多
  • Python爬虫实战
  • Python开发基础入门
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 推荐镜像

    更多
  • python-release
    • 下一篇
    极速数仓ClickHouse步入云原生新纪元