Log日志
-
优点:记录程序运行信息,方便定位问题
-
python日志模块logging,日志等级如下:
- DEBUG
- INFO(正常)
- WARNING
- ERROR(报错)
-
示例代码如下:
bash
import logging
import os.path
import time
root_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
log_path = os.path.join(root_path, "log")
class Logger:
def __init__(self):
# 定义日志位置和文件名
self.logname = os.path.join(log_path, "{}.log".format(time.strftime("%Y-%m-%d")))
# 定义一个日志容器
self.logger = logging.getLogger("log")
# 设置日志打印的级别
# 让所有级别的日志都打印输出
self.logger.setLevel(logging.DEBUG)
# 创建日志输入的格式
self.formater = logging.Formatter(
'[%(asctime)s][%(filename)s %(lineno)d][%(levelname)s]:%(message)s')
# 创建日志处理器,用来存放日志文件
self.filelogger = logging.FileHandler(self.logname, mode='a', encoding='utf8')
# 创建日志处理器,在控制台打印
self.console = logging.StreamHandler()
# 设置控制台打印日志界别
self.console.setLevel(logging.DEBUG)
# 文件存放日志级别
self.filelogger.setLevel(logging.DEBUG)
# 文件存放日志格式
self.filelogger.setFormatter(self.formater)
# 控制台打印日志格式
self.console.setFormatter(self.formater)
# 将日志输出渠道添加到日志收集器中
self.logger.addHandler(self.filelogger)
self.logger.addHandler(self.console)
logger = Logger().logger
if __name__ == '__main__':
logger.debug("打印debug日志")
logger.info("打印info日志")
logger.warning("打印warning日志")
logger.error("打印error日志")
- 输出结果如下:
- 我们可以在测试用例中引入日志,如下:
bash
import pytest
from utils.log_util import logger
from utils.yaml_util import func_yaml
from utils.read_data import read_data
@pytest.mark.parametrize("data", read_data()["person"])
def test_person(data):
logger.info("开始执行test_person测试用例")
result = func_yaml(data)
print(result)
logger.info("test_person测试用例执行完毕")
- 输出结果如下:
完整的get、post、delete、put请求优化
- 我们需要将这些请求都加上日志,需要记录url和参数信息,为了简化操作,放在最后一个函数处
- 代码如下:
bash
import json
import requests
from utils.log_util import logger
from utils.read import get_data
api_root_url = get_data.read_ini()["host"]["api_sit_url"]
class RestClient:
def __init__(self):
self.api_root_url = api_root_url
def get(self, url, **kwargs):
return self.request(self.api_root_url + url, "GET", **kwargs)
def post(self, url, **kwargs):
return self.request(self.api_root_url + url, "POST", **kwargs)
def put(self, url, **kwargs):
return self.request(self.api_root_url + url, "PUT", **kwargs)
def delete(self, url, **kwargs):
return self.request(self.api_root_url + url, "DELETE", **kwargs)
def request(self, url, method, **kwargs):
self.request_log(url, method, **kwargs)
if method == "GET":
return requests.get(url, **kwargs)
if method == "POST":
return requests.post(url, **kwargs)
if method == "PUT":
return requests.put(url, **kwargs)
if method == "DELETE":
return requests.delete(url, **kwargs)
def request_log(self, url, method, **kwargs):
logger.info("接口请求的地址>>>>{}".format(url))
logger.info("接口请求的方法>>>>{}".format(method))
data = dict(**kwargs).get("data")
json_data = dict(**kwargs).get("json")
params = dict(**kwargs).get("params")
headers = dict(**kwargs).get("headers")
if data is not None:
logger.info("接口请求的data参数>>>>\n{}".format(json.dumps(data, indent=2)))
if json_data is not None:
logger.info("接口请求的json参数>>>>\n{}".format(json.dumps(json_data, indent=2)))
if params is not None:
logger.info("接口请求的params参数>>>>\n{}".format(json.dumps(params, indent=2)))
if headers is not None:
logger.info("接口请求的headers参数>>>>\n{}".format(json.dumps(headers, indent=2)))
- 同时,我们使用conftest.py来设置前置和后置操作
bash
import pytest
from utils.log_util import logger
@pytest.fixture(scope="function", autouse=True)
def func():
logger.info("开始执行测试用例~")
yield
logger.info("测试用例执行完毕~")
- 最后的效果如下:
请求返回的日志优化
- 我们可以在请求的返回函数中加上log日志记录
- 还可以定义一个类,用于拼接状态码和body
- 注意,此处可以使用python的类属性动态赋值特性,不需要在类中显式定义success和body,而是直接赋值,python会自动创建该类属性
- 代码如下:
bash
# response_util
import json
from core.ResultBase import ResultResponse
from utils.log_util import logger
def process_response(response):
if response.status_code ==200 or response.status_code ==201:
ResultResponse.success = True
ResultResponse.body = response.json()
logger.info("接口返回的内容>>>>: "+json.dumps(response.json(), ensure_ascii=False))
else:
ResultResponse.success = False
logger.info("接口状态码不是2开头,请检查")
return ResultResponse
# ResultBase
class ResultResponse:
pass
# Testcase
def test_mobile():
print("测试手机归属地get请求")
param = get_data.read_data()["mobile_belong_dir"]
result = mobile_query(param)
assert result.success == True
assert result.body['status'] == 0
assert result.body['msg'] == "ok"
assert result.body['result']["shouji"] == "13906191369"
assert result.body['result']["province"] == "浙江"
assert result.body['result']["city"] == "杭州"
assert result.body['result']["company"] == "中国移动"
assert result.body['result']["areacode"] == "0571"
- 输出结果如下:
小优化
- 我们可以使用
requests.request()
来简化代码,直接传入method,从而可以自动切换请求类型 - 为了能够保持登陆状态,我们还可以使用session来进行请求,代码如下:
bash
import json
import requests
from utils.log_util import logger
from utils.read import get_data
api_root_url = get_data.read_ini()["host"]["api_sit_url"]
class RestClient:
def __init__(self):
self.api_root_url = api_root_url
# 新增
self.session = requests.Session()
def get(self, url, **kwargs):
return self.request(url, "GET", **kwargs)
def post(self, url, **kwargs):
return self.request(url, "POST", **kwargs)
def put(self, url, **kwargs):
return self.request(url, "PUT", **kwargs)
def delete(self, url, **kwargs):
return self.request(url, "DELETE", **kwargs)
def request(self, url, method, **kwargs):
self.request_log(url, method, **kwargs)
# if method == "GET":
# return requests.get(url, **kwargs)
# if method == "POST":
# return requests.post(url, **kwargs)
# if method == "PUT":
# return requests.put(url, **kwargs)
# if method == "DELETE":
# return requests.delete(url, **kwargs)
# 新增
response = self.session.request(method, self.api_root_url + url, **kwargs)
return response
def request_log(self, url, method, **kwargs):
logger.info("接口请求的地址>>>>{}".format(url))
logger.info("接口请求的方法>>>>{}".format(method))
data = dict(**kwargs).get("data")
json_data = dict(**kwargs).get("json")
params = dict(**kwargs).get("params")
headers = dict(**kwargs).get("headers")
if data is not None:
logger.info("接口请求的data参数>>>>\n{}".format(json.dumps(data, indent=2)))
if json_data is not None:
logger.info("接口请求的json参数>>>>\n{}".format(json.dumps(json_data, indent=2)))
if params is not None:
logger.info("接口请求的params参数>>>>\n{}".format(json.dumps(params, indent=2)))
if headers is not None:
logger.info("接口请求的headers参数>>>>\n{}".format(json.dumps(headers, indent=2)))