Python中的装饰器|极客笔记

Python中的装饰器

在Python中，装饰器是一种特殊的函数，它可以修改其他函数的行为。装饰器经常用于添加功能，例如日志记录、性能测试、权限检查等。装饰器可以让代码更简洁、更具可重用性。

为什么需要装饰器

在讨论装饰器本身之前，我们先来看一下为什么需要装饰器。假设我们有一个函数，希望在函数执行前后打印一些日志信息：

def my_func():
    print('Starting function...')
    # do something
    print('Function finished.')

my_func()

这种方式虽然可以实现我们的需求，但是如果我们有很多函数都需要添加相同的日志功能，那么我们就需要重复写很多相似的代码。这样会导致代码冗余，不利于维护。

另外，如果我们后续需要修改日志功能的实现方式，那么就需要逐个修改所有的函数，这显然是不现实的。

这时候就需要装饰器出场了。装饰器可以帮助我们抽象出通用的功能，然后将这些功能应用到不同的函数上，使得代码更加简洁和易于维护。

装饰器的基本用法

下面我们来看一个简单的装饰器示例：

def my_decorator(func):
    def wrapper():
        print('Starting function...')
        func()
        print('Function finished.')
    return wrapper

@my_decorator
def my_func():
    print('Hello, world!')

my_func()

在上面的代码中，my_decorator是一个装饰器函数，它接收一个函数作为参数，并返回一个新的函数wrapper。wrapper函数在调用原始函数func前后打印了日志信息。

通过在my_func前面加上@my_decorator，我们实际上是将my_func传递给my_decorator，并将返回的新函数替换原来的my_func。

当我们调用my_func()时，实际上是调用了wrapper函数，这样就实现了在函数执行前后添加日志的功能。

装饰器的高级用法

装饰器还可以接收参数，让装饰器变得更加灵活。下面是一个带参数的装饰器示例：

def log(prefix):
    def my_decorator(func):
        def wrapper():
            print(f'{prefix}: Starting function...')
            func()
            print(f'{prefix}: Function finished.')
        return wrapper
    return my_decorator

@log(prefix='INFO')
def my_func():
    print('Hello, world!')

my_func()

在这个示例中，log函数是一个装饰器工厂，它接收一个参数prefix，并返回一个装饰器函数my_decorator。my_decorator函数接收一个函数参数func，并返回一个新的函数wrapper，在调用原始函数前后打印带有前缀的日志信息。

通过使用@log(prefix='INFO')，我们实际上是调用了log函数，并将返回的装饰器应用到my_func函数上。

嵌套装饰器

装饰器可以嵌套使用，即一个装饰器可以同时装饰另一个装饰器。这样可以实现更加复杂的功能组合。下面是一个嵌套装饰器的示例：

def log(prefix):
    def my_decorator(func):
        def wrapper():
            print(f'{prefix}: Starting function...')
            func()
            print(f'{prefix}: Function finished.')
        return wrapper
    return my_decorator

def uppercase(func):
    def wrapper():
        result = func()
        return result.upper()
    return wrapper

@log(prefix='INFO')
@uppercase
def my_func():
    return 'Hello, world!'

result = my_func()
print(result)

在这个示例中，uppercase装饰器将原始函数返回的结果转换为大写形式。通过使用@log(prefix='INFO')和@uppercase装饰器，我们先在函数执行前后打印日志，然后将结果转换为大写形式。

类装饰器

除了函数装饰器外，Python还支持类装饰器。类装饰器可以实现更加复杂的功能，例如保存状态、资源管理等。下面是一个类装饰器的示例：

class MyDecorator:
    def __init__(self, func):
        self.func = func

    def __call__(self):
        print('Starting function...')
        self.func()
        print('Function finished.')

@MyDecorator
def my_func():
    print('Hello, world!')

my_func()

在这个示例中，MyDecorator类实现了__init__和__call__方法，使得类的实例可以像函数一样调用。通过将类的实例MyDecorator应用到my_func函数上，我们实现了与函数装饰器相同的功能。

内置装饰器

Python内置了一些装饰器，可以用于定义和操作函数。其中最常见的包括@staticmethod和@classmethod。

@staticmethod装饰器用于定义静态方法，静态方法不会传入实例参数，适用于不需要操作实例数据的方法。

@classmethod装饰器用于定义类方法，类方法接收类对象作为第一个参数，适用于需要操作类数据的方法。

下面是一个使用内置装饰器的示例：

class MyClass:
    class_variable = 'class variable'

    def __init__(self, instance_variable):
        self.instance_variable = instance_variable

    @staticmethod
    def static_method():
        print('This is a static method.')

    @classmethod
    def class_method(cls):
        print('This is a class method.')
        print(cls.class_variable)

MyClass.static_method()
MyClass.class_method()

在这个示例中，static_method和class_method分别使用了@staticmethod和@classmethod装饰器定义了静态方法和类方法。通过类的实例和类对象可以调用这些方法。