python--基础装饰器入门

1、装饰器语法糖

python提供了@符号作为装饰器的语法糖，使我们更方便的应用装饰函数。但使用语法糖要求装饰函数必须return一个函数对象。因此我们将上面的func函数使用内嵌函数包裹并return。

装饰器相当于执行了装饰函数use_loggin后又返回被装饰函数bar,因此bar()被调用的时候相当于执行了两个函数。等价于use_logging(bar)()

1 def use_logging(func):
2   def _deco():
3     print("%s is running" % func.__name__)
4     func()
5   return _deco
6 @use_logging
7 def bar():
8   print('i am bar')
9 bar()

2、对带参数的函数进行装饰

现在我们的参数需要传入两个参数并计算值，因此我们需要对内层函数进行改动传入我们的两个参数a和b，等价于use_logging(bar)(1,2)

1 def use_logging(func):
2   def _deco(a,b):
3     print("%s is running" % func.__name__)
4     func(a,b)
5   return _deco
6 @use_logging
7 def bar(a,b):
8   print('i am bar:%s'%(a+b))
9 bar(1,2)

我们装饰的函数可能参数的个数和类型都不一样，每一次我们都需要对装饰器做修改吗？这样做当然是不科学的，因此我们使用python的变长参数*args和**kwargs来解决我们的参数问题。

3、函数参数数量不确定

不带参数装饰器版本，这个格式适用于不带参数的装饰器。

经过以下修改我们已经适应了各种长度和类型的参数。这个版本的装饰器已经可以任意类型的无参数函数。

 1 def use_logging(func):
 2   def _deco(*args,**kwargs):
 3     print("%s is running" % func.__name__)
 4     func(*args,**kwargs)
 5   return _deco
 6 @use_logging
 7 def bar(a,b):
 8   print('i am bar:%s'%(a+b))
 9 @use_logging
10 def foo(a,b,c):
11   print('i am bar:%s'%(a+b+c))
12 bar(1,2)
13 foo(1,2,3)

4、装饰器带参数

带参数的装饰器，这个格式适用于带参数的装饰器。

某些情况我们需要让装饰器带上参数，那就需要编写一个返回一个装饰器的高阶函数，写出来会更复杂。比如：

 1 #! /usr/bin/env python
 2 # -*- coding:utf-8 -*-
 3 # __author__ = "TKQ"
 4 def use_logging(level):
 5   def _deco(func):
 6     def __deco(*args, **kwargs):
 7       if level == "warn":
 8         print "%s is running" % func.__name__
 9       return func(*args, **kwargs)
10     return __deco
11   return _deco
12 @use_logging(level="warn")
13 def bar(a,b):
14   print('i am bar:%s'%(a+b))
15 bar(1,3)
16 # 等价于use_logging(level="warn")(bar)(1,3)

5、functools.wraps

使用装饰器极大地复用了代码，但是他有一个缺点就是原函数的元信息不见了，比如函数的docstring、name、参数列表，先看例子：

 1 def use_logging(func):
 2   def _deco(*args,**kwargs):
 3     print("%s is running" % func.__name__)
 4     func(*args,**kwargs)
 5   return _deco
 6 @use_logging
 7 def bar():
 8   print('i am bar')
 9   print(bar.__name__)
10 bar()
11 #bar is running
12 #i am bar
13 #_deco
14 #函数名变为_deco而不是bar，这个情况在使用反射的特性的时候就会造成问题。因此引入了functools.wraps解决这个问题。

使用functools.wraps:

 1 import functools
 2 def use_logging(func):
 3   @functools.wraps(func)
 4   def _deco(*args,**kwargs):
 5     print("%s is running" % func.__name__)
 6     func(*args,**kwargs)
 7   return _deco
 8 @use_logging
 9 def bar():
10   print('i am bar')
11   print(bar.__name__)
12 bar()
13 #result:
14 #bar is running
15 #i am bar
16 #bar ,这个结果是我们想要的。OK啦！

6、实现带参数和不带参数的装饰器自适应

 1 import functools
 2 def use_logging(arg):
 3   if callable(arg):#判断参入的参数是否是函数，不带参数的装饰器调用这个分支
 4     @functools.wraps(arg)
 5     def _deco(*args,**kwargs):
 6       print("%s is running" % arg.__name__)
 7       arg(*args,**kwargs)
 8     return _deco
 9   else:#带参数的装饰器调用这个分支
10     def _deco(func):
11       @functools.wraps(func)
12       def __deco(*args, **kwargs):
13         if arg == "warn":
14           print "warn%s is running" % func.__name__
15         return func(*args, **kwargs)
16       return __deco
17     return _deco
18 @use_logging("warn")
19 # @use_logging
20 def bar():
21   print('i am bar')
22   print(bar.__name__)
23 bar()