python 基础 5.1 装饰器

一 了解装饰器前准备

 1 #### 第一波 ####
 2 def foo():
 3     print 'foo'
 4  
 5 foo     #表示是函数
 6 foo()   #表示执行foo函数
 7  
 8 #### 第二波 ####
 9 def foo():
10     print 'foo'
11  
12 foo = lambda x: x + 1
13  
14 foo()   # 执行下面的lambda表达式，而不再是原来的foo函数，因为函数 foo 被重新定义了

类方法使用装饰器

 

#!/usr/bin/env python
# _*_coding:utf-8_*_


class E:

    @classmethod
    def wraper(cls, f):
        def outer(*args):
            print(12312)
            return f(*args)


        return outer

class F:

    def __init__(self):
        pass

    @classmethod
    def wraper(cls, f):
        def outer(*args):
            print(12312)
            return f()
        return outer

    @classmethod
    @E.wraper
    def f2(cls,):
        print(234234)


def wraper(f):
    def outer(*args):
        print(12312)
        return f()

    return outer


# @wraper
@F.wraper
def f1():
    print(32323)



# f1()
F.f2()

 

重试装饰器：

 装饰器（Decorators）是应用包装函数的快捷方式。这有助于将某一功能与一些代码一遍又一 遍地“包装”。举个例子，我为自己创建了一个 retry 装饰器，这样我可以将其运用到任何函 数之中，如果在一次运行中抛出了任何错误，它就会尝试重新运行，直到最大次数 5 次，并 且每次运行期间都会有一定的延迟。这对于你在对一台远程计算机进行网络调用的情况十分 有用：

 

#!/usr/bin/env python
# _*_coding:utf-8_*_
from time import sleep
from functools import wraps
import logging

logging.basicConfig()
log = logging.getLogger("retry")


def retry(f):
	@wraps(f)
	def wrapped_f(*args, **kwargs):
		MAX_ATTEMPTS = 5
		for attempt in range(1, MAX_ATTEMPTS + 1):
			try:
				return f(*args, **kwargs)
			except:
				log.exception("Attempt %s/%s failed : %s",
				              attempt,
				              MAX_ATTEMPTS,
				              (args, kwargs))
				sleep(10 * attempt)
				log.critical("All %s attempts failed : %s",
				             MAX_ATTEMPTS,
				             (args, kwargs))
	return wrapped_f
counter = 0


@retry
def save_to_database(arg):
	print("Write to a database or make a network call or etc.")
	print("This will be automatically retried if exception is thrown.")
	global counter
	counter += 1
	# 这将在第一次调用时抛出异常
	# 在第二次运行时将正常工作（也就是重试）
	if counter < 2:
		raise ValueError(arg)
if __name__ == '__main__':
	save_to_database("Some bad value")

　　

输出：

Write to a database or make a network call or etc.
This will be automatically retried if exception is thrown.
ERROR:retry:Attempt 1/5 failed : (('Some bad value',), {})
Traceback (most recent call last):
  File "/Users/liujianzuo/devspace/test/edns_prober/src/edns_prober/test/retry_decorator.py", line 17, in wrapped_f
    return f(*args, **kwargs)
  File "/Users/liujianzuo/devspace/test/edns_prober/src/edns_prober/test/retry_decorator.py", line 40, in save_to_database
    raise ValueError(arg)
ValueError: Some bad value
Write to a database or make a network call or etc.
This will be automatically retried if exception is thrown.
CRITICAL:retry:All 5 attempts failed : (('Some bad value',), {})

　　

 

 

二 装饰器解决需求

初创公司有N个业务部门，1个基础平台部门，基础平台负责提供底层的功能，如：数据库操作、redis调用、监控API等功能。业务部门使用基础功能时，只需调用基础平台提供的功能即可。如下：

 1 ############### 基础平台提供的功能如下 ###############
 2  
 3 def f1():
 4     print 'f1'
 5  
 6 def f2():
 7     print 'f2'
 8  
 9 def f3():
10     print 'f3'
11  
12 def f4():
13     print 'f4'
14  
15 ############### 业务部门A 调用基础平台提供的功能 ###############
16  
17 f1()
18 f2()
19 f3()
20 f4()
21  
22 ############### 业务部门B 调用基础平台提供的功能 ###############
23  
24 f1()
25 f2()
26 f3()
27 f4()

增加 调用基础功能前需要验证 功能

目前公司有条不紊的进行着，但是，以前基础平台的开发人员在写代码时候没有关注验证相关的问题，即：基础平台的提供的功能可以被任何人使用。现在需要对基础平台的所有功能进行重构，为平台提供的所有功能添加验证机制，即：执行功能前，先进行验证。

1 最不能使用的方法

　　每个业务部门自己写代码，调用基础平台的功能之前先验证。

2  费事的方法 不可取

　　只对基础平台的代码进行重构，让N业务部门无需做任何修改

 1 ############### 基础平台提供的功能如下 ############### 
 2 
 3 def f1():
 4     # 验证1
 5     # 验证2
 6     # 验证3
 7     print 'f1'
 8 
 9 def f2():
10     # 验证1
11     # 验证2
12     # 验证3
13     print 'f2'
14 
15 def f3():
16     # 验证1
17     # 验证2
18     # 验证3
19     print 'f3'
20 
21 def f4():
22     # 验证1
23     # 验证2
24     # 验证3
25     print 'f4'
26 
27 ############### 业务部门不变 ############### 
28 ### 业务部门A 调用基础平台提供的功能### 
29 
30 f1()
31 f2()
32 f3()
33 f4()
34 
35 ### 业务部门B 调用基础平台提供的功能 ### 
36 
37 f1()
38 f2()
39 f3()
40 f4()
View Code

3  稍微可取的一个本方法 封装成函数

　　只对基础平台的代码进行重构，其他业务部门无需做任何修改

 1 ############### 基础平台提供的功能如下 ############### 
 2 
 3 def check_login():
 4     # 验证1
 5     # 验证2
 6     # 验证3
 7     pass
 8 
 9 
10 def f1():
11     
12     check_login()
13 
14     print 'f1'
15 
16 def f2():
17     
18     check_login()
19 
20     print 'f2'
21 
22 def f3():
23     
24     check_login()
25 
26     print 'f3'
27 
28 def f4():
29     
30     check_login()
31     
32     print 'f4'
View Code

引出装饰器

写代码要遵循开发封闭原则，虽然在这个原则是用的面向对象开发，但是也适用于函数式编程，简单来说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

  • 封闭：已实现的功能代码块
  • 开放：对扩展开发

如果将开放封闭原则应用在上述需求中，那么就不允许在函数 f1 、f2、f3、f4的内部进行修改代码

装饰器方法

 1 def w1(func):
 2     def inner():
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func()
 7     return inner
 8  
 9 @w1
10 def f1():
11     print 'f1'
12 @w1
13 def f2():
14     print 'f2'
15 @w1
16 def f3():
17     print 'f3'
18 @w1
19 def f4():
20     print 'f4'

这段代码原理：

拿单个业务来说：

　　将f1函数名作为参数传入 w1 函数 ，重新赋值给f1

　　　　　　这样就是 f1 = w1(f1)，因此 func = f1

　　 而 w1 函数返回值为 inner函数名， 因此 f1 = inner 

　　 重新执行f1() 就相当于执行 inner（）， 而原来的func = 原来的f1的函数体，所以就会先执行验证1 2 3 之后再执行原来的f1的函数体，并返回。

单独以f1为例：

 1 def w1(func):
 2     def inner():
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func()
 7     return inner
 8  
 9 @w1
10 def f1():
11     print 'f1'


 # @w1
# 1、执行w1函数，将f1作为参数传递
# 2、将w1的返回值，重新赋值给f1
 

当写完这段代码后（函数未被执行、未被执行、未被执行），python解释器就会从上到下解释代码，步骤如下：

  1. def w1(func):  ==>将w1函数加载到内存
  2. @w1

没错，从表面上看解释器仅仅会解释这两句代码，因为函数在没有被调用之前其内部代码不会被执行。

从表面上看解释器着实会执行这两句，但是 @w1 这一句代码里却有大文章，@函数名 是python的一种语法糖。

如上例@w1内部会执行一下操作：

    • 执行w1函数，并将 @w1 下面的 函数 作为w1函数的参数，即：@w1 等价于 w1(f1)
      所以，内部就会去执行：
          def inner:
              #验证
              return f1()   # func是参数，此时 func 等于 f1
          return inner     # 返回的 inner，inner代表的是函数，非执行函数
      其实就是将原来的 f1 函数塞进另外一个函数中
    • 将执行完的 w1 函数返回值赋值给@w1下面的函数的函数名
      w1函数的返回值是：
         def inner:
              #验证
              return 原来f1()  # 此处的 f1 表示原来的f1函数
      然后，将此返回值再重新赋值给 f1，即：
      新f1 = def inner:
                  #验证
                  return 原来f1() 
      所以，以后业务部门想要执行 f1 函数时，就会执行 新f1 函数，在 新f1 函数内部先执行验证，再执行原来的f1函数，然后将 原来f1 函数的返回值 返回给了业务调用者。
      如此一来， 即执行了验证的功能，又执行了原来f1函数的内容，并将原f1函数返回值 返回给业务调用着

 

装饰器原理

 

三  装饰器时候，函数参数调用

 1 def w1(func):
 2     def inner(arg):
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func(arg)
 7     return inner
 8 
 9 @w1
10 def f1(arg):
11     print 'f1'
12 
13 一个参数
一个参数
 1 def w1(func):
 2     def inner(arg1,arg2):
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func(arg1,arg2)
 7     return inner
 8 
 9 @w1
10 def f1(arg1,arg2):
11     print 'f1'
12 
13 两个参数
两个参数
 1 def w1(func):
 2     def inner(arg1,arg2,arg3):
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func(arg1,arg2,arg3)
 7     return inner
 8 
 9 @w1
10 def f1(arg1,arg2,arg3):
11     print 'f1'
12 
13 三个参数
三个参数

问题1：不同业务部门的调用函数的参数个数不同如何解决？？可以装饰具有处理n个参数的函数的装饰器？

def w1(func):
    def inner(*args,**kwargs):
        # 验证1
        # 验证2
        # 验证3
        return func(*args,**kwargs)
    return inner
 
@w1
def f1(arg1,arg2,arg3):
    print 'f1'

问题2 ：一个函数可以被多个装饰器装饰吗？ 比如两个装饰器 

　　会先将 函数交个最下层@装饰器将处理结果在交给其上一层@装饰器  即先交给w2 再交给w1

 1 def w1(func):
 2     def inner(*args,**kwargs):
 3         # 验证1
 4         # 验证2
 5         # 验证3
 6         return func(*args,**kwargs)
 7     return inner
 8  
 9 def w2(func):
10     def inner(*args,**kwargs):
11         # 验证1
12         # 验证2
13         # 验证3
14         return func(*args,**kwargs)
15     return inner
16  
17  
18 @w1
19 @w2
20 def f1(arg1,arg2,arg3):
21     print 'f1'

双层装饰器原理

 

稍微再复杂一点的装饰器

#!/usr/bin/env python
#coding:utf-8
  
def Before(request,kargs):
    print 'before'
      
def After(request,kargs):
    print 'after'
  
  
def Filter(before_func,after_func):
    def outer(main_func):
        def wrapper(request,kargs):
              
            before_result = before_func(request,kargs)
            if(before_result != None):
                return before_result;
              
            main_result = main_func(request,kargs)
            if(main_result != None):
                return main_result;
              
            after_result = after_func(request,kargs)
            if(after_result != None):
                return after_result;
              
        return wrapper
    return outer
      
@Filter(Before, After)
def Index(request,kargs):
    print 'index'

　　

4、functools.wraps

上述的装饰器虽然已经完成了其应有的功能，即：装饰器内的函数代指了原函数，注意其只是代指而非相等，原函数的元信息没有被赋值到装饰器函数内部。例如：函数的注释信息

 

def outer(func):
    def inner(*args, **kwargs):
        print(inner.__doc__)  # None
        return func()
    return inner

@outer
def function():
    """
    asdfasd
    :return:
    """
    print('func')

　　

如果使用@functools.wraps装饰装饰器内的函数，那么就会代指元信息和函数。

 

def outer(func):
    @functools.wraps(func)
    def inner(*args, **kwargs):
        print(inner.__doc__)  # None
        return func()
    return inner

@outer
def function():
    """
    asdfasd
    :return:
    """
    print('func')

　　

 

posted @ 2016-05-14 23:39  众里寻，阑珊处  阅读(279)  评论(0)  编辑  收藏  举报
返回顶部