插件类引用

nose2中的插件系统基于unittest2中的插件系统 plugins 分支机构。

插件基类

class nose2.events.Plugin(*args, **kwargs)

nose2插件的基类

所有nose2插件都必须子类化这个类。

session

这个 nose2.session.Session 在其中加载插件。

config

这个 nose2.config.Config 表示从会话的配置文件加载的插件的配置部分。

commandLineSwitch

一个由（短opt、长opt、帮助文本）组成的元组，用于定义激活此插件的命令行标志。短期选择可能是 None . 如果已定义，则必须是单个大写字符。短期权和长期权都必须 not 从破折号开始。

例子：：

commandLineSwitch = ('B', 'buffer-output', 'Buffer output during
tests')

configSection

要加载到此插件配置中的名称配置文件部分。

alwaysOn

如果此插件应自动注册，请将alwayson设置为 True . 默认是 False .

备注

使用配置文件中的配置值并希望使用nose2 sphinx扩展名自动生成文档的插件 must 从中提取所有配置值 self.config 在里面 __init__ . 否则，扩展将无法检测插件使用的配置键。

addArgument(callback, short_opt, long_opt, help_text=None)

添加接受一个参数的命令行选项。

参数:

• callback -- 当看到标志时运行的回调函数。回调将接收一个参数。

• short_opt -- 短期期权。必须为大写，不带破折号。

• long_opt -- 多头选择。不能以破折号开头

• help_text -- 为用户提供帮助文本，以便他们知道此标志的作用。

addFlag(callback, short_opt, long_opt, help_text=None)

添加不带参数的命令行标志

参数:

• callback -- 当看到标志时运行的回调函数。回调将接收一个空参数。

• short_opt -- 短期期权。必须为大写，不带破折号。

• long_opt -- 多头选择。不能以破折号开头

• help_text -- 为用户提供帮助文本，以便他们知道此标志的作用。

addMethods(*methods)

向hooks注册表添加新的插件方法

任何已经注册并实现此处添加的方法的插件也将为该方法注册。

addOption(callback, short_opt, long_opt, help_text=None, nargs=0)

添加命令行选项。

参数:

• callback -- 当看到标志时运行的回调函数。回调将接收一个参数。“回调”也可以是一个列表，在这种情况下，在命令行上提交的值将被附加到列表中。

• short_opt -- 短期期权。必须为大写，不带破折号。

• long_opt -- 多头选择。不能以破折号开头

• help_text -- 为用户提供帮助文本，以便他们知道此标志的作用。

• nargs -- 要从命令行使用的参数数。

register()

用适当的钩子登记。

这将激活插件并使其能够接收事件。

插件接口类

class nose2.events.PluginInterface

插件接口的定义。

此类的实例包含可以调用的方法和 nose2.events.Hook 绑定到每个方法的实例。

在插件中，PluginInterface实例通常作为self.session.hooks提供，并且可以直接对其调用插件挂钩：：

event = events.LoadFromModuleEvent(module=the_module)
self.session.hooks.loadTestsFromModule(event)

preRegistrationMethods

注册前调用的方法的元组。

methods

可用插件挂钩方法的元组。

hookClass

类为每个挂钩实例化。违约： nose2.events.Hook .

addMethod(method)

向可用方法添加方法。

这允许插件注册此方法。

参数:

method -- 方法名称

hookClass

Hook 的别名

register(method, plugin)

注册方法的插件。

参数:

• method -- 方法名称

• plugin -- 插件实例

class nose2.events.Hook(method)

插件挂钩

中的每个插件方法 nose2.events.PluginInterface 在运行时由一个钩子实例表示，该钩子实例列出了应该由该钩子调用的插件。

method

此挂钩表示的方法的名称。

plugins

绑定到此挂钩的插件实例列表。