如何写Python装饰器来提高函数功能？

Python装饰器是一种特殊的函数，可以在不修改原函数代码的情况下添加新的功能。它是Python语言中非常有用的特性，可以提高函数的可重用性、可维护性和可扩展性。本文将介绍如何编写Python装饰器来提高函数功能。

一、Python装饰器的基本语法

Python装饰器是一个函数，其接收一个函数对象作为参数，并返回一个新的函数对象。它的基本语法如下：

def decorator_func(func):
    def wrapped_func(*args, **kwargs):
        # 执行装饰器逻辑
        result = func(*args, **kwargs)
        # 返回函数结果
        return result
    # 返回装饰器函数
    return wrapped_func

@decorator_func
def original_func():
    pass

其中，decorator_func是一个装饰器函数，它接收一个函数对象作为参数，返回一个新的函数对象wrapped_func来代替原函数。@decorator_func是Python的语法糖，用于将装饰器函数应用到原函数上。

二、Python装饰器的实现方式

Python装饰器有多种实现方式，如函数装饰器、类装饰器和参数化装饰器等，下面分别进行介绍。

1. 函数装饰器

函数装饰器是最常见的Python装饰器，它可以为一个函数添加新的功能，如日志记录、性能分析、缓存等。下面是一个简单的函数装饰器的例子：

import time

def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"Time elapsed: {end_time - start_time}")
        return result
    return wrapper

@timer
def my_function(x):
    time.sleep(1)
    return x * 2

print(my_function(10))

这个函数装饰器会输出函数的执行时间，可以用于性能分析。

2. 类装饰器

类装饰器是一种用于装饰类的装饰器，它可以在类定义时应用，并修改类的行为。下面是一个类装饰器的例子，用于给类添加一个新的方法：

def new_method(method):
    def decorator(cls):
        setattr(cls, method.__name__, method)
        return cls
    return decorator

@new_method
class MyClass:
    def existing_method(self):
        print("Existing method")

def new_method_to_add(self):
    print("New method")

obj = MyClass()
obj.existing_method() # 输出："Existing method"
obj.new_method_to_add() # 报错："MyClass" object has no attribute "new_method_to_add"

这个类装饰器会为类添加一个新的方法new_method_to_add，可以用于类的扩展。

3. 参数化装饰器

参数化装饰器是一种装饰器，可以接收参数并返回一个装饰器函数。下面是一个参数化装饰器的例子，用于给函数添加一个新的功能：

def repeat(num):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for i in range(num):
                result = func(*args, **kwargs)
                print(f"Iteration {i+1}, result: {result}")
            return result
        return wrapper
    return decorator

@repeat(num=3)
def my_function():
    return "Hello World"

my_function()

这个参数化装饰器会调用函数3次，并输出每次调用结果，可以用于调试和测试。

三、Python装饰器的常见应用场景

Python装饰器可以应用于各种场景，下面介绍几种常见的应用场景。

1. 日志记录

日志记录是一种常见的应用场景，可以利用Python装饰器记录函数的调用和返回结果，以便进行错误分析和调试。

import logging

logging.basicConfig(level=logging.INFO)

def log_decorate(func):
    def wrapper(*args, **kwargs):
        logging.info(f"Calling function '{func.__name__}' with args {args} and kwargs {kwargs}")
        result = func(*args, **kwargs)
        logging.info(f"Function '{func.__name__}' returns '{result}'")
        return result
    return wrapper

@log_decorate
def my_func(x, y):
    return x + y

my_func(1, 2)

这个日志记录装饰器会输出函数调用和返回结果，以方便进行分析和调试。

2. 缓存

缓存是一种用于提高函数执行效率的装饰器，可以利用Python的dict数据结构实现。

def cache(func):
    cache_dict = {}
    def wrapper(*args, **kwargs):
        key = f"{str(args)}{str(kwargs)}"
        if key not in cache_dict:
            cache_dict[key] = func(*args, **kwargs)
        return cache_dict[key]
    return wrapper

@cache
def my_func(x, y):
    print("Function is running")
    return x + y

print(my_func(1, 2)) # 运行
print(my_func(1, 2)) # 不运行，从缓存读取
print(my_func(2, 3)) # 运行

这个缓存装饰器会在 次函数调用时运行函数，之后会从缓存中读取结果，以提高函数执行效率。

3. 权限控制

权限控制是一种用于控制函数访问权限的装饰器，可以利用Python语言的特性实现。

def admin_only(func):
    def wrapper(user_info):
        if user_info.get("is_admin"):
            return func(user_info)
        else:
            raise Exception("Access Denied")
    return wrapper

@admin_only
def modify_user_info(user_info):
    # 修改用户信息的业务逻辑
    pass

modify_user_info({"name": "Tom", "is_admin": True})

这个权限控制装饰器可以控制只有管理员才能调用修改用户信息函数，以提高系统安全性。

四、总结

Python装饰器是Python语言的一种高级特性，可以用于增强函数的功能或修改类的行为。Python装饰器具有函数式编程的特点，可以让代码更加简洁、灵活和易于维护。Python装饰器的应用场景非常广泛，可以应用于日志记录、缓存、权限控制等各种场景。这些常见的装饰器可以极大地提高代码的可重用性、可维护性和可扩展性，是Python编程中必须掌握的技能之一。