如何在 Pytest 中添加日志记录

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 在Pytest中添加日志记录以辅助调试和问题排查。通过`pytest.ini`配置文件设置日志选项,如`log_cli`、`log_cli_level`等来控制日志输出。在测试用例中导入`logging`库,然后运行测试,日志将在控制台显示。若需写入日志文件,可调整`pytest.ini`相关设置,测试后将生成包含日志信息的文件。这样能更有效地理解和管理测试过程。

image.png

前言

在编写和运行测试时,对于调试和排查问题,添加日志记录是一种非常有用的技术。Pytest 是一个流行的 Python 测试框架,开发者通过pytest可以轻松地编写和运行各种测试。本文将介绍如何在 Pytest 中添加日志记录,以便更好地理解测试执行过程中的细节和问题。

pytest.ini

我们之前有介绍过pytest.ini文件的使用,可以帮助我们更加方便的执行测试用例,pytest.ini中有单独为log日志增加的一些信息,如下图:

image.png

我们可以对pytest.ini文件做出如下配置:

[pytest]
log_cli = True      
log_cli_level = INFO   
log_cli_format = %(asctime)s [%(levelname)s] | %(filename)s:%(lineno)s | %(message)s       
log_cli_date_format = %Y-%m-%d %H:%M:%S

含义如下:

  • log_cli = True :表示是否实时打开log监测,默认为False

  • log_cli_level : 表示监测log日志等级显示

  • log_cli_format: 表示输出log日志显示格式

  • log_cli_date_format: 表示显示log时间

运行用例

在我们创建了pytest.ini文件之后,在测试用例编写时,我们需要导入logging库,我们的测试用例文件内容如下:

import logging


def test_demo():
    logging.info('这是测试用例01的info...')
    logging.warning('这是测试用例01的warning...')
    logging.error('这是测试用例01的error...')
    assert 1 == 1

运行用例后,控制台输出如下:

============================= test session starts =============================
collecting ... collected 1 item

test_demo.py::test_demo 
-------------------------------- live log call --------------------------------
2024-04-09 17:15:21 [INFO] | test_demo.py:5 | 这是测试用例01的info...
2024-04-09 17:15:21 [WARNING] | test_demo.py:6 | 这是测试用例01的warning...
2024-04-09 17:15:21 [ERROR] | test_demo.py:7 | 这是测试用例01的error...
PASSED                                                                   [100%]

============== 1 passed in 0.01s ================

如果我们不满足于日志只输出在控制台,想要输出成日志文件,我们可以修改pytest.ini文件,我们可以做出如下修改:

[pytest]
log_file =pytest_log.txt
log_file_level = INFO
log_file_date_format = %Y-%m-%d %H:%M:%S
log_file_format = %(asctime)s [ %(levelname)s ] %(filename)s:%(lineno)s | %(message)s

运行测试之后,我们可以看到项目中新生成了一个日志文件,内容如下:

2024-04-09 17:18:39 [ INFO ] test_demo.py:5 | 这是测试用例01的info...
2024-04-09 17:18:39 [ WARNING ] test_demo.py:6 | 这是测试用例01的warning...
2024-04-09 17:18:39 [ ERROR ] test_demo.py:7 | 这是测试用例01的error...

总结

本文主要介绍了如何在 Pytest 中添加日志记录,以便更好地理解和调试测试代码。可以根据自己的需求进一步配置和扩展日志记录功能,从而更加有效地编写和运行测试用例。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
监控 Python
logging的基本使用教程
这篇文章提供了Python `logging` 模块的基本使用教程,包括如何配置日志级别和格式、记录不同级别的日志消息,以及如何将日志输出到文件。
|
12月前
|
安全 Linux 网络安全
Linux环境中安装和使用Paramiko
Linux环境中安装和使用Paramiko
495 12
|
6月前
|
数据可视化 测试技术 API
JMeter、Apipost 与 Postman 的 API 测试对比:为什么 APIPost 是更聪明的选择
API测试如同筹备一场晚宴,选对工具至关重要。JMeter功能强大但上手难,适合专业用户;Postman简单易用,但在复杂场景和团队协作中表现有限;而Apipost则是一款智能高效的“厨房神器”。它性能测试轻松、结果清晰、学习门槛低,并且能一键集成CI/CD流程。对于追求效率与便捷的团队而言,Apipost无疑是更优选择,让API测试如同五星大厨烹饪般丝滑流畅。
|
测试技术 开发者 Python
如何在 Pytest 中添加日志记录
在Pytest中添加日志记录可增强调试和问题排查。通过`pytest.ini`配置文件,设置`log_cli`、`log_cli_level`等参数来控制日志输出。测试用例中导入`logging`库,然后在测试函数中添加日志语句。默认日志显示在控制台,若需写入文件,可调整配置如`log_file`。这样,日志将在运行测试时按指定格式记录到控制台或文件,便于分析测试细节和错误。
|
10月前
|
数据库连接 数据库 DataX
数据接入方案
数仓平台可直连或通过从库、堡垒机、FTP/SFTP等方式接入业务数据库,需提供可读用户权限及相应连接方式。若无法直连,可通过提供数据文件或脚本处理实现数据导入。
475 7
数据接入方案
zookeeper查看版本的一些基本信息
zookeeper查看版本的一些基本信息
898 0
|
存储 算法 固态存储
CRUSH映射图及自定义规则实战篇
Ceph存储系统中CRUSH映射图及自定义规则的实战教程,涵盖了PG与OSD映射调整、CRUSH运行图修改案例以及CRUSH数据分类管理等内容。
271 1
麒麟镜像下载
【8月更文挑战第23天】这是麒麟软件官方提供的产品试用下载链接,适用于银河麒麟、中标麒麟、开放麒麟及星光麒麟等国产操作系统。访问官网选择适合您的操作系统版本进行下载。使用迅雷等工具完成下载后即可体验自主可控的麒麟操作系统。
3216 1
|
安全 Java 应用服务中间件
如何通过 Yum 在 CentOS 7 上安装 Apache Tomcat 7
如何通过 Yum 在 CentOS 7 上安装 Apache Tomcat 7
414 0