基于Python编写简单实用的日志装饰器

更新时间：2022年05月20日 09:37:07 作者：Ckend

在写代码的时候，往往会漏掉日志这个关键因素，导致功能在使用的时候出错却无法溯源。这个时候只要利用日志装饰器就能解决，本文将用Python自制一个简单实用的日志装饰器，需要的可以参考一下

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 Dataframe常见索引方式详解
这篇文章主要介绍了Python Dataframe常见索引方式详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-05-05
python算法与数据结构之冒泡排序实例详解
冒泡排序（英语：Bubble Sort）是一种简单的排序算法。它重复地遍历要排序的数列，一次比较两个元素，如果他们的顺序错误就把他们交换过来。这篇文章主要介绍了python算法与数据结构-冒泡排序(32)的相关资料,需要的朋友可以参考下
2019-06-06
Mac下使用HomeBrew安装python3
这篇文章介绍了Mac下使用HomeBrew安装python3的方法，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-06-06
使用python实现链表操作
链表是计算机科学里面应用最广泛的数据结构之一。这篇文章主要介绍了使用python实现链表操作,需要的朋友可以参考下
2018-01-01
python如何把字符串类型list转换成list
这篇文章主要介绍了python如何吧字符串类型list转换成list,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
Python实现拼音转换
拼音转换指的是将汉字转为拼音的过程。本文介绍了Python实现拼音转换，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-06-06
Python实现全自动安装第三方库的方法
这篇文章主要介绍了Python实现全自动安装第三方库的方法,一说Python要安装哪个模块，我们第一反应，win+r输入cmd，pip instll安装,但是如果换电脑了,Python第三方库那么多，难道要一次一次的敲击pip install,本文就介绍一个简单的方法解放双手,需要的朋友可以参考下
2023-07-07
关于keras.layers.Conv1D的kernel_size参数使用介绍
这篇文章主要介绍了关于keras.layers.Conv1D的kernel_size参数使用介绍，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-05-05
Python操作csv文件之csv.writer()和csv.DictWriter()方法的基本使用
csv文件是一种逗号分隔的纯文本形式存储的表格数据,Python内置了CSV模块,可直接通过该模块实现csv文件的读写操作,下面这篇文章主要给大家介绍了关于Python操作csv文件之csv.writer()和csv.DictWriter()方法的基本使用,需要的朋友可以参考下
2022-09-09
Python 操作 MySQL数据库
这篇文章主要介绍了Python 如何操作 MySQL，帮助大家更好的理解和使用python，感兴趣的朋友可以了解下
2020-09-09