事件引用

class nose2.events.CommandLineArgsEvent(args, **kw)[源代码]

分析命令行参数后激发的事件。

插件可以通过配置自己或其他插件或修改解析的参数来响应此事件。

备注

许多插件通过回调注册选项。当此事件触发时，这些回调已经触发。因此，您不能使用此事件来可靠地影响所有插件。

args: argParse返回的args对象。

class nose2.events.CreateTestsEvent(loader, testNames, module, **kw)[源代码]

测试加载前激发的事件。

插件可以通过返回测试套件并设置 handled 在这个事件上。

loader: 测试加载程序实例

names: 测试名称列表。可能是空的或 None .

module: 要从中加载的模块。可能是 None . 如果没有 None ，名称应视为相对于此模块。

class nose2.events.CreatedTestSuiteEvent(suite, **kw)[源代码]

测试加载后激发的事件。

插件可以通过返回测试套件并设置 handled 在这个事件上。

suite: 测试套件实例

class nose2.events.DescribeTestEvent(test, description=None, errorList=False, **kw)[源代码]

激发事件以获取测试描述。

test: 测试用例

description: 测试用例的描述。插件可以设置它来更改测试在输出中如何描述给用户。

errorList: 事件是否作为错误列表输出的一部分激发？

class nose2.events.Event(**metadata)[源代码]

所有事件的基类。

metadata: 存储附加到事件的任意信息。

handled: 设置为 True 表明插件已经处理了事件，其他插件或核心系统不应该进一步处理它。

version: 事件API的版本。这将随着更改API的每个nose2版本的增加而增加。

version = '0.4'

class nose2.events.GetTestCaseNamesEvent(loader, testCase, isTestMethod, **kw)[源代码]

为在测试用例中查找测试用例名称而激发的事件。

插件可能返回名称列表并设置 handled 在此事件上强制选择测试用例名称。

loader: 测试加载程序实例

testCase: 这个 unittest.TestCase 正在加载实例。

testMethodPrefix: 设置此选项可更改测试方法前缀。除非由插件设置，否则 None .

extraNames: 要从测试用例加载的额外测试名称列表。若要从测试用例中加载额外的测试，请将名称附加到此列表中。注意这里的名称必须是测试用例的属性。

excludedNames: 要从测试加载中排除的名称列表。将名称添加到此列表以阻止其他插件加载命名测试。

isTestMethod: 可调用插件可以用来检查测试用例属性，以确定nose2是否认为它们是测试方法。

class nose2.events.HandleFileEvent(loader, name, path, pattern, topLevelDirectory, **kw)[源代码]

检查非测试文件时激发的事件。

备注

此事件针对所有已处理的python文件和模块（包括但不限于与测试文件模式匹配的文件和模块）激发。

loader: 测试加载程序实例

name: 文件基名称

path: 文件的完整路径

pattern: 当前测试文件匹配模式

topLevelDirectory: 测试运行的顶级目录

extraTests: 从文件加载的额外测试的列表。要从文件加载测试而不干扰其他插件的加载活动，请将测试附加到Extratests。

可设置插件 handled 并返回一个测试套件，以防止其他插件从文件加载测试。如果有插件集 handled 到 True ， extraTests 将被忽略。

class nose2.events.LoadFromModuleEvent(loader, module, **kw)[源代码]

加载测试模块时激发的事件。

loader: 测试加载程序实例

module: 要加载其测试的模块

extraTests: 从模块加载的额外测试的列表。要在不干扰其他插件加载活动的情况下从模块加载测试，请将测试附加到外部测试。

可设置插件 handled 在此事件上，返回一个测试套件，以防止其他插件从模块加载测试。如果有插件集 handled 到 True ， extraTests 将被忽略。

class nose2.events.LoadFromNameEvent(loader, name, module, **kw)[源代码]

激发事件以从测试名称加载测试。

loader: 测试加载程序实例

name: 要加载的测试名称

module: 要从中加载的模块。可能是 None . 如果没有 None ，名称应视为相对于此模块。

extraTests: 从名称加载的额外测试的列表。要从测试名称加载测试而不干扰其他插件的加载活动，请将测试附加到外部测试。

可设置插件 handled 并返回一个测试套件，以防止其他插件从测试名称加载测试。如果有插件集 handled 到 True ， extraTests 将被忽略。

class nose2.events.LoadFromNamesEvent(loader, names, module, **kw)[源代码]

激发事件以从测试名称加载测试。

loader: 测试加载程序实例

names: 测试名称列表。可能是空的或 None .

module: 要从中加载的模块。可能是 None . 如果没有 None ，名称应视为相对于此模块。

extraTests: 从名为的测试中加载的额外测试的列表。要从测试名称加载测试而不干扰其他插件的加载活动，请将测试附加到外部测试。

可设置插件 handled 并返回一个测试套件，以防止其他插件从测试名称加载测试。如果有插件集 handled 到 True ， extraTests 将被忽略。

class nose2.events.LoadFromTestCaseEvent(loader, testCase, **kw)[源代码]

从测试用例加载测试时激发的事件。

loader: 测试加载程序实例

testCase: 这个 unittest.TestCase 正在加载实例。

extraTests: 从模块加载的额外测试的列表。要在不干扰其他插件加载活动的情况下从测试用例加载测试，请将测试附加到外部测试。

可设置插件 handled 在这个事件上，返回一个测试套件，以防止其他插件从测试用例加载测试。如果有插件集 handled 到 True ， extraTests 将被忽略。

class nose2.events.MatchPathEvent(name, path, pattern, **kw)[源代码]

文件匹配期间激发的事件。

插件可能会返回 False 并设置 handled 在此事件上，以防止文件与测试文件匹配，而不考虑其他系统设置。

path: 文件的完整路径

name: 文件基名称

pattern: 当前测试文件匹配模式

class nose2.events.ModuleSuiteEvent(loader, module, suite, **kw)[源代码]

class nose2.events.OutcomeDetailEvent(outcomeEvent, **kw)[源代码]

激发事件以获取有关测试结果的其他详细信息。

outcomeEvent: A nose2.events.TestOutcomeEvent 保存要描述的测试结果的实例。

extraDetail: 附加到测试结果输出的额外细节行。插件可以将行（字符串）附加到此列表，以便在错误列表报告中包含它们的额外信息。

class nose2.events.PluginsLoadedEvent(pluginsLoaded, **kw)[源代码]

在加载所有插件类后激发的事件。

pluginsLoaded: 所有加载插件类的列表

class nose2.events.ReportSummaryEvent(stopTestEvent, stream, reportCategories, **kw)[源代码]

摘要报告前后激发的事件。

stopTestEvent: A nose2.events.StopTestEvent 实例。

stream: 输出流。插件可以将其设置为更改或捕获输出。

reportCategories: 报告类别和该类别中捕获的测试事件的字典。默认类别包括“错误”、“失败”、“跳过”、“预期失败”和“未预期成功”。插件可以添加自己的类别。

class nose2.events.ReportTestEvent(testEvent, stream, **kw)[源代码]

激发事件以报告测试事件。

插件可以通过为用户生成输出来响应此事件。

testEvent: 测试事件。在大多数情况下， nose2.events.TestOutcomeEvent 实例。对于starttest，a nose2.events.StartTestEvent 实例。

stream: 输出流。插件可以将其设置为更改或捕获输出。

class nose2.events.ResultCreatedEvent(result, **kw)[源代码]

创建测试结果处理程序时激发的事件。

result: 测试结果处理程序实例。插件可以通过将此属性设置为新的测试结果实例来替换测试结果。

class nose2.events.ResultStopEvent(result, shouldStop, **kw)[源代码]

当通知测试运行停止时激发的事件。

插件可以使用此事件阻止其他插件停止测试运行。

result: 测试结果

shouldStop: 设置为 True 指示测试运行应停止。

class nose2.events.ResultSuccessEvent(result, success, **kw)[源代码]

在测试运行结束时激发的事件以确定成功。

此事件在测试运行结束时激发，并允许插件确定测试运行是否成功。

result: 测试结果

success: 设置为 True 以指示测试运行成功。如果没有插件设置 success 到 True ，测试运行失败。应初始化为 None 指示状态尚未设置（这样插件就可以始终区分先前钩子中的显式失败和尚未设置的未通过/失败状态）。

class nose2.events.RunnerCreatedEvent(runner, **kw)[源代码]

创建测试运行程序时激发的事件。

runner: 测试运行程序实例。插件可以通过将此属性设置为新的测试运行程序实例来替换测试运行程序。

class nose2.events.StartLayerSetupEvent(layer, **kw)[源代码]

在运行层设置之前激发的事件。

layer: 安装程序将要运行的当前层实例。

class nose2.events.StartLayerSetupTestEvent(layer, test, **kw)[源代码]

在层中的测试用例设置之前激发的事件。

layer: 当前层实例。

test: 安装程序将要运行的测试实例。

class nose2.events.StartLayerTeardownEvent(layer, **kw)[源代码]

在运行层拆卸之前激发的事件。

layer: 当前层实例，即将对其运行TearDown。

class nose2.events.StartLayerTeardownTestEvent(layer, test, **kw)[源代码]

在层中的测试用例分解之前激发的事件。

layer: 当前层实例。

test: 即将运行TearDown的测试实例。

class nose2.events.StartTestEvent(test, result, startTime, **kw)[源代码]

在执行测试之前激发的事件。

test: 测试用例

result: 测试结果

startTime: 测试开始时间戳

class nose2.events.StartTestRunEvent(runner, suite, result, startTime, executeTests, **kw)[源代码]

测试运行即将开始时激发的事件。

测试收集在此事件激发之前完成，但尚未执行任何测试。

runner: 试验转轮

suite: 要执行的顶级测试套件。插件可以过滤这个套件，或者设置event.suite来更改执行的测试（或者它们的执行方式）。

result: 测试结果

startTime: 测试运行开始时间戳

executeTests

将用于执行测试的可调用。插件可以将此属性设置为包装或以其他方式更改测试执行。可调用文件必须与签名匹配：

def execute(suite, result):
    ...

为了防止正常的测试执行，插件可以设置 handled 在这个活动上 True . 什么时候？ handled 是真的，测试执行器根本不运行。

class nose2.events.StopLayerSetupEvent(layer, **kw)[源代码]

运行层设置后激发的事件。

layer: 当前层实例，其安装程序刚刚运行。

class nose2.events.StopLayerSetupTestEvent(layer, test, **kw)[源代码]

在层中设置测试用例后激发的事件。

layer: 当前层实例。

test: 刚刚完成安装的测试实例。

class nose2.events.StopLayerTeardownEvent(layer, **kw)[源代码]

运行层拆卸后激发的事件。

layer: 当前层实例，其Teardown刚刚运行。

class nose2.events.StopLayerTeardownTestEvent(layer, test, **kw)[源代码]

在层中的测试用例分解后激发的事件。

layer: 当前层实例。

test: 刚刚运行Teardown的测试实例。

class nose2.events.StopTestEvent(test, result, stopTime, **kw)[源代码]

执行测试后激发的事件。

test: 测试用例

result: 测试结果

stopTime: 测试停止时间戳

class nose2.events.StopTestRunEvent(runner, result, stopTime, timeTaken, **kw)[源代码]

测试运行停止时激发的事件。

runner: 试验转轮

result: 测试结果

stopTime: 测试运行停止时间戳

timeTaken: 执行测试运行所用的秒数

class nose2.events.TestOutcomeEvent(test, result, outcome, exc_info=None, reason=None, expected=False, shortLabel=None, longLabel=None, **kw)[源代码]

测试完成时激发的事件。

test: 测试用例

result: 测试结果

outcome: 测试结果说明。通常是“error”、“ailed”、“skiped”、“pass”或“subtest”中的一个。

exc_info: 如果测试导致异常，则返回的（异常类、异常值、回溯）元组 sys.exc_info() . 如果测试没有导致异常， None .

reason: 对于包含原因的测试结果 (Skips 例如）原因。

expected: 布尔值，指示测试结果是否为预期结果。一般来说，所有的测试都将通过，任何其他的结果都将预期为 False . 该规则的例外是意外的成功和预期的失败。

shortLabel: 描述测试结果的简短标签。（例如，“e”表示错误）。

longLabel: 描述测试结果的长标签（例如，“错误”表示错误）。

插件可能通过设置 outcome 或 exc_info 或 expected . 它们可能通过设置 shortLabel 或 longLabel .

class nose2.events.UserInteractionEvent(**kw)[源代码]

用户交互前后激发的事件。

捕获stdout或以其他方式阻止用户交互的插件应该响应此事件。

为了防止发生用户交互，返回 False 并设置 handled . 否则，关闭你正在做的任何阻止用户输入/点击/触摸/心灵感应/任何东西的操作。