一、什么是钩子函数
钩子函数在 pytest 称之为 Hook 函数,它 pytest 框架的开发者,为了让用户更好的去扩展开发预留的一些函数。而预留的这些函数,在整个测试执行的生命周期中特定的阶段会自动去调用执行。如下图:
关于 pytest 中的预留钩子,可以通过开发插件,和在 conftest.py 去实现这些钩子。每个钩子函数可以在多个插件中实现,每个钩子和执行的函数比是:1:N。pytest 中的钩子函数按功能一共分为 6 类:引导钩子,初始化钩子、用例收集钩子、用例执行钩子、报告钩子、调试钩子,本文主要给大家介绍引导钩子和初始化钩子。
二、引导钩子
引导钩子调用足够早,主要作用是用来解析命令和注册插件(内部插件和 setuptools 插件)。
1、pytest_load_initial_conftests
参数:
early_config:pytest 配置对象。
args:命令行上传递的参数。
parser:命令行添加的选项。
触发时机:
当在命令行通过 pytest 执行命令时,会先执行该钩子函数
默认作用:
加载 conftest.py 文件
注意点:
该钩子函数只有定义在插件中才会调用,在 conftest 定义则不会调用
2、pytest_cmdline_main
**触发时机:**执行运行主命令后执行默认作用:
调用命令解析钩子 pytest_cmdline_parse 和执行 runtest_mainloop
参数
config:pytest 配置对象
3、pytest_cmdline_parse
参数
args:命令行上传递的参数。
pluginmanager :插件管理器
默认作用:
用来初始化配置对象,解析指定的参数
注意点:
该钩子函数只有定义在插件中才会调用,在 conftest 定义则不会调用
三、初始化钩子
初始化钩子用来调用插件和conftest.py文件的初始化
1、pytest_addoption
参数
parser :参数解析器
pluginmanager :插件管理器
触发时机:
conftest 文件加载完之后执行, 在测试运行开始时调用一次。
作用:
添加运行命令的命令行参数,pytest.ini 的配置参数
Demo:
# 添加一个运行参数:--name
def pytest_addoption(parser,pluginmanager ):
parser.addoption(
"--name",
action="store",
dest="name",
default="World",
help='参数的帮助提示信息',
)
# 添加一个ini文件的配置项
def pytest_addoption(parser,pluginmanager ):
parser.addini(
"name",
help='参数的帮助提示信息',
type="string",
default="musen",
)
2、pytest_configure
参数
config:pytest 配置对象
触发时机:
在解析命令行选项后,每个插件和初始 conftest 文件都会调用此钩子,
在导入其他 conftest 文件时调用该钩子。
默认作用:
允许插件和 conftest 文件执行初始配置。
3、pytest_unconfigure
参数
config:pytest 配置对象
触发时机:
在退出测试过程之前调用
4、pytest_sessionstart
参数
session:pytest 会话对象
触发时机:
在创建 Session 对象之后、执行收集测试用例之前调用
5、pytest_sessionfinish
参数
session:pytest 会话对象
exitstatus:pytest 将返回系统的状态
触发时机:
在整个测试运行完成后调用,就在将退出状态返回给系统之前
6、pytest_plugin_registered
参数
plugin :插件模块或实例
manager :pytest 插件管理器
作用:
注册一个新的插件
7、pytest_addhooks
参数
pluginmanager :插件管理器
触发时机:
注册插件时调用,添加钩子函数到执行列表
默认作用:
调用 pluginmanager.add_hookspecs(module_or_class, prefix) 注册插件
房子要一层一层盖,知识要一点一点学。大家在学习过程中要好基础,多上手实操,话不多说,这里狠狠上一次干货!我熬夜整理好的各阶段(功能、接口、自动化、性能、测开)技能学习资料+实操讲解,非常适合私下里学习,比找资料自学高效多了,分享给你们。
领取关 w/x/g/z/h:软件测试小dao
敲字不易,如果此文章对你有帮助的话,点个赞收个藏来个关注,给作者一个鼓励。也方便你下次能够快速查找。