pytest中的hook清单(上)

本文详细解读了pytest的hook机制,包括hookspec的定义、参数、调用方式以及pytest7.2版本后hook的变化。通过实例演示如何获取和分析hook执行顺序,揭示了pytest的执行流程和内部工作原理。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

本文系《pytest源码剖析》系列内容

正在连载,欢迎关注

1. 获取 pytets 所有的 hookspect

通过查看 pytest 源码让咱们知道:

pytest 的执行过程,就是一系列 hook 的调用过程

通过了解 pluggy 插件系统让咱们知道:

hookspec 决定了 hook 的调用方式和效果

hookspec 里包括了:

  • hook 名称

  • hook 参数

  • 是否快速返回结果

  • 是否支持提前调用

通过 Python 脚本来分析pytest的源码 hookspec.py 中内容,

并将得到的 hook spec保存到 pytest_hookspec_list.csv

图片

提示:

从 pytest 7.2.x 开始,pytest_cmdline_preparse 被移除,改用 pytest_load_initialconftests

故共有 52 个 hook

2. 获取 pytest 所有 hook 之间的关系

知道了 hook的spec之外,还需要搞清楚它们之间的关系,比如

  • hook执行顺序的先后关系

  • hook执行过程的调用关系

这个稍微麻烦一些,好在同样可以编写脚本来进行分析

1. 准备脚本

准备一个多目录、多文件、多用例的执行环境

.|-- a|   |-- test_a1.py|   `-- test_a2.py`-- b    |-- test_b1.py    `-- test_b2.py
import pytest


def test_c1():
    ...

def test_c2():
    assert 0
    
@pytest.mark.skip("skip")
def test_c3():
    ...
 
 # 也可增加更多类型的用例
 

2. 记录 Hook 执行过程

hook 的记录可以通过多种方式打开

  1. pluggy 提供的分析函数

  2. pytest 的 DEBUG 选项

本文使用第二种方式,执行下面的命令即可

set PYTEST_DEBUG=1pytest sanmu   2> pytest_hook_log.txt

这样 hook 的执行过程jiu就保存到了 pytest_hook_log.txt

对于简单的、独立的 hook ,内容过程结构是这样的

​​​​​​​

# Hook开始执行  # Hook参数# HookA返回值

如果在 hook A 的执行过程中调用了 hook B,结构是这样的​​​​​​​

# Hook A开始执行  # Hook A参数  	# Hook B开始执行  		# Hook B参数	# Hook B返回值# Hook A返回值

根据这些记录,咱们就可以分析出 pytest 的执行流程,进一步掌握 pytest 的核心原理,和内部细节

首发在我的公众号,转载请出处

### Pytest Hooks 的使用方法 Pytest 提供了一系列钩子(hooks),允许开发者自定义测试行为。这些钩子可以被插件或`conftest.py`文件中的函数实现来扩展功能。 #### 定义和注册 Hook 函数 为了创建一个新的 hook 或者覆盖现有的 hook,可以在项目的根目录下的 `conftest.py` 文件中定义相应的函数。例如: ```python def pytest_addoption(parser): parser.addoption("--runslow", action="store_true", help="run slow tests") ``` 这段代码向命令行接口添加了一个新的选项 `--runslow`[^2]。 #### 插入自定义逻辑到测试生命周期的不同阶段 通过实现特定名称的函数,可以在不同时间点插入自己的逻辑。比如,在所有测试完成之后打印一条消息: ```python def pytest_sessionfinish(session, exitstatus): print("*** test run reporting finishing") ``` 上述例子展示了如何在会话结束时触发某些操作[^3]。 #### 修改收集项列表 如果希望过滤掉一些不需要运行的测试案例,则可以通过重写 `pytest_collection_modifyitems` 来调整最终要被执行的项目集合: ```python import pytest def pytest_collection_modifyitems(config, items): if config.getoption("--runslow"): # --runslow given in cli: do not skip slow tests return skip_slow = pytest.mark.skip(reason="need --runslow option to run") for item in items: if "slow" in item.keywords: item.add_marker(skip_slow) ``` 此段脚本会在未指定 `--runslow` 参数的情况下跳过标记为慢速(`@pytest.mark.slow`)的测试用例。 #### 自动化网络数据抓包 对于需要在网络层面上监控通信的应用程序来说,可能还需要考虑集成像 Wireshark 这样的工具来进行流量分析。这里给出一个简单的思路——借助于 pytest hooks 和第三方库(如 Scapy),可以在每次启动/停止服务前后自动开启/关闭捕获进程[^4]: ```python @pytest.fixture(scope='module') def capture_network_traffic(): start_capture() yield stop_capture_and_save_to_file() def pytest_runtest_setup(item): """Hook that runs before each test function.""" pass # 可在此处加入额外设置 def pytest_runtest_teardown(item, nextitem): """Hook that runs after each test function completes.""" pass # 清理工作可放在这里 ``` 在这个模式下,当模块内的任何测试开始之前都会调用 `start_capture()` 方法;而在最后一个测试结束后则执行保存动作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值