python装饰器

最新推荐文章于 2025-08-12 18:06:10 发布

原创最新推荐文章于 2025-08-12 18:06:10 发布 · 71 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#python

文章目录

装饰器

装饰器

首先看一个例子：

@func1
def func()：
	print("aaa")

装饰器存在的意义：

不影响原有的函数的功能
可以添加新功能

一般常见的，比如拿到第三方的API接口，第三方不允许修改这个接口。这个时候，装饰器就派上用场了。

装饰器本身也是一个函数，作用是为现有存在的函数，在不改变函数的基础上，增加一些功能进行装饰。

它是以闭包的形式去实现的。

在使用装饰器函数时，在被装饰的函数的前一行，使用@装饰器函数名形式来进行装饰。

例子：

现在在一个项目中，有很多函数，由于我们的项目越来越大，功能也越来越多，这会导致程序越来越慢。其中一个功能函数的功能，是实现一百万次的累加。

def my_count():
    s = 0
    for i in range(1000001):
        s += i
    print("sum: ", s)

假如我们要计算函数运行的时间，该如何运行？

import time


def my_count():
    s = 0
    for i in range(1000001):
        s += i
    print("sum: ", s)


start = time.time()
my_count()
end = time.time()

print("执行时间为：", (end - start))

# sum:  500000500000
# 执行时间为： 0.04692530632019043

成功的实现时间的计算。但是，假如有成千上万个函数。每个函数这么写一遍，非常麻烦，代码量也凭空增加很多。

明显不符合开发原则，代码太过冗余。

考虑直接将上述代码中的时间计算转化为函数。

import time


def my_count():
    s = 0
    for i in range(1000001):
        s += i
    print("sum: ", s)


def count_time(func):
    start = time.time()
    func()
    end = time.time()
    print("执行时间为：", (end - start))


count_time(my_count)

# sum:  500000500000
# 执行时间为： 0.06248950958251953

经过修改后，定义一个函数来实现时间计算功能。

初看上去，比之前好很多。

只是在使用时，需要将对应的函数传入到时间计算函数中。

但仍然影响了原来的使用

接下来思考，能不能在使用时不影响函数的原来的使用方式，同时实现时间计算？

考虑闭包

import time


def count_time(func):
    def wrapper():
        start = time.time()
        func()
        end = time.time()
        print("执行时间为：", (end - start))

    return wrapper


def my_count():
    s = 0
    for i in range(1000001):
        s += i
    print("sum: ", s)


count_time(my_count)  # 仍然更改了调用方法

在使用时，让my_count函数重新指向count_time函数返回的函数引用。这样使用my_count时，就和原来的使用方式一样了。

实现就是采用装饰器。

import time


def count_time(func):
    def wrapper():
        start = time.time()
        func()
        end = time.time()
        print("执行时间为：", (end - start))

    return wrapper


@count_time
def my_count():
    s = 0
    for i in range(1000001):
        s += i
    print("sum: ", s)


my_count()

'''
sum:  500000500000
执行时间为： 0.07813215255737305
'''

这样实现的好处，定义闭包函数后，只需要通过@装饰器函数名形式的装饰器语法，就可以将@装饰器函数名加到要装饰的函数前即可。

这种不改变原有函数功能，对函数进行拓展的形式，就称为“装饰器”。

在执行@装饰器函数名时，就是将原函数传递到闭包中。然后，原函数的引用指向闭包返回的装饰过的内部函数的引用。

装饰器的几种形式

1、无参无返回值

def setFunc(func):
    def wrapper():
        print("Start")
        func()
        print("end")

    return wrapper


@setFunc
def show():
    print("show")
    

show()

'''
Start
show
end
'''

def setFunc(func):
    def wrapper():
        print("Start")
        func()
        print("end")

    return wrapper


def show():
    print("show")


setFunc(show)()

# 结果同上

2、无参有返回值

def setFunc(func):
    def wrapper():
        print("Start")
        return func()
        print("end")   # 遇到return，此句不再执行

    return wrapper


@setFunc
def show():
    return "show"


print(show())

'''
Start
show
'''

3、有参数无返回值

def setFunc(func):
    def wrapper(s):
        print("Start")
        func(s)
        print("end")  

    return wrapper


@setFunc
def show(s):
    print("helllo %s" % s)


show("City College")

'''
Start
helllo City College
end
'''

4、有参有返回值

def setFunc(func):
    def wrapper(x, y):
        print("Start")
        return func(x, y)

    print("end")

    return wrapper


@setFunc
def myAdd(x, y):
    return x + y


print(myAdd(3, 3))

'''
end
Start
6
'''

万能装饰器

根据被装饰函数的定义不同，分出了四种形式。

能不能实现一种，适用于任何形式函数定义的装饰器？

通过可变参数，接受不同数据类型

def setFunc(func):
    def wrapper(*args, **kwargs):
        print("Wrapper context.")
        return func(*args, **kwargs)

    return wrapper


@setFunc
def func(name, age, job="IT"):
    print(name, age, job)


func("Tom", 18, "Student")


@setFunc
def demo(a, b, *c, **d):
    print((a, b))
    print(c)
    print(d)


demo("city", "College", 1999, 1, 1, school="Zhejiang Univesity")

'''
Wrapper context.
Tom 18 Student
Wrapper context.
('city', 'College')
(1999, 1, 1)
{'school': 'Zhejiang Univesity'}
'''

函数被多个装饰器所装饰

一个函数在使用时，通过一个装饰器来拓展，可能并不能达到预期。

这时候我们可以考虑一个函数被多个装饰器所装饰。

# 装饰器1
def setFunc1(func):
    def wrapper1(*args, **kwargs):
        print("Wrapper Context 1 Start.".center(40, '-'))
        func(*args, **kwargs)
        print("Wrapper Context 1 End".center(40, '-'))

    return wrapper1


# 装饰器2       
def setFunc2(func):
    def wrapper2(*args, **kwargs):
        print("Wrapper Context 2 Start.".center(40, '-'))
        func(*args, **kwargs)
        print("Wrapper Context 2 End".center(40, '-'))

    return wrapper2


@setFunc1                                    # ---> F
@setFunc2                                    # ---> g
def show(*args, **kwargs):                   # ---> f
    print("Show Run".center(40, '-'))


show()  # F(g(f))

# 从下往上去装饰（程序语句运行顺序来看）
# 从内往外去装饰（函数的调用来看）

'''
--------Wrapper Context 1 Start.--------
--------Wrapper Context 2 Start.--------
----------------Show Run----------------
---------Wrapper Context 2 End----------
---------Wrapper Context 1 End----------
'''

def func1(func):
    print("out11".center(40, '_'))

    def inner(*args, **kwargs):
        print("in11".center(40, '_'))
        func(*args, **kwargs)
        print("in12".center(40, '_'))

    print("out12".center(40, '_'))
    return inner


def func3(func):
    print("out31".center(40, '_'))

    def inner(*args, **kwargs):
        print("in31".center(40, '_'))
        func(*args, **kwargs)
        print("in32".center(40, '_'))

    print("out32".center(40, '_'))
    return inner


def func2(func):
    print("out21".center(40, '_'))

    def inner(*args, **kwargs):
        print("in21".center(40, '_'))
        func(*args, **kwargs)
        print("in22".center(40, '_'))

    print("out22".center(40, '_'))
    return inner


@func1
@func2
@func3
def func():
    print("test")


if __name__ == '__main__':
    func()

'''
_________________out31__________________
_________________out32__________________
_________________out21__________________
_________________out22__________________
_________________out11__________________
_________________out12__________________
__________________in11__________________
__________________in21__________________
__________________in31__________________
test
__________________in32__________________
__________________in22__________________
__________________in12__________________
'''