python钩子方法 python钩子函数原理

01、什么是Hook?

Hook 技术又叫做钩子函数，在系统没有调用该函数之前，钩子程序就先捕获该消息，钩子函数先得到控制权，这时钩子函数既可以加工处理（改变）该函数的执行行为，还可以强制结束消息的传递。简单来说，就是把系统的程序拉出来变成我们自己执行代码片段。

我们从“钩子”一词入手来解释，为什么叫做“钩子函数”呢？和“钩子”有什么关系？日常生活中，我们的钩子是用来钩住某种东西的，比如鱼钩是用来钓鱼的，挂钩是用来悬挂物品的。一旦被钩子钩住，那么被勾住的对象的行为我们就可以知晓并且控制。

这条鱼一旦上钩，那我们就可以掌握它的 动向，是往前游了呢，还是往后游，是挣扎呢还是躺尸呢？对于鱼的行为，我们可以“监听”，并且也可以“控制”，它要跑走我就可以一把拉送他上岸。

那我们的钩子函数也是类似的，只不过现在的鱼换成了我们的软件，而钓鱼者变成了程序员，钓鱼钩即为“Hook”。

我们编程者可以对软件设置一些Hook钩子，一旦软件发生某些行为时，就会触发我们的钩子函数 ，执行钩子函数中的逻辑。当然前提是我们的软件必须要提供这些钩子函数给外部使用。这就相当于我们对软件行为进行了监听和修改，加上了外部的一些执行逻辑，而不必去修改软件本身的代码逻辑，软件会自行去执行Hook函数中的逻辑。

02、pytest中的Hook函数

pytest自身也支持了很多的Hook函数。
官方文档地址：https://docs.pytest.org/en/latest/reference/reference.html#hooks

第一部分: setuptools

引导挂钩要求⾜够早注册的插件（内部和setuptools插件），可以使⽤的钩子

• pytest_load_initial_conftests(early_config,parser,args): 在命令⾏选项解析之前实现初始conftest⽂件的加载。
• pytest_cmdline_preparse(config,args): (不建议使⽤)在选项解析之前修改命令⾏参数。
• pytest_cmdline_parse(pluginmanager,args): 返回⼀个初始化的配置对象,解析指定的args。
• pytest_cmdline_main(config): 要求执⾏主命令⾏动作。默认实现将调⽤configure hooks和runtest_mainloop。

第二部分: 初始化钩子

初始化钩⼦需要插件和conftest.py⽂件

• pytest_addoption(parser): 注册argparse样式的选项和ini样式的配置值，这些值在测试运⾏开始时被调⽤⼀次。
• pytest_addhooks(pluginmanager): 在插件注册时调⽤，以允许通过调⽤来添加新的挂钩。
• pytest_configure(config): 许插件和conftest⽂件执⾏初始配置。
• pytest_unconfigure(config): 在退出测试过程之前调⽤。
• pytest_sessionstart(session): 在Session创建对象之后，执⾏收集并进⼊运⾏测试循环之前调⽤。
• pytest_sessionfinish(session,exitstatus): 在整个测试运⾏完成后调⽤，就在将退出状态返回系统之前。
• pytest_plugin_registered(plugin,manager):⼀个新的pytest插件已注册。

第三部分: collection钩子

• pytest_collection(session): 执⾏给定会话的收集协议。
• pytest_collect_directory(path, parent): 在遍历⽬录以获取集合⽂件之前调⽤。
• pytest_collect_file(path, parent) 为给定的路径创建⼀个收集器，如果不相关，则创建“⽆”。
• pytest_pycollect_makemodule(path: py._path.local.LocalPath, parent) 返回给定路径的模块收集器或⽆。
• pytest_pycollect_makeitem(collector: PyCollector, name: str, obj: object) 返回模块中Python对象的⾃定义项⽬/收集器，或者返回None。在第⼀个⾮⽆结果处停⽌
• pytest_generate_tests(metafunc: Metafunc) ⽣成（多个）对测试函数的参数化调⽤。
• pytest_make_parametrize_id(config: Config, val: object, argname: str) 返回val 将由@ pytest.mark.parametrize调⽤使⽤的给定⽤户友好的字符串表⽰形式，如果挂钩不知道，则返回None val。
• pytest_collection_modifyitems(session: Session, config: Config, items: List[Item]) 在执⾏收集后调⽤。可能会就地过滤或重新排序项⽬。
• pytest_collection_finish(session: Session) 在执⾏并修改收集后调⽤。

第四部分: 测试运行(runtest)钩子

• pytest_runtestloop(session: Session) 执⾏主运⾏测试循环（收集完成后）。
• pytest_runtest_protocol(item: Item, nextitem: Optional[Item]) 对单个测试项⽬执⾏运⾏测试协议。
• pytest_runtest_logstart(nodeid: str, location: Tuple[str, Optional[int], str]) 在运⾏单个项⽬的运⾏测试协议开始时调⽤。
• pytest_runtest_logfinish(nodeid: str, location: Tuple[str, Optional[int], str])在为单个项⽬运⾏测试协议结束时调⽤。
• pytest_runtest_setup(item: Item) 调⽤以执⾏测试项⽬的设置阶段。
• pytest_runtest_call(item: Item) 调⽤以运⾏测试项⽬的测试（调⽤阶段）。
• pytest_runtest_teardown(item: Item, nextitem: Optional[Item]) 调⽤以执⾏测试项⽬的拆卸阶段。
• pytest_runtest_makereport(item: Item, call: CallInfo[None]) 被称为_pytest.reports.TestReport测试项⽬的每个设置，调⽤和拆卸运行测试阶段创建一个。
• pytest_pyfunc_call(pyfuncitem: Function) 调用基础测试功能。

第五部分: Reporting 报告钩子

• pytest_collectstart(collector: Collector) 收集器开始收集。
• pytest_make_collect_report(collector: Collector) 执行collector.collect()并返回一个CollectReport。
• pytest_itemcollected(item: Item) 我们刚刚收集了一个测试项目。
• pytest_collectreport(report: CollectReport) 收集器完成收集。
• pytest_deselected(items: Sequence[Item]) 要求取消选择的测试项目，例如按关键字。
• pytest_report_header(config: Config, startdir: py._path.local.LocalPath) 返回要显示为标题信息的字符串或字符串列表，以进行终端报告。
• pytest_report_collectionfinish(config: Config, startdir: py._path.local.LocalPath, items: Sequence[Item]) 返回成功完成收集后将显示的字符串或字符串列表。
• pytest_report_teststatus(report: Union[CollectReport, TestReport], config: Config) 返回结果类别，简写形式和详细词以进行状态报告。
• pytest_terminal_summary(terminalreporter: TerminalReporter, exitstatus: ExitCode, config: Config) 在终端摘要报告中添加一个部分。
• pytest_fixture_setup(fixturedef: FixtureDef[Any], request: SubRequest) 执行夹具设置执行。
• pytest_fixture_post_finalizer(fixturedef: FixtureDef[Any], request: SubRequest) 在夹具拆除之后但在清除缓存之前调用，因此夹具结果fixturedef.cached_result仍然可用（不是 None）
• pytest_warning_captured(warning_message: warnings.WarningMessage, when: Literal[‘config’, ‘collect’, ‘runtest’], item: Optional[Item], location: Optional[Tuple[str, int, str]]) （已弃用）处理内部pytest警告插件捕获的警告。
• pytest_warning_recorded(warning_message: warnings.WarningMessage, when: Literal[‘config’, ‘collect’, ‘runtest’], nodeid: str, location: Optional[Tuple[str, int, str]]) 处理内部pytest警告插件捕获的警告。
• pytest_runtest_logreport(report: TestReport) 处理项目的_pytest.reports.TestReport每个设置，调用和拆卸运行测试阶段产生的结果。
• pytest_assertrepr_compare(config: Config, op: str, left: object, right: object) 返回失败断言表达式中的比较的说明。
• pytest_assertion_pass(item: Item, lineno: int, orig: str, expl: str) （实验性的）在断言通过时调用。

第六部分: 调试/相互作用钩

• pytest_internalerror(excrepr: ExceptionRepr, excinfo: ExceptionInfo[BaseException]) 要求内部错误。返回True以禁止对将INTERNALERROR消息直接打印到sys.stderr的回退处理。
• pytest_keyboard_interrupt(excinfo: ExceptionInfo[Union[KeyboardInterrupt, Exit]]) 要求键盘中断。
• pytest_exception_interact(node: Union[Item, Collector], call: CallInfo[Any], report: Union[CollectReport, TestReport]) 在引发可能可以交互处理的异常时调用。
• pytest_enter_pdb(config: Config, pdb: pdb.Pdb) 调用了pdb.set_trace（）。

03、Hook函数实践

1. 修改pytest中文乱码

# conftest.py文件

def pytest_collection_modifyitems(
        session: "Session", config: "Config", items: List["Item"]
) -> None:
    # item表示每个测试用例，解决用例名称中文显示问题
    for item in items:
        item.name = item.name.encode("utf-8").decode("unicode-escape")
        item._nodeid = item._nodeid.encode("utf-8").decode("unicode-escape")

2. 获取pytest执行结果

# conftest.py文件 

@pytest.hookimpl(hookwrapper=True, tryfirst=True)
def pytest_runtest_makereport(item, call):
    print('------------------------------------')

    # 获取钩子方法的调用结果
    out = yield
    print('用例执行结果', out)

    # 3. 从钩子方法的调用结果中获取测试报告
    report = out.get_result()

    print('测试报告：%s' % report)
    print('步骤：%s' % report.when)
    print('nodeid：%s' % report.nodeid)
    print('description:%s' % str(item.function.__doc__))
    print(('运行结果: %s' % report.outcome))

运行测试后，控制台打印：

3. 参数化测试用例

# test_py.py文件

import pytest  # 导入pytest


test_data = [{"test_input": "3+5",
              "expected": 8,
              "id": "验证3+5=8"
              },
             {"test_input": "2+4",
              "expected": 6,
              "id": "验证2+4=6"
              },
             {"test_input": "6 * 9",
              "expected": 42,
              "id": "验证6*9=42"
              }
             ]


def pytest_generate_tests(metafunc):
    ids = []
    if "parameters" in metafunc.fixturenames:
        for data in test_data:  # 用test_data中的id作为测试用例名称
            ids.append(data['id'])
        metafunc.parametrize("parameters", test_data, ids=ids, scope="function")  # 用test_data这个列表对parameters进行参数化。


def test_eval（parameters):
    assert eval（parameters['test_input']) == parameters['expected']


if __name__ == '__main__':  # 定义主函数
    pytest.main()

执行结果：

这里注意一下，我们没有在conftest.py中使用，那其实也是可以的，只不过这个Hook并不是全局生效，而是局部生效，也就是其他的测试文件并不共享。