| by msbeta | No comments

实现一个python函数装饰器(Decorator)

装饰器本质上是一个 Python 函数或类,它可以让其他函数或类在不需要做任何代码修改的前提下增加额外功能,装饰器的返回值也是一个函数/类对象。它经常用于为已有函数/类添加记录日志、计时统计、性能测试等。

首先定义一个倒计时函数,这个函数的功能非常简单,就是把n从当前值减少到0。

def countdown(n):
  while n > 0:
    print('time' + str(n))
    n -= 1

print(countdown.__name__)

程序输出:

countdown

1.为函数增加一个日志装饰器

假设现在要增强countdown的功能,在函数调用前后自动打印日志,又不想修改函数自身的功能。这种在代码运行期间动态增加功能的方式,称之为装饰器(Decorator)。

能打印日志的decorator,可以定义如下:

def log(func):
    def wrapper(*args, **kw):
        print('call %s().' % func.__name__)
        return func(*args, **kw)
    return wrapper

然后我们借助Python的@语法,把decorator置于函数的定义处:

@log
def countdown(n):
  while n > 0:
    print('time:' + str(n))
    n -= 1

countdown(10)

程序输出:

call countdown().
 time:10
 time:9
 time:8
 time:7
 time:6
 time:5
 time:4
 time:3
 time:2
 time:1

但此时我们再打印函数的name:

print(countdown.__name__)

程序输出:

wrapper

我们发现函数的元数据信息变了,这显然不是我们想要的结果。

2. 在装饰器中拷贝元数据

为了把函数的元数据信息都保留下来,我们可以直接使用Python提供的functools库中的@wraps装饰器。

from functools import wraps

def log(func):
    @wraps(func)
    def wrapper(*args, **kw):
        print('call %s().' % func.__name__)
        return func(*args, **kw)
    return wrapper

@log
def countdown(n):
  while n > 0:
    print('time:' + str(n))
    n -= 1

print(countdown.__name__)

程序输出:

countdown

3.为函数增加一个计时装饰器

添加函数装饰器的方法已经讲清楚了,现在再实现一个完整的函数计时耗时装饰器。

import time
from functools import wraps

def TimeCost(func):
  @wraps(func)
  def wrapper(*arg, **kwargs):
    start = time.time()
    result = func(*args, **kwargs)
    end = time.time()
    print(func.__name__, end - start)
    return result
  return wrapper

@TimeCost
def countdown(n):
  while n > 0:
    print('time:' + str(n))
    n -= 1

countdown(10000)

函数输出:

('countdown', 0.0004801750183105469)

参考材料

https://www.liaoxuefeng.com/wiki/1016959663602400/1017451662295584

Python Cookbook中文版

发表评论