Python装饰器

Posted 2022-11-28 ydqq

什么是装饰器

装饰器就是用来装饰函数的函数，在不改变原来函数的情况下，执行额外的功能。其实就是在函数外面套一个函数，方法是@函数名，这样就套上了。在执行某个函数之前如果有装饰器则先执行装饰器的函数，然后再执行本函数。

装饰器特性：

装饰器是遵循开放封闭原则在不对原代码修改的情况下，在源代码外进行拓展，通过规范的语句调用源代码，并增加功能。

定义一个简单函数：

def myfunc()
    print("这是函数！")

myfunc()    #执行函数

需求：

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

基础功能：

def f1():
    print 'f1'

def f2():
    print 'f2'

def f3():
    print 'f3'

def f4():
    print 'f4'

部门A调用功能：

f1()
f2()
f3()
f4()

部门B调用功能：

f1()
f2()
f3()
f4()

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

为了实现验证机制，可以用以下几种方式：
方式一：

基础功能：
def f1():
    # 验证1# 验证2# 验证3print'f1'
def f2():
    # 验证1# 验证2# 验证3print'f2'
def f3():
    # 验证1# 验证2# 验证3print'f3'
def f4():
    # 验证1# 验证2# 验证3print'f4'
部门调用：
f1()
f2()
f3()
f4()

这种方法，各个业务部门不用修改原先的代码，只需要修改基础功能的源码。

方式二：

def check_login():
    # 验证1# 验证2# 验证3passdef 
f1():
    check_login()
    print'f1'
def f2():
    check_login()
    print'f2'
def f3():
    check_login()
    print'f3'
def f4():
    check_login()
    print'f4'

这种方法，业务部门不修改代码，集中写一个验证函数，在基础代码中调用验证函数。减少源码修改量

按照封闭开发的原则，我们要求不允许修改已经实现了的代码。

方式三：

def w1(func):
    def inner():
        # 验证1
        # 验证2
        # 验证3
        return func()
    return inner

@w1
def f1():
    print 'f1'
@w1
def f2():
    print 'f2'
@w1
def f3():
    print 'f3'
@w1
def f4():
    print 'f4'

第三种方式就是咱们要讲的装饰器

方式三的执行过程如下：
当写完这段代码后（函数未被执行、未被执行、未被执行），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函数返回值 返回给业务调用着

被装饰的函数如果有参数要怎么办？

一个参数：

def w1(func):
    def inner(arg):
        # 验证1# 验证2# 验证3return func(arg)
    return inner

@w1
def f1(arg):
    print'f1'

两个参数：

def w1(func):
    def inner(arg1,arg2):
        # 验证1# 验证2# 验证3return func(arg1,arg2)
    return inner

@w1
def f1(arg1,arg2):
    print'f1'

三个参数：

def w1(func):
    def inner(arg1,arg2,arg3):
        # 验证1# 验证2# 验证3return func(arg1,arg2,arg3)
    return inner

@w1
def f1(arg1,arg2,arg3):
    print'f1'

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'

还有什么更吊的装饰器吗？

#!/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'

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

def outer(func):
    def inner(*args, **kwargs):
        print(inner.__doc__)  # Nonereturn 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__)  # Nonereturn func()
    return inner

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