Python初学笔记之装饰器(decorator)

1、在Python中,函数是可以赋值给变量的,而且通过变量也可以调用该函数。如:

def fn():
  print("这是个函数")
f=fn
f() #这是个函数

每个函数都有__name__ 这个属性,通过这个函数可以拿到函数的名字,如:

print(fn.__name__)  #  "fn"

如果我们想要在调用函数的时候打印某些日志,但是不能修改方法本身函数定义,这种在代码运行期间动态增加功能的方式,我们就叫他“装饰器(Decorator)”

说白了装饰器就是个返回函数的高阶函数,所以我们要定义一个能打印日志的装饰器;如下:

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

上面的log就是一个装饰器,可以接受一个函数作为参数,并返回一个函数。我们借助Python的@语法,把装饰器放到函数定义的地方。

@log
def outDate():
  print("2019-02-26")

我们调用一下outDate(),看一下结果:

outDate()
# 调用outDate()    2019-02-26

把@log放到outDate()函数定义的地方,相当于执行语句:

outDate=log(outDate)

由于log()是一个decorator,返回一个函数,所以,原来的now()函数仍然存在,只是现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即在log()函数中返回的wrapper()函数。

wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数
2、带参数的装饰器
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:

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

同样我们用到outDate()上:

@log("参数")
def outDate():
  print('2019-02-26')
-----------------------------
#执行结果
outDate()
#参数      
#2019-02-26

带参数的装饰器,执行效果相当于:

outDate=log('参数')(outDate)

到此 你是否还记得,开头说的每个函数都有一个__name__属性,我们来打印一下;

print(outDate.__name__) 
#wrapper  

发现函数名改变了,分析装饰器可知,装饰器最后返回的函数就是wrapper,那我们怎么恢复原来的名字呢?
也不用写a=b的赋值语句,因为Python内置的functools.wraps可以帮我们干这个事,如下:

import functools

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

或者带参数的装饰器

import functools

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

对比发现就是增加了一句 @functools.wraps(func)

小思考:
能不能写一个,打印函数调用时间的装饰器呢?
能否写一个参数可以为空,也可以不为空的装饰器呢?

你可能感兴趣的:(Python初学笔记之装饰器(decorator))