Python?pluggy框架使用示例代碼

更新時(shí)間：2022年05月13日 12:05:07 作者：授客

這篇文章主要介紹了Python?pluggy框架基礎(chǔ)用法總結(jié),本文通過三個(gè)例子結(jié)合代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

實(shí)踐環(huán)境

Python 3.6.5

pluggy 0.13.0

例1 注冊類函數(shù)為插件函數(shù)

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import pluggy
hookspec = pluggy.HookspecMarker("myproject")  # hook 標(biāo)簽 用于標(biāo)記hook
hookimpl = pluggy.HookimplMarker("myproject")  # hook 實(shí)現(xiàn)標(biāo)簽 用于標(biāo)記hook的一個(gè)或多個(gè)實(shí)現(xiàn)
class MySpec(object):
    """hook 集合"""
    @hookspec
    def myhook(self, arg1, arg2):
        pass
    @hookspec
    def my_hook_func1(self, arg1, arg2):
        pass
    @hookspec
    def my_hook_func2(self, arg1, arg2):
        pass
# 插件類
class Plugin_1(object):
    """hook實(shí)現(xiàn)類1"""
    @hookimpl
    def myhook(self, arg1, arg2):
        print("Plugin_1.myhook called")
        return arg1 + arg2
    @hookimpl
    def my_hook_func2(self, arg1, arg2):
        print("Plugin_1.my_hook_func2 called, args:", arg1, arg2)
    def my_hook_func3(self, arg1, arg2):
        print("Plugin_1.my_hook_func3 called, args:", arg1, arg2)
class Plugin_2(object):
    """hook實(shí)現(xiàn)類2"""
    @hookimpl
    def myhook(self, arg1, arg2):
        print("Plugin_2.myhook called")
        return arg1 - arg2
    @hookimpl
    def my_hook_func2(self, arg1, arg2):
        print("Plugin_2.my_hook_func2, args:", arg1, arg2)
# 初始化 PluginManager
pm = pluggy.PluginManager("myproject")
# 登記hook集合(hook函數(shù)聲明)
pm.add_hookspecs(MySpec)
# 注冊插件(hook函數(shù)實(shí)現(xiàn))
pm.register(Plugin_1())
pm.register(Plugin_2())
# 調(diào)用自定義hook
results = pm.hook.myhook(arg1=1, arg2=2) # 調(diào)用兩個(gè)插件類中的同名hook函數(shù) # 后注冊的插件中的函數(shù)會(huì)先被調(diào)用
print(results) # 輸出 [-1, 3]
results = pm.hook.my_hook_func1(arg1="name", arg2="shouke")
print(results)
pm.hook.my_hook_func2(arg1="addr", arg2="sz")

運(yùn)行結(jié)果

Plugin_2.myhook called
Plugin_1.myhook called
[-1, 3]
[]
Plugin_2.my_hook_func2, args: addr sz
Plugin_1.my_hook_func2 called, args: addr sz

例2 注冊模塊函數(shù)為插件函數(shù)

myhookspec.py， myhookimpl.py， other.py， example.py位于同一包目錄下

myhookspec.py

import pluggy
hookspec = pluggy.HookspecMarker("myproject")  # hook 標(biāo)簽 用于標(biāo)記hook
hookimpl = pluggy.HookimplMarker("myproject")  # hook 實(shí)現(xiàn)標(biāo)簽 用于標(biāo)記hook的一個(gè)或多個(gè)實(shí)現(xiàn)
@hookspec
def global_hook_func1(arg1, arg2):
    pass

myhookimpl.py

import pluggy
from myhookspec import hookimpl
@hookimpl
def global_hook_func1(arg1, arg2):
    print("global_hook_func1 in myhookimpl.py, args:", arg1, arg2)
    return "myhookimpl.py"

other.py

from myhookspec import hookimpl
@hookimpl
def global_hook_func1(arg1, arg2):
    print("global_hook_func1 in other.py, args:", arg1, arg2)
    return "other.py"

example.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import sys
import pluggy
import myhookspec
import myhookimpl
import other
# 初始化 PluginManager
pm = pluggy.PluginManager("myproject")
# 登記hook集合
pm.add_hookspecs(myhookspec)
# 登記hook的實(shí)現(xiàn)
pm.register(myhookimpl) # 插件也可以是模塊
pm.register(other)
print(pm.hook.global_hook_func1(arg1="name", arg2="shouke"))

example.py運(yùn)行結(jié)果如下

global_hook_func1 in other.py, args: name shouke
global_hook_func1 in myhookimpl.py, args: name shouke
['other.py', 'myhookimpl.py']

例3：自定義插件類實(shí)現(xiàn)hook函數(shù)免@hookimpl裝飾器

myhookspec.py

import pluggy
hookspec = pluggy.HookspecMarker("myproject")
@hookspec
def mytest_hook_func1(arg1, arg2):
    pass

other.py

def mytest_hook_func1(arg1, arg2):
    print("global_hook_func1 in other.py, args:", arg1, arg2)
    return "other.py"

example.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import inspect
import pluggy
import myhookspec
import other
class PytestPluginManager(pluggy.PluginManager):
    """
    插件類，實(shí)現(xiàn)不用@HookimplMarkerInstance裝飾的函數(shù)也可以當(dāng)做函數(shù)體
    """
    def parse_hookimpl_opts(self, plugin, name):
        # 規(guī)定免@hookimpl裝飾的 hooks 函數(shù)總是以 mytest_打頭，這樣以避免訪問非可讀屬性
        if not name.startswith("mytest_"):
            return
        method = getattr(plugin, name)
        opts = super().parse_hookimpl_opts(plugin, name)
        # 考慮hook只能為函數(shù)(consider only actual functions for hooks)
        if not inspect.isroutine(method):
            return
        # 收集未被標(biāo)記的，以mytest打頭的hook函數(shù)，(collect unmarked hooks as long as they have the `pytest_' prefix)
        if opts is None and name.startswith("mytest_"):
            opts = {}
        return opts
# 初始化 PluginManager
pm = PytestPluginManager("myproject")
# 登記hook集合
pm.add_hookspecs(myhookspec)
# 登記hook的實(shí)現(xiàn)
pm.register(other)
pm.hook.mytest_hook_func1(arg1="addr", arg2="sz")