pytest插件探索——hook开发

更新日期: 2018-12-22阅读: 3.2k标签: Hook

前言

参考官方的这篇文章,我尝试翻译其中一些重点部分,并且拓展了相关的pluggy部分的知识。由于pytest是在pluggy基础上构建的,强烈建议先阅读一下pluggy的官方文档,这样理解起来更加容易一点。


正文

conftest.py可以作为最简单的本地plugin调用一些hook函数,以此来做些强化功能。pytest整个框架通过调用如下定义良好的hooks来实现配置,收集,执行和报告这些过程:

  • 内置plugins:从代码内部的_pytest目录加载;
  • 外部插件(第三方插件):通过setuptools entry points机制发现的第三方插件模块;
  • conftest.py形式的本地插件:测试目录下的自动模块发现机制;

原则上,每个hook都是一个 1:N 的python函数调用, 这里的 N 是对一个给定hook的所有注册调用数。所有的hook函数都使用pytest_xxx的命名规则,以便于查找并且同其他函数区分开来。


decorrator

pluggy里提供了两个decorator helper类,分别是HookspecMarkerHookimplMarker,通过使用相同的project_name参数初始化得到对应的装饰器,后续可以用这个装饰器将函数标记为hookspechookimpl


hookspec

hook specification (hookspec)用来validate每个hookimpl,保证hookimpl被正确的定义。

hookspec 通过 add_hookspecs()方法加载,一般在注册hookimpl之前先加载;


hookimpl

hook implementation (hookimpl) 是一个被恰当标记过的回调函数。hookimpls 通过register()方法加载。

注:为了保证hookspecs在项目里可以不断演化, hookspec里的参数对于hookimpls是可选的,即可以定义少于spec里定义数量的参数。

hookwrapper

hookimpl 里还有一个hookwrapper选项,用来表示这个函数是个hookwrapper函数。hookwrapper函数可以在普通的非wrapper的hookimpls执行的前后执行一些其他代码, 类似于@contextlib.contextmanagerhookwrapper必须在它的主体包含单一的yield,用来实现生成器函数,例如:

import pytest

@pytest.hookimpl(hookwrapper=True)
def pytest_pyfunc_call(pyfuncitem):
    do_something_before_next_hook_executes()

    outcome = yield
    # outcome.excinfo may be None or a (cls, val, tb) tuple

    res = outcome.get_result()  # will raise if outcome was exception

    post_process_result(res)

    outcome.force_result(new_res)  # to override the return value to the plugin system

生成器发送一个 pluggy.callers._Result对象 , 这个对象可以在 yield表达式里指定并且通过 force_result()或者get_result() 方法重写或者拿到最终结果。

注:hookwrapper不能返回结果 (跟所有的生成器函数一样);


hookimpl的调用顺序

默认情况下,hook的调用顺序遵循注册时的顺序LIFO(后进先出),hookimpl允许通过tryfirst, trylast*选项调整这一项顺序。

举个例子,对于如下的代码:

# Plugin 1
@pytest.hookimpl(tryfirst=True)
def pytest_collection_modifyitems(items):
    # will execute as early as possible
    ...


# Plugin 2
@pytest.hookimpl(trylast=True)
def pytest_collection_modifyitems(items):
    # will execute as late as possible
    ...


# Plugin 3
@pytest.hookimpl(hookwrapper=True)
def pytest_collection_modifyitems(items):
    # will execute even before the tryfirst one above!
    outcome = yield
    # will execute after all non-hookwrappers executed

执行顺序如下:

  1. Plugin3的pytest_collection_modifyitems先调用,直到yield点,因为这是一个hook warpper。
  2. Plugin1的pytest_collection_modifyitems被调用,因为有 tryfirst=True参数。
  3. Plugin2的pytest_collection_modifyitems被调用,因为有 trylast=True参数 (不过即使没有这个参数也会排在tryfirst标记的plugin后面)。
  4. Plugin3的pytest_collection_modifyitems调用yield后面的代码. yield接收非Wrapper的result返回. Wrapper函数不应该修改这个result。

当然也可以同时将 tryfirst 和 trylast与 hookwrapper=True 混用,这种情况下它将影响hookwrapper之间的调用顺序.


hook执行结果处理和firstresult选项

默认情况下,调用一个hook会使底层的hookimpl函数在一个循环里按顺序执行,并且将其非空的执行结果添加到一个list里面。例外的是,hookspec里有一个firstresult选项,如果指定这个选项为true,那么得到第一个返回非空的结果的hookimpl执行后就直接返回,后续的hookimpl将不在被执行,参考后面的例子。

注: hookwrapper还是正常的执行


hook的调用

每一个pluggy.PluginManager 都有一个hook属性, 可以通过调用这个属性的call函数来调用hook,需要注意的是,调用时必须使用关键字参数语法来调用。

请看下面这个firstresult和hook调用例子:

from pluggy import PluginManager, HookimplMarker, HookspecMarker

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


class MySpec1(object):
    @hookspec
    def myhook(self, arg1, arg2):
        pass


class MySpec2(object):
    # 这里将firstresult设置为True
    @hookspec(firstresult=True)
    def myhook(self, arg1, arg2):
        pass


class Plugin1(object):
    @hookimpl
    def myhook(self, arg1, arg2):
        """Default implementation.
        """
        return 1


class Plugin2(object):
    # hookimpl可以定义少于hookspec里定义数量的参数,这里只定义arg1
    @hookimpl
    def myhook(self, arg1):
        """Default implementation.
        """
        return 2


class Plugin3(object):
    # 同上,甚至可以不定义hookspec里的参数 
    @hookimpl
    def myhook(self):
        """Default implementation.
        """
        return 3


pm1 = PluginManager("myproject")
pm2 = PluginManager("myproject")
pm1.add_hookspecs(MySpec1)
pm2.add_hookspecs(MySpec2)
pm1.register(Plugin1())
pm1.register(Plugin2())
pm1.register(Plugin3())
pm2.register(Plugin1())
pm2.register(Plugin2())
pm2.register(Plugin3())
# hook调用必须使用关键字参数的语法
print(pm1.hook.myhook(arg1=None, arg2=None))
print(pm2.hook.myhook(arg1=None, arg2=None))

得到结果如下:

[3, 2, 1]
3

可以看到,由于pm2里的hookspec里有firstresult参数,在得到3这个非空结果时就直接返回了。


自动注册插件

除了常规的register()方法注册插件,pluggy同时提供了 load_setuptools_entrypoints()方法,允许通过 setuptools entry points 自动注册插件。


链接: https://fly63.com/article/detial/2474

分享 10 个可以使用 Vue.js 制作的有用的自定义钩hook

Vue.js 是我使用的第一个 JavaScript 框架。 我可以说 Vue.js 是我进入 JavaScript 世界的第一扇门之一。 目前,Vue.js 仍然是一个很棒的框架。 我认为有了组合 API,Vue.js 只会增长得更多

React中useState Hook 示例

到 React 16.8 目前为止,如果编写函数组件,然后遇到需要添加状态的情况,咱们就必须将组件转换为类组件。编写 class Thing extends React.Component,将函数体复制到render()方法中,修复缩进,最后添加需要的状态。

useContext Hook 是如何工作的?

所有这些新的React Hook之间都有一个宗旨:就是为了使函数组件像类组件一样强大。useContext hook 与其它几个有点不一样,但它在特定场景下还是很有用的。React 的 Context API 是一种在应用程序中深入传递数据的方法

结合React的Effect Hook分析组件副作用的清除

我们在DidMount的时候通过ID订阅了好友的在线状态,并且为了防止内存泄漏,我们需要在WillUnmount清除订阅,但是当组件已经显示在屏幕上时,friend prop 发生变化时会发生什么?

结合高阶函数聊聊useMemo和useCallback

useCallback和useMemo是其中的两个 hooks,本文旨在通过解决一个需求,结合高阶函数,深入理解useCallback和useMemo的用法和使用场景。 之所以会把这两个 hooks 放到一起说,是因为他们的主要作用都是性能优化

关于为什么使用React新特性Hook的一些实践与浅见

Hook是对函数式组件的一次增强,使得函数式组件可以做到class组件的state和生命周期。Hook的语法更加简练易懂,消除了class的生命周期方法导致的重复逻辑代码,解决了高阶组件难以理解和使用困难的问题。

React封装强业务hook的一个例子

最近因为使用列表展示的需求有点多,就想着把列表分页筛选的逻辑抽象一下。看了umi的一个useTable的hook,也不能满足业务需要,于是就自己写了一个,支持本地分页筛选和接口分页筛选。

React官方团队出手,补齐原生Hook短板

然而实际上,由于回调函数被useCallback缓存,形成闭包,所以点击的效果始终是sendMessage()。这就是「闭包陷阱」。以上代码的一种解决方式是「为useCallback增加依赖项」

实现一个自定义 React Hook:UseLocalStorageState

最近做需求,需要将数据保存到 localStorage 里,在组件初始化的时候获取,然后修改该值的时候,要保存到本地的 localStorage 中。很显然,这些逻辑完全可以封装为一个 React Hook

为什么Hook没有ErrorBoundary?

在很多全面使用Hooks开发的团队,唯一使用ClassComponent的场景就是使用ClassComponent创建ErrorBoundary。可以说,如果Hooks存在如下两个生命周期函数的替代品,就能全面抛弃ClassComponent了:

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!