在写代码的时候,往往会漏掉日志这个关键因素,导致功能在使用的时候出错却无法溯源。
其实,只需要写一个非常简单的日志装饰器,我们就能大大提升排查问题的效率。
1.简陋版
写一个装饰器非常简单,因为本质上装饰器就是一个返回函数的“高阶”函数而已:
1.函数作为参数传递进装饰器。
2.装饰器内定义一个函数,处理作为参数传递进来的函数。
3.返回这个装饰器内定义的函数
import datetime def log(func): """ 日志装饰器,简单记录函数的日志 Args: func (function): 函数 """ def inner(*args): timestamp = str(datetime.datetime.now()).split(".")[0] res = func(*args) print(f"[{timestamp}] ({func.__name__}) {args} -> {res}") return res return inner
用一下试试看:
@log def pluser(a, b): return a + b pluser(1, 2)
效果如下:
虽然这样可以实现我们所需要的功能,但其实有很大的优化空间。
2.普通版
第一版代码中有一个显而易见的问题,装饰器内定义的处理函数不支持kwargs,而在装饰器中支持kwargs仅仅是举手之劳而已。
第二个问题是,生成时间戳的时候采用字符串截取的形式,这种形式过于粗暴。其实可以使用strftime做字符串转换。
修改如下:
import datetime def log(func): """ 日志装饰器,简单记录函数的日志 Args: func (function): 函数 """ def inner(*args, **kwargs): timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S") res = func(*args, **kwargs) print(f"[{timestamp}] ({func.__name__}) {args} -> {res}") return res return inner
似乎优化地差不多了,不过依然存在改进空间。
3.优化版
在前两版代码中,我们使用print进行日志输出,其实这种处理日志的方式并不标准。
使用logging模块控制日志输出是一个更好地选择。
为了使用logging模块记录日志,我们需要先配置好logging相关的选项。
1.首先,生成一个日志记录器,并配置日志等级:
import logging # 获取日志记录器,配置日志等级 logger = logging.getLogger(__name__) logger.setLevel('DEBUG')
2.配置日志格式、增加handler控制输出流:
# 默认日志格式 formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s") # 输出到控制台的handler chlr = logging.StreamHandler() # 配置默认日志格式 chlr.setFormatter(formatter)
此处可以设置handler所需要处理的日志等级,没有设置则默认使用logger自身的Level,即DEBUG等级。
3.最后,将此handler加入到日志记录器内:
# 日志记录器增加此handler logger.addHandler(chlr)
logging 完整配置如下:
import logging # 获取日志记录器,配置日志等级 logger = logging.getLogger(__name__) logger.setLevel('DEBUG') # 默认日志格式 formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s") # 输出到控制台的handler chlr = logging.StreamHandler() # 配置默认日志格式 chlr.setFormatter(formatter) # 日志记录器增加此handler logger.addHandler(chlr)
使用的时候非常简单,就是把print换成logger.debug即可:
def log(func): """ 日志装饰器,简单记录函数的日志 Args: func (function): 函数 """ def inner(*args, **kwargs): timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S") res = func(*args, **kwargs) logger.debug(f"func: {func.__name__} {args} -> {res}") return res return inner
效果如下:
这样,一个比较完善的日志装饰器就完成了。
附常用的日志等级配置:
我们的文章到此就结束啦,如果你喜欢今天的Python 实战教程,请持续关注Python实用宝典。
有任何问题,可以在公众号后台回复:加群,回答相应验证信息,进入互助群询问。
原创不易,希望你能在下面点个赞和在看支持我继续创作,谢谢!
Python实用宝典 (pythondict.com)
不只是一个宝典
欢迎关注公众号:Python实用宝典