博客

Python 高阶函数的装饰器

  • Post category:Python

我们来详细讲解一下Python高级函数的装饰器使用方法。

什么是装饰器？

装饰器是 Python 中的一种高级函数，能够在不改变函数定义及调用方式的前提下，对函数的功能进行扩展和增强。装饰器本质上是一个返回函数或者返回类的高阶函数（函数或类可以看作是 Python 中特殊的对象）。

装饰器的常见用途

  1. 记录日志：对于某些需要频繁调用的函数，我们可以使用装饰器来自动记录它们的执行时间、执行日志等信息。
  2. 统计耗时：我们可以使用装饰器来统计某个函数执行的时间，进而分析性能瓶颈。
  3. 缓存：有些函数可能需要经常访问数据库或网络资源，为了加快访问速度，我们可以使用装饰器来实现缓存，减少重复访问。
  4. 授权验证：有些函数可能需要特定的身份才能调用，我们可以使用装饰器来验证调用者的身份。
  5. 重试机制：有些函数容易出错，我们可以使用装饰器来进行自动重试，直到成功为止。

Python装饰器使用步骤

下面，我们来介绍具体的使用步骤。

定义装饰器函数

装饰器其实就是一个函数，它可以用来包装另一个函数，以达到增强其功能的目的。

def my_decorator(func):
    def wrapper():
        print("Before function is called.")
        func()
        print("After function is called.")
    return wrapper

上面定义了一个名为my_decorator的装饰器函数，该函数接收一个函数（也称为可调用对象）作为参数，并返回一个内部函数wrapper()。在wrapper()内部，我们可以添加一些代码来实现增强功能。在本例中，wrapper()函数首先会打印一条“Before function is called.”的消息，然后调用传入的函数（也就是我们需要增强的函数）并进行相应的操作，在参数函数调用完毕之后，再次打印一条消息“After function is called.”。最后，my_decorator函数将wrapper()内部函数返回。

使用装饰器

在定义了装饰器之后，我们就可以将其应用到目标函数上了。

@my_decorator
def say_hello():
    print("Hello, world!")

上面的代码中，我们使用了@my_decorator来将say_hello函数传递给my_decorator函数进行装饰。这样，在我们调用say_hello()时，实际上是调用了wrapper()函数。

say_hello()
# 执行结果为：
# Before function is called.
# Hello, world!
# After function is called.

上面的输出结果经过装饰器函数的增强，成功地在say_hello()函数调用前后添加了相应的处理逻辑。

带参数的装饰器

有时候，我们需要编写一个可以接收参数的装饰器，以实现更加灵活的功能。在这种情况下，我们需要在装饰器函数中再嵌套一层函数。

def my_decorator_with_param(logger):
    def wrapper(func):
        def inner_wrapper():
            logger.info("Before function is called.")
            func()
            logger.info("After function is called.")
        return inner_wrapper
    return wrapper

上面定义的my_decorator_with_param函数接收一个名为logger的参数，并返回一个内部函数wrapper()，该函数又返回一个新的内部函数inner_wrapper()。在inner_wrapper()函数内部，我们调用了传入的参数函数，并在其前后加入了相应的日志输出信息。其中，logger参数可以用于指定输出日志的方式（例如，可以将日志打印到终端或记录到文件等）。

使用带参数的装饰器

在使用带参数的装饰器时，需要使用两次@符号，其中第一次是传入装饰器的参数，第二次是将需要装饰的函数传递给装饰器。

import logging

def say_hello():
    print("Hello, world!")

@my_decorator_with_param(logging.getLogger(__name__))
def log_say_hello():
    say_hello()

log_say_hello()
# 执行结果为：
# INFO:<__main__>:Before function is called.
# Hello, world!
# INFO:<__main__>:After function is called.

上面的示例中，我们先定义了一个名为say_hello的函数，该函数将作为我们需要增强的目标。然后，我们使用带有参数的装饰器对该函数进行装饰，打印了对应的日志输出结果。

常用的装饰器

Python内建了一些常用的装饰器，可以用来装饰内置函数、方法和类等。

@staticmethod

用于声明一个静态方法，即不需要将self作为第一个参数的方法。

class MyClass:
    @staticmethod
    def my_static_method():
        print("This is a static method.")

MyClass.my_static_method()
# 执行结果为：This is a static method.

@classmethod

用于声明一个类方法，即第一个参数是当前类的方法。

class MyClass:
    @classmethod
    def my_class_method(cls):
        print("This is a class method of", cls.__name__)

MyClass.my_class_method()
# 执行结果为：This is a class method of MyClass

@property

用于将一个方法转换成只读的属性。

class MyClass:
    def __init__(self):
        self._my_property = "This is a property."

    @property
    def my_property(self):
        return self._my_property

my_instance = MyClass()
print(my_instance.my_property)
# 执行结果为：This is a property.

总结

Python装饰器是Python中非常强大的一项功能，主要用于增强函数的功能、定制函数的行为、在函数运行前后进行额外的操作等。使用装饰器可以大大减少代码的冗余和复杂度，提高代码的可维护性和可读性。在编写Python程序的过程中，合理地使用装饰器可以帮助我们编写出更加健壮和高效的代码，让我们的Python程序更加清晰、美观和优雅。

Tags: