Python如何在類中定義裝飾器

更新時間：2024年02月09日 09:58:54 作者：AllardZhao

這篇文章主要介紹了Python如何在類中定義裝飾器的問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

如何在類中定義裝飾器

實際案例

實現(xiàn)一個能將函數(shù)調用信息記錄到日志的裝飾器：

把每次函數(shù)的調用時間，執(zhí)行時間，調用次數(shù)寫入日志；
可以對被裝飾函數(shù)分組，調用信息記錄到不同日志；
動態(tài)修改參數(shù)，比如日志格式；
動態(tài)打開關閉日志輸出功能。

解決方案

為了讓裝飾器在使用上更加靈活，我們把類的實例方法作為裝飾器

此時在包裹函數(shù)中就可以持有實例對象，便于修改屬性和拓展功能。

代碼演示

# _*_ encoding:utf-8 _*_
import logging
from time import localtime, time, strftime, sleep
from random import choice
 
 
class CallingInfo(object):
 
    # 通過name對為日志分組
    def __init__(self, name):
        log = logging.getLogger(name)
        # 設置log的輸出級別
        log.setLevel(logging.INFO)
        # 輸入到文件中
        fh = logging.FileHandler(name + '.log')
        log.addHandler(fh)
        log.info('start'.center(50, '-'))
        # 將log變成實例屬性
        self.log = log
        # 定義日志的輸出格式,函數(shù)名、開始時間，執(zhí)行時間，調用次數(shù)
        self.formatter = '%(func)s -> [%(time)s - ' \
                         '%(used)s - %(n_calls)s]'
 
    # 定義裝飾器函數(shù)
    def info(self, func):
        def wrapper(*args, **kwargs):
            wrapper.n_calls += 1
            lt = localtime()
            start = time()
            res = func(*args, **kwargs)
            used = time() - start
            info = dict()
            info['func'] = func.__name__
            info['time'] = strftime('%x %X', lt)
            info['used'] = used
            info['n_calls'] = wrapper.n_calls
            msg = self.formatter % info
            # 輸出日志
            self.log.info(msg)
            return res
 
        # 統(tǒng)計函數(shù)調用次數(shù)，函數(shù)屬性類似于函數(shù)內的靜態(tài)變量
        wrapper.n_calls = 0
        return wrapper
 
    # 動態(tài)修改formatter參數(shù)
    def set_formatter(self, formatter):
        # 修改實例屬性
        self.formatter = formatter
 
    # 動態(tài)的打開和關閉日志輸出，設置level輸出級別
    def turn_on(self):
        # INFO級別會輸出日志
        self.log.setLevel(logging.INFO)
 
    def turn_off(self):
        # 抬高日志輸出級別就會關閉
        self.log.setLevel(logging.WARN)
 
 
# 將f和g輸出到一個日志當中，h輸出到另一個,需要創(chuàng)建2個實例
# 創(chuàng)建類的實例，使用實例的info方法去裝飾函數(shù)
c_info1 = CallingInfo('my_log1')
c_info2 = CallingInfo('my_log2')
# 將c_info1日志修改為如下格式
c_info1.set_formatter('%(func)s -> [%(time)s - %(n_calls)s]')
# 關閉c_info2的日志輸出
c_info2.turn_off()
 
 
@c_info1.info
def f():
    print('in f')
 
 
@c_info1.info
def g():
    print('in g')
 
 
@c_info2.info
def h():
    print('in h')
 
 
# 測試代碼, 循環(huán)50次
for _ in range(50):
    # 隨機調用上面三個函數(shù)中的一個
    choice([f, g, h])()
    # 隨機秒數(shù)的睡眠
    sleep(choice([0.5, 1, 1.5]))