python函数装饰器详解

基础:函数装饰器的表现方式

假如你已经定义了一个函数funcA(),在准备定义函数funcB()的时候,如果写成下面的格式:

@funcA
def funcB():...

表示用函数funcA()装饰函数funcB()。当然,也可以认为是funcA包装函数funcB。它等价于:

def funcB():...

funcB = funcA(funcB)

也就是说,将函数funcB作为函数funcA的参数,funcA会重新返回另一个可调用的对象(比如函数)并赋值给funcB。

所以,funcA要想作为函数装饰器,需要接收函数作为参数,并且返回另一个可调用对象(如函数)。例如:

def funcA(F):
    ...
    ...
    return Callable

注意,函数装饰器返回的可调用对象并不一定是原始的函数F,可以是任意其它可调用对象,比如另一个函数。但最终,这个返回的可调用对象都会被赋值给被装饰的函数变量(上例中的funcB)。

函数可以同时被多个装饰器装饰:

@decorator1
@decorator2
def func():...

当调用被装饰后的funcB时,将自动将funcB进行装饰,并调用装饰后的对象。所以,下面是等价的调用方式:

funcB()          # 调用装饰后的funcB
funcA(funcB)()

了解完函数装饰器的表现后,大概也能猜到了,装饰器函数可以用来扩展、增强另外一个函数。实际上,内置函数中staticmethod()、classmethod()和property()都是装饰器函数,可以用来装饰其它函数,在后面会学到它们的用法。

两个简单的例子

例如,函数f()返回一些字符串,现在要将它的返回结果转换为大写字母。可以定义一个函数装饰器来增强函数f()。

def toupper(func):
    def wrapper(*args, **kwargs):
        result = func(*args, **kwargs)
        return result.upper()
    return wrapper

@toupper
def f(x: str):    # 等价于f = toupper(f)
    return x

res = f("abcd")
print(res)

上面toupper()装饰f()后,调用f("abcd")的时候,等价于执行toupper(f)("abcd"),参数"abcd"传递给装饰器中的wrapper()中的*args,在wrapper中又执行了f("abcd"),使得原本属于f()的整个过程都完整了,最后返回result.upper(),这部分是对函数f()的扩展部分。

注意,上面的封装函数wrapper()中使用了*args **kwargs,是为了确保任意参数的函数都能正确执行下去。

再比如要计算一个函数autodown()的执行时长,可以额外定义一个函数装饰器timecount()。

import time

# 函数装饰器
def timecount(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(func.__name__, end - start)
        return result
    return wrapper

# 装饰函数
@timecount
def autodown(n: int):
    while n > 0:
        n -= 1

# 调用被装饰的函数
autodown(100000)
autodown(1000000)
autodown(10000000)

执行结果:

autodown 0.004986763000488281
autodown 0.05684685707092285
autodown 0.5336081981658936

上面wrapper()中的return是多余的,是因为这里装饰的autodown()函数自身没有返回值。但却不应该省略这个return,因为timecount()可以去装饰其它可能有返回值的函数。

@functools.wraps

前面的装饰器代码逻辑上没有什么问题,但是却存在隐藏的问题:函数的元数据信息丢了。比如doc、注解等。

比如下面的代码:

@timecount
def autodown(n: int):
    ''' some docs '''
    while n > 0:
        n -= 1

print(autodown.__name__)
print(autodown.__doc__)
print(autodown.__annotations__)

执行结果为:

wrapper
None
{}

所以,必须要将被装饰函数的元数据保留下来。可以使用functools模块中的wraps()装饰一下装饰器中的wrapper()函数。如下:

import time
from functools import wraps

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

现在,再去查看autodown函数的元数据信息,将会得到被保留下来的内容:

autodown
 some doc
{'n': <class 'int'>}

解除装饰

函数被装饰后,如何再去访问未被装饰状态下的这个函数?@wraps还有一个重要的特性,可以通过被装饰对象的__wrapped__属性来直接访问被装饰对象。例如:

autodown.__wrapped__(1000000)

new_autodown = autodown.__wrapped__
new_autodown(1000000)

上面的调用不会去调用装饰后的函数,所以不会输出执行时长。

注意,如果函数被多个装饰器装饰,那么通过__wrapped__,将只会解除第一个装饰过程。例如:

@decorator1
@decorator2
@decorator3
def f():...

当访问f.__wrapped__()的时候,只有decorator1被解除,剩余的所有装饰器仍然有效。注意,python 3.3之前是略过所有装饰器。

下面是一个多装饰的示例:

from functools import wraps

def decorator1(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("in decorator1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("in decorator2")
        return func(*args, **kwargs)
    return wrapper

def decorator3(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("in decorator3")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
@decorator3
def addNum(x, y):
    return x+y

返回结果:

in decorator1
in decorator2
in decorator3
5
in decorator2
in decorator3
5

如果不使用functools的@wraps的__wrapped__,想要手动去引用原始函数,需要做的工作可能会非常多。所以,如有需要,直接使用__wrapped__去调用未被装饰的函数比较好。

另外,并不是所有装饰器中都使用了@wraps

带参数的函数装饰器

函数装饰器也是可以带上参数的。

@decorator(x,y,z)
def func():...

它等价于:

func = decorator(x,y,z)(func)

它并不是"天生"就这样等价的,而是根据编码规范编写装饰器的时候,通常会这样。其实带参数的函数装饰器写起来有点绕:先定义一个带有参数的外层函数,它是外在的函数装饰器,这个函数内包含了真正的装饰器函数,而这个内部的函数装饰器的内部又包含了被装饰的函数封装。也就是函数嵌套了一次又一次。

所以,结构大概是这样的:

def out_decorator(some_args):
    ...SOME CODE...
    def real_decorator(func):
        ...SOME CODE...
        def wrapper(*args, **kwargs):
            ...SOME CODE WITH func...
        return wrapper
    return real_decorator

# 等价于func = out_decorator(some_args)(func)
@out_decorator(some_args)
def func():...     

下面是一个简单的例子:

from functools import wraps

def out_decorator(x, y, z):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            print(x)
            print(y)
            print(z)
            return func(*args, **kwargs)
        return wrapper
    return decorator

@out_decorator("xx", "yy", "zz")
def addNum(x, y):
    return x+y

print(addNum(2, 3))

参数随意的装饰器

根据前面介绍的两种情况,装饰器可以带参数、不带参数,所以有两种装饰的方式,要么是下面的(1),要么是下面的(2)。

@decorator         # (1)
@decorator(x,y,z)  # (2)

所以,根据不同的装饰方式,需要编写是否带参数的不同装饰器。

但是现在想要编写一个将上面两种参数方式统一起来的装饰器。

可能第一想法是让装饰器参数默认化:

def out_decorator(arg1=X, arg2=Y...):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            ...
        return wrapper
    return decorator

现在可以用下面两种方式来装饰:

@out_decorator()
@out_decorator(arg1,arg2)

虽然上面两种装饰方式会正确进行,但这并非合理做法,因为下面这种最通用的装饰方式会错误:

@out_decorator

为了解决这个问题,回顾下前面装饰器是如何等价的:

# 等价于 func = decorator(func)
@decorator
def func():...

# 等价于 func = out_decorator(x, y, z)(func)
@out_decorator(x, y, z)
def func():...

上面第二种方式中,out_decorator(x,y,z)才是真正返回的内部装饰器。所以,可以修改下装饰器的编写方式,将func也作为out_decorator()的其中一个参数:

from functools import wraps,partial

def decorator(func=None, arg1=X, arg2=Y):
    # 如果func为None,说明触发的带参装饰器
    # 直接返回partial()封装后的装饰器函数
    if func is None:
        decorator_new = partial(decorator, arg1=arg1, arg2=arg2)
        return decorator_new
        #return partial(decorator, arg1=arg1, arg2=arg2)

    # 下面是装饰器的完整装饰内容
    @wraps(func)
    def wrapper(*args, **kwargs):
        ...
    return wrapper

上面使用了functools模块中的partial()函数,如果不知道这个函数,参考partial()用法说明

现在,可以统一下面3种装饰方式:

@decorator()
@decorator(arg1=x,arg2=y)
@decorator

前两种装饰方式,等价的调用方式是decorator()(func)decorator(arg1=x,arg2=y)(func),它们的func都为None,所以都会通过partial()返回通常的装饰方式@decorator所等价的形式。

需要注意的是,因为上面的参数结构中包含了func=None作为第一个参数,所以带参数装饰时,必须使用keyword格式来传递参数,不能使用位置参数。

下面是一个简单的示例:

from functools import wraps, partial

def decorator(func=None, x=1, y=2, z=3):
    if func is None:
        return partial(decorator, x=x, y=y, z=z)

    @wraps(func)
    def wrapper(*args, **kwargs):
        print("x: ", x)
        print("y: ", y)
        print("z: ", z)
        return func(*args, **kwargs)
    return wrapper

下面3种装饰方式都可以:

@decorator
def addNum(a, b):
    return a + b
print(addNum(2, 3))

print("=" * 40)

@decorator()
def addNum(a, b):
    return a + b
print(addNum(2, 3))

print("=" * 40)

# 必须使用关键字参数进行装饰
@decorator(x="xx", y="yy", z="zz")
def addNum(a, b):
    return a + b
print(addNum(2, 3))

返回结果:

x:  1
y:  2
z:  3
5
====================
x:  1
y:  2
z:  3
5
====================
x:  xx
y:  yy
z:  zz
5

原文地址:https://www.cnblogs.com/f-ck-need-u/p/10198247.html

时间: 2024-08-06 23:23:58

python函数装饰器详解的相关文章

python之装饰器详解

这几天翻看python语法,看到装饰器这里着实卡了一阵,最初认为也就是个函数指针的用法,但仔细研究后发现,不止这么简单. 首先很多资料将装饰器定义为AOP的范畴,也就是Aspect Oriented Programming面向切面编程的概念,不懂AOP不要紧,只要有函数指针的概念,又有嵌套函数的基础知识,看懂此文一点压力都没有. 先说说为什么要有装饰器这么个东西存在吧,这是一种设计模式,较为经典的有插入日志.性能测试.事务处理等等.概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能. 关于

python函数装饰器

学习装饰器前提需要了解高阶函数,函数嵌套,函数闭包 python函数装饰器,顾名思义就是装饰函数,为函数添加新功能的的一种方式. 为什么要使用装饰器呢? 因为函数在运行时,如果不使用装饰器对函数进行功能添加,需要修改函数源代码,这样修改无疑会增加程序的冗余和复杂性,也不便于程序员对其进行修改.使用装饰器,可以在不改变函数源代码和调用方式的前提下,使用语法糖@装饰器,对函数功能进行添加. 装饰器本质上就是一个函数. 我们使用一个简单的例子来实现: import time #这是一个装饰器函数名为t

Python 函数装饰器入门

原文链接: --> A guide to Python's function decorators Python功能强劲,语法表现力强,尤其装饰器深深的吸引着我.在设计模式中,装饰器可以在不使用子类的情况下,动态的改变函数,方法以及类的功能.这个功能非常有用,特别在你想扩展函数的功能同时又不想改变原有的函数.的确,我们任意的实现装饰器设计模式,但是,python通过提供简单的语法和特性让装饰器的实现变的如此简单. 在本文中,我将用一组例子来深入浅入python 函数装饰器的功能,所有的例子都是在

Python装饰器详解,详细介绍它的应用场景

装饰器的应用场景 附加功能 数据的清理或添加: 函数参数类型验证 @require_ints 类似请求前拦截 数据格式转换 将函数返回字典改为 JSON/YAML 类似响应后篡改 为函数提供额外的数据 mock.patch 函数注册 在任务中心注册一个任务 注册一个带信号处理器的函数 不同应用场景下装饰器实现 函数注册表 简单注册表 funcs = [] def register(func): funcs.append(func) return func @register def a(): r

Python 3 之 装饰器详解

------------ 装饰器 ----------------------------------------------------- 什么是装饰器 装饰器是为函数和类指定管理代码的一种方式.装饰器本身的形式是处理其他的可调用对象的可调用对象(如函数).正如我们在本书前面所见到过的,Python装饰器以两种相关形式呈现: 函数装饰器在函数定义的时候进行名称重绑定,提供一个逻辑层来管理函数和方法或随后对它们调用. 类装饰器在类定义的时候进行名称重绑定,提供给一个逻辑层来管理类,或管理随后调用

python—函数装饰器

闭包 如果在一个内部函数(函数里的函数)里,对在外部作用域(但不是在全局作用域,可以理解为外层函数)的变量进行引用,那么内部函数就被认为是闭包. 例如: def outer(): x=10 # 这里x即为外部作用域变量 def inner(): print(x) return inner # inner函数被称为一个闭包 装饰器 写python代码一定要遵循开放封闭原则.即,可扩展功能,对源代码修改是封闭的.装饰是为函数和类指定管理代码的一种方式.装饰器本身的形式是处理其他的可调用对象的可调用的

Python装饰器详解

装饰器简介: 装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象.它经常用于有切面需求的场景,比如:插入日志.性能测试.事务处理.缓存.权限校验等场景.装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用. 一个简单装饰器写法: 在写装饰器之前我们需要简单了解下python语法糖@的用法 http://www.cnblogs.com/Egbertbaron/p/72425

Python全栈开发之8、装饰器详解

一文让你彻底明白Python装饰器原理,从此面试工作再也不怕了. 一.装饰器 装饰器可以使函数执行前和执行后分别执行其他的附加功能,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator),装饰器的功能非常强大,但是理解起来有些困难,因此我尽量用最简单的例子一步步的说明这个原理. 1.不带参数的装饰器 假设我定义了一个函数f,想要在不改变原来函数定义的情况下,在函数运行前打印出start,函数运行后打印出end,要实现这样一个功能该怎么实现?看下面如何用一个简单的装饰器来实现

这是我见过最全面的Python装饰器详解!没有学不会这种说法!

上面是按下按钮1就存款,否则则取款. 不对,存取款要输入密码啊!!!所以,我们要加密码验证代码. 进群:125240963  即可获取数十套PDF哦! 可以看到,虽然实现了密码验证功能,但是代码冗余度比较高,而且现在只模拟了取款和存款功能,然而还有查询功能,转账功能等等,那么冗余度就更高了,而且相对于取款和存款函数来说,复用性没有那么高,所以我们要进一步优化代码,把验证函数写到取款和存款函数内部. 有没有什么方法,可以在不改变原函数以及原函数的调用的情况下扩展原函数的功能呢?当然是有的,这就是p