接口自动化（五）-框架意识-封装logging

自动化意识演变（五）-封装logging

使用logging模块的背景

在代码写完之后我们经常会进行debug调试通过打印print进行调试时，对于轻量级项目还行，重量级项目就显得繁琐日志可以回溯失败原因，尤其是依赖型接口上尤其重要收集日志进行统计，生成系列可视化报告

关于logging

Python的logging模块提供了通用的日志系统，可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别，并可以采用不同的方式记录日志，比如文件，HTTP GET/POST，SMTP，Socket等，甚至可以自己实现具体的日志记录方式。 logging模块与log4j的机制是一样的，只是具体的实现细节不同。模块提供logger，handler，filter，formatter。

logger：提供日志接口，供应用代码使用。logger最长用的操作有两类：配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象，如果不指定name则返回root对象，多次使用相同的name调用getLogger方法返回同一个logger对象。

handler：将日志记录（log record）发送到合适的目的地（destination），比如文件，socket等。一个logger对象可以通过addHandler方法添加0到多个handler，每个handler又可以定义不同日志级别，以实现日志分级过滤显示。

filter：提供一种优雅的方式决定一个日志记录是否发送到handler。

formatter：指定日志记录输出的具体格式。formatter的构造方法需要两个参数：消息的格式字符串和日期字符串，这两个参数都是可选的。

logging用法解析

初始化 logger = logging.getLogger(“endlesscode”)，getLogger()方法后面最好加上所要日志记录的模块名字，后面的日志格式中的%(name)s 对应的是这里的模块名字

设置级别 logger.setLevel(logging.DEBUG),Logging中有NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL这几种级别，日志会记录设置级别以上的日志

Handler，常用的是StreamHandler和FileHandler，windows下你可以简单理解为一个是console和文件日志，一个打印在CMD窗口上，一个记录在一个文件上

formatter，定义了最终log信息的顺序,结构和内容，格式 ‘[(asctime)s] [%(levelname)s] %(message)s’ %(name)s Logger的名字 %(levelname)s 文本形式的日志级别 %(message)s 用户输出的消息 %(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒 %(levelno)s 数字形式的日志级别 %(pathname)s 调用日志输出函数的模块的完整路径名，可能没有 %(filename)s 调用日志输出函数的模块的文件名 %(module)s 调用日志输出函数的模块名 %(funcName)s 调用日志输出函数的函数名 %(lineno)d 调用日志输出函数的语句所在的代码行 %(created)f 当前时间，用UNIX标准的表示时间的浮 点数表示 %(relativeCreated)d 输出日志信息时的，自Logger创建以 来的毫秒数 %(thread)d 线程ID。可能没有 %(threadName)s 线程名。可能没有 %(process)d 进程ID。可能没有

记录 使用object.debug(message)来记录日志

logging应用到实例中

from core.configHandle import ConfigHandle from core.requestHandle import RequestHandle import logging #生成logging新对象 log=logging.getLogger('TestTruck') #设置debug级别 log.setLevel(logging.DEBUG) #将日志打印到文件里面 file_log=logging.FileHandler('test.log') file_log.setLevel(logging.DEBUG) #将日志打印在cmd窗口上 cmd_log=logging.StreamHandler() cmd_log.setLevel(logging.ERROR) #设置日志格式 formatter=logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") file_log.setFormatter(formatter) cmd_log.setFormatter(formatter) #将相应的handle添加到logger对象中 log.addHandler(file_log) log.addHandler(cmd_log) class TestTruck(object): def setup_class(self): self.config = ConfigHandle() self.token = self.config.get_value('user', 'token') def test_getInfo(self): path = "/x/tree-game/truck/get-info?token=%s" % self.token payload = {} response = RequestHandle(path, payload).get() log.debug(response) code = response['code'] assert code == 0

输出的结果如下：

2020-09-03 11:36:32,353 - TestTruck - DEBUG - {'code': 0, 'message': '成功', 'showErr': 0, 'currentTime': 1599104192, 'data': {'plant_num': 0, 'left_time': 0, 'coin_num_min': 0, 'coin_num_max': 0}}

从上述实例看到，如果每个case都需要接日志的话，这时就需要将logging封装了。然后case只需要给对应的场景设计日志 新建文件loggingHandle.py封装：

import logging import os class LoggingHandle: def __init__(self, name): root_path = os.path.abspath(os.getcwd()) # 查找目录 file_path = os.path.join(root_path, 'log', 'test.log') print(file_path) if not os.path.exists(file_path): os.mkdir(file_path) # 生成logging新对象 self.log = logging.getLogger(name) # 设置debug级别 self.log.setLevel(logging.DEBUG) # 将日志打印到文件里面 file_log = logging.FileHandler(file_path) file_log.setLevel(logging.DEBUG) # 将日志打印在cmd窗口上 # cmd_log=logging.StreamHandler() # cmd_log.setLevel(logging.ERROR) # 设置日志格式 formatter = logging.Formatter( "%(asctime)s - %(name)s - %(levelname)s - %(message)s") file_log.setFormatter(formatter) # cmd_log.setFormatter(formatter) # 将相应的handle添加到logger对象中 self.log.addHandler(file_log) # log.addHandler(cmd_log) def debug(self, message): self.log.debug(message) def info(self, message): self.log.info(message) def warn(self, message): self.log.info(message) def error(self, message): self.log.info(message)

然后编写case时只需要调用LoggingHandle就行，代码如下：

from core.configHandle import ConfigHandle from core.requestHandle import RequestHandle from core.loggingHandle import LoggingHandle log=LoggingHandle('TestTruck') class TestTruck(object): def setup_class(self): self.config = ConfigHandle() self.token = self.config.get_value('user', 'token') def test_getInfo(self): path = "/x/tree-game/truck/get-info?token=%s" % self.token payload = {} response = RequestHandle(path, payload).get() log.debug(response) code = response['code'] assert code == 0

这样，每个case只需要关心如何设计用例就行