欢迎访问宙启技术站
智能推送

写Python装饰器函数的方法和作用。

发布时间:2023-06-13 20:15:54

Python装饰器是Python语言中的一种函数,它可以用来增强或修改其他函数的行为。装饰器可以接收一个函数作为参数,然后在不修改这个函数源代码的基础上添加一些功能或修改其行为。Python装饰器的最大作用在于可以在不改变函数原来结构的情况下对它的功能做出扩展或修改。

装饰器是一种基于闭包和高阶函数的编程技术。Python中的函数可以作为参数传递到另一个函数中,这样的函数就是高阶函数。而闭包是指一个函数中定义的另一个函数,并且后者使用到了前者的变量。这些变量对于后者来说是自由变量,因为它们并不属于它们自己的作用域。当后者被返回给调用者时,它们就形成了一个闭包。在Python中,这种编程技术可以被用来实现装饰器函数。

Python装饰器函数的写法:

通常的装饰器函数定义如下

def decorator(f):
    def new_func(*args, **kwargs):
        # do something before f()
        f(*args, **kwargs)
        # do something after f()
    return new_func

在这个例子中,decorator函数接收一个函数参数f,它自身会返回一个带有不同功能的新函数new_func。这个新函数接收参数*args和**kwargs,可以用于传递任意类型的参数,包括函数本身。

举个例子,假设定义了一个函数f,需要在它执行之前和之后进行一些额外的操作,可以用如下方式来定义我们的decorator函数:

def decorator(f):
    def new_func(*args, **kwargs):
        print("Before calling function f")
        result = f(*args, **kwargs)
        print("After calling function f")
        return result
    return new_func

@decorator
def f(x):
    return x + 1

print(f(3))

在这个例子中,定义了一个函数f(x)、一个装饰器函数decorator(f),并把f传递给decorator,最终用@decorator将f函数装饰起来。

作用:

动态增加功能

Python装饰器函数让我们可以在不修改现有代码的情况下,动态地增加一些新的功能。我们只需要编写一个新的装饰器来增强现有的功能,然后用@decorator的方式把它们连接起来即可。

例如,我们想给一个函数添加一个计时器,以评估它的执行时间。我们可以编写一个计时器装饰器,然后将它应用到这个函数上,如下:

import time

def timing_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        res = func(*args, **kwargs)
        elapsed_time = time.time() - start_time
        print(f"Function {func.__name__} took {elapsed_time:.3f}s to run.")
        return res
    return wrapper

@timing_decorator
def my_func(n):
    return sum(range(n))

print(my_func(1000000))

在这个例子中,timing_decorator函数定义了一个装饰器,它接收一个函数参数,记录了该函数的执行时间,并在执行之后输出一个消息。用@timing_decorator装饰后的my_func函数接收一个参数n,返回1到n之间所有数字的和。

代码的执行结果如下:

Function my_func took 0.045s to run.
499999500000

通过装饰器,我们增加了一个计时器的功能,而且不需要修改原有的my_func函数。

代码重用

Python装饰器还可以帮助我们实现代码的重用。我们可以将一个装饰器用于多个函数,以减少代码的冗余。当我们需要修改一个功能的时候,只需要修改装饰器本身,所有应用了这个装饰器的函数都会受到影响。

例如,我们想让多个函数的返回结果保存到磁盘上。我们可以编写一个装饰器函数save_to_disk_decorator,它把函数的返回值存储到磁盘上,然后将其应用到多个函数上,比如:

import os

def save_to_disk_decorator(func):
    def wrapper(*args, **kwargs):
        res = func(*args, **kwargs)
        filename = f"{func.__name__}.txt"
        with open(filename, "w") as f:
            f.write(str(res))
        return res
    return wrapper

@save_to_disk_decorator
def my_func_1(n):
    return sum(range(n))

@save_to_disk_decorator
def my_func_2(n):
    return n ** 2

print(my_func_1(10))
print(my_func_2(5))
print(os.listdir("."))

在这个例子中,我们定义了一个save_to_disk_decorator装饰器函数,它接收一个函数参数func,在执行完func之后将结果存储到一个文件中。我们将它应用在两个函数上,分别是my_func_1(n)和my_func_2(n)。

当我们执行这个脚本时,它将生成两个文件my_func_1.txt和my_func_2.txt,包含函数的返回值。同时,它还会输出以下结果:

45
25
['my_func_1.txt', 'my_func_2.txt']

这证明两个函数的结果确实被存储到了两个不同的文件中。

函数注册

Python装饰器还可以用于函数的注册。我们可以在不修改源代码的情况下,为一些函数添加一些元数据,比如名称、描述等等。这在一些框架和库中特别常见,比如Django中的视图函数注册。Django会在运行时自动地将所有的视图函数注册到一个URL配置中,使用了装饰器语法@register_view_function。

例如,我们想定义一系列函数,并对它们应用一个注册装饰器—register_decorator。该装饰器将定义一个函数字典,并将所有被装饰的函数添加到字典中,然后可在其他地方访问这些函数。

functions = {}

def register_decorator(func):
    functions[func.__name__] = func
    return func

@register_decorator
def func_a():
    return "Hello World!"

@register_decorator
def func_b():
    return 42

print(functions)

该脚本将输出一个字典,它包含了两个函数func_a和func_b的信息:

{'func_a': <function func_a at 0x7f9b34b84ca0>, 'func_b': <function func_b at 0x7f9b34b84d08>}

这个装饰器非常简单,但是它为函数注册提供了一个结构化的、动态的解决方案。

总结

Python装饰器是一种非常强大的编程技术,它可以帮助我们在不修改函数源代码的情况下增强或修改函数的功能。装饰器本质上是一个函数,它接收一个函数参数,并返回一个新的函数。装饰器可以应用于多个函数,实现代码的重用;它还可以用于函数注册,将函数添加到一个字典或其他数据结构中。Python装饰器是面向对象设计的一种强大替代方案,在Python编程中发挥着重要作用。