pytest教程-43-钩子函数-pytest_report_header

2024-05-09 22:52

本文主要是介绍pytest教程-43-钩子函数-pytest_report_header,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

领取资料,咨询答疑,请➕wei:  June__Go

上一小节我们学习了pytest_runtest_makereport钩子函数的使用方法,本小节我们讲解一下pytest_report_header钩子函数的使用方法。

pytest_report_header 钩子函数允许你在 pytest 的终端报告的头部添加自定义信息。这个钩子在生成报告时被调用,通常用于显示测试环境的配置信息、版本信息或其他重要的上下文信息。

以下是一个具体的代码示例,展示了如何在 conftest.py 文件中使用 pytest_report_header 钩子函数:

# conftest.pyimport pytestdef pytest_report_header(config):# 获取 pytest 配置信息env = config.get('env', {})version = env.get('MY_APP_VERSION', 'unknown')platform = env.get('MY_PLATFORM', 'unknown')# 创建自定义的报告头部信息header_info = (f"Testing Environment:\n"f"  Application Version: {version}\n"f"  Platform: {platform}\n"f"  Start Time: {time.ctime()}\n")# 返回自定义的报告头部信息return header_info# 你可以在 pytest.ini 文件中设置环境变量,例如:
# [pytest]
# env = MY_APP_VERSION=1.0.0
# env = MY_PLATFORM=development

在这个示例中,我们首先从 config 对象中获取环境变量,这些环境变量包含了应用版本和平台信息。然后,我们创建了一个包含这些信息的字符串,作为自定义的报告头部信息。最后,我们返回这个字符串,它将在 pytest 的终端报告头部显示。

请注意,为了使这个示例工作,你需要在 pytest.ini 文件中设置相应的环境变量,或者在命令行中使用 --env 参数来设置它们。这样,当你运行测试时,pytest_report_header 钩子函数就会读取这些环境变量,并在报告头部显示相应的信息。

这个示例展示了如何使用 pytest_report_header 钩子函数来增强 pytest 的报告,使其包含更多关于测试环境的信息。在实际应用中,你可以根据需要添加或修改头部信息的内容。

在这个更复杂的示例中,我们将使用 pytest_report_header 钩子函数来展示如何集成多个源的信息,包括环境变量、系统信息和自定义的测试统计数据。我们将在 pytest 的报告头部显示这些信息,以便为测试提供更多的上下文。

首先,确保你的项目中有一个 conftest.py 文件。然后,在 conftest.py 文件中定义 pytest_report_header 钩子函数:

# conftest.pyimport pytest
import os
import platform
import time
from collections import defaultdict# 假设我们有一个自定义的统计器来跟踪测试结果
class TestStatistics:def __init__(self):self.passed = 0self.failed = 0self.skipped = 0def increment(self, result):if result == "passed":self.passed += 1elif result == "failed":self.failed += 1elif result == "skipped":self.skipped += 1def summary(self):return {"passed": self.passed,"failed": self.failed,"skipped": self.skipped}# 全局统计器实例
test_statistics = TestStatistics()def pytest_runtest_logreport(report):# 更新测试统计数据if report.passed:test_statistics.increment("passed")elif report.failed:test_statistics.increment("failed")elif report.skipped:test_statistics.increment("skipped")def pytest_report_header(config):# 获取系统信息system_info = platform.platform()# 获取环境变量env_vars = ", ".join([f"{key}={value}" for key, value in os.environ.items() if key.startswith('TEST_')])# 获取自定义的测试统计数据stats_summary = test_statistics.summary()# 创建自定义的报告头部信息header_info = (f"Testing Report Header\n"f"System: {system_info}\n"f"Environment Variables: {env_vars}\n"f"Test Statistics:\n"f"   Passed: {stats_summary['passed']}\n"f"   Failed: {stats_summary['failed']}\n"f"   Skipped: {stats_summary['skipped']}\n"f"   Total: {stats_summary['passed'] + stats_summary['failed'] + stats_summary['skipped']}\n"f"Start Time: {time.ctime()}\n")# 返回自定义的报告头部信息return header_info# 在 pytest 运行结束时重置统计器
def pytest_sessionfinish(session, exitstatus):test_statistics = TestStatistics()

在这个示例中,我们首先定义了一个 TestStatistics 类来跟踪测试结果。在每个测试用例执行后,我们通过 pytest_runtest_logreport 钩子函数更新统计数据。

然后,在 pytest_report_header 钩子函数中,我们收集了系统信息、环境变量和自定义的测试统计数据。我们将这些信息组合成一个多行字符串,作为报告的头部信息。这个字符串包含了系统平台、环境变量、测试统计数据和测试开始时间。

请注意,为了使这个示例工作,你需要在 pytest.ini 文件中设置相应的环境变量,或者在命令行中使用 --env 参数来设置它们。此外,你可能需要在测试运行结束后重置统计器,以避免在连续运行多个测试时统计数据相互干扰。

这个示例展示了如何使用 pytest_report_header 钩子函数来创建一个包含丰富信息的测试报告头部。在实际应用中,你可以根据需要添加或修改头部信息的内容,以及如何集成和展示测试统计数据。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走,希望可以帮助到大家!领取资料,咨询答疑,请➕wei:  June__Go

这篇关于pytest教程-43-钩子函数-pytest_report_header的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/974733

相关文章

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

MySQL 中的 CAST 函数详解及常见用法

《MySQL中的CAST函数详解及常见用法》CAST函数是MySQL中用于数据类型转换的重要函数,它允许你将一个值从一种数据类型转换为另一种数据类型,本文给大家介绍MySQL中的CAST... 目录mysql 中的 CAST 函数详解一、基本语法二、支持的数据类型三、常见用法示例1. 字符串转数字2. 数字

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客

Python函数作用域示例详解

《Python函数作用域示例详解》本文介绍了Python中的LEGB作用域规则,详细解析了变量查找的四个层级,通过具体代码示例,展示了各层级的变量访问规则和特性,对python函数作用域相关知识感兴趣... 目录一、LEGB 规则二、作用域实例2.1 局部作用域(Local)2.2 闭包作用域(Enclos

MySQL count()聚合函数详解

《MySQLcount()聚合函数详解》MySQL中的COUNT()函数,它是SQL中最常用的聚合函数之一,用于计算表中符合特定条件的行数,本文给大家介绍MySQLcount()聚合函数,感兴趣的朋... 目录核心功能语法形式重要特性与行为如何选择使用哪种形式?总结深入剖析一下 mysql 中的 COUNT

MySQL 中 ROW_NUMBER() 函数最佳实践

《MySQL中ROW_NUMBER()函数最佳实践》MySQL中ROW_NUMBER()函数,作为窗口函数为每行分配唯一连续序号,区别于RANK()和DENSE_RANK(),特别适合分页、去重... 目录mysql 中 ROW_NUMBER() 函数详解一、基础语法二、核心特点三、典型应用场景1. 数据分

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

深度解析Spring AOP @Aspect 原理、实战与最佳实践教程

《深度解析SpringAOP@Aspect原理、实战与最佳实践教程》文章系统讲解了SpringAOP核心概念、实现方式及原理,涵盖横切关注点分离、代理机制(JDK/CGLIB)、切入点类型、性能... 目录1. @ASPect 核心概念1.1 AOP 编程范式1.2 @Aspect 关键特性2. 完整代码实

Python get()函数用法案例详解

《Pythonget()函数用法案例详解》在Python中,get()是字典(dict)类型的内置方法,用于安全地获取字典中指定键对应的值,它的核心作用是避免因访问不存在的键而引发KeyError错... 目录简介基本语法一、用法二、案例:安全访问未知键三、案例:配置参数默认值简介python是一种高级编

python 常见数学公式函数使用详解(最新推荐)

《python常见数学公式函数使用详解(最新推荐)》文章介绍了Python的数学计算工具,涵盖内置函数、math/cmath标准库及numpy/scipy/sympy第三方库,支持从基础算术到复杂数... 目录python 数学公式与函数大全1. 基本数学运算1.1 算术运算1.2 分数与小数2. 数学函数