快捷導(dǎo)航

基于Python編寫簡單實(shí)用的日志裝飾器

更新時(shí)間：2022年05月20日 09:37:07 作者：Ckend

在寫代碼的時(shí)候，往往會(huì)漏掉日志這個(gè)關(guān)鍵因素，導(dǎo)致功能在使用的時(shí)候出錯(cuò)卻無法溯源。這個(gè)時(shí)候只要利用日志裝飾器就能解決，本文將用Python自制一個(gè)簡單實(shí)用的日志裝飾器，需要的可以參考一下

1.簡陋版裝飾器

寫一個(gè)裝飾器非常簡單，因?yàn)楸举|(zhì)上裝飾器就是一個(gè)返回函數(shù)的“高階”函數(shù)而已：

1) 函數(shù)作為參數(shù)傳遞進(jìn)裝飾器。

2) 裝飾器內(nèi)定義一個(gè)函數(shù)，處理作為參數(shù)傳遞進(jìn)來的函數(shù)。

3) 返回這個(gè)裝飾器內(nèi)定義的函數(shù)

import datetime

def log(func):
    """
    日志裝飾器，簡單記錄函數(shù)的日志

    Args:
        func (function): 函數(shù)
    """
    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)

效果如下：

雖然這樣可以實(shí)現(xiàn)我們所需要的功能，但其實(shí)有很大的優(yōu)化空間。

2.普通版裝飾器

第一版代碼中有一個(gè)顯而易見的問題，裝飾器內(nèi)定義的處理函數(shù)不支持kwargs，而在裝飾器中支持kwargs僅僅是舉手之勞而已。

第二個(gè)問題是，生成時(shí)間戳的時(shí)候采用字符串截取的形式，這種形式過于粗暴。其實(shí)可以使用strftime做字符串轉(zhuǎn)換。

修改如下：

import datetime

def log(func):
    """
    日志裝飾器，簡單記錄函數(shù)的日志

    Args:
        func (function): 函數(shù)
    """
    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

似乎優(yōu)化得差不多了，不過依然存在改進(jìn)空間。

3.優(yōu)化版裝飾器

在前兩版代碼中，我們使用print進(jìn)行日志輸出，其實(shí)這種處理日志的方式并不標(biāo)準(zhǔn)。

使用logging模塊控制日志輸出是一個(gè)更好地選擇。

為了使用logging模塊記錄日志，我們需要先配置好logging相關(guān)的選項(xiàng)。

1) 首先，生成一個(gè)日志記錄器，并配置日志等級：

import logging

# 獲取日志記錄器，配置日志等級
logger = logging.getLogger(__name__)
logger.setLevel('DEBUG')

2) 配置日志格式、增加handler控制輸出流：

# 默認(rèn)日志格式
formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s")
# 輸出到控制臺的handler
chlr = logging.StreamHandler()
# 配置默認(rèn)日志格式
chlr.setFormatter(formatter)

此處可以設(shè)置handler所需要處理的日志等級，沒有設(shè)置則默認(rèn)使用logger自身的Level，即DEBUG等級。

3) 最后，將此handler加入到日志記錄器內(nèi)：

# 日志記錄器增加此handler
logger.addHandler(chlr)

logging 完整配置如下：

import logging

# 獲取日志記錄器，配置日志等級
logger = logging.getLogger(__name__)
logger.setLevel('DEBUG')

# 默認(rèn)日志格式
formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s")
# 輸出到控制臺的handler
chlr = logging.StreamHandler()
# 配置默認(rèn)日志格式
chlr.setFormatter(formatter)

# 日志記錄器增加此handler
logger.addHandler(chlr)

使用的時(shí)候非常簡單，就是把print換成logger.debug即可：

def log(func):
    """
    日志裝飾器，簡單記錄函數(shù)的日志

    Args:
        func (function): 函數(shù)
    """
    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

效果如下：