1. 装饰器基础
1.1 什么是装饰器?
装饰器本质上是一个 Python 函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能。装饰器的返回值也是一个函数对象。
1.2 语法糖:@ 符号
Python 提供了 @ 符号作为装饰器的语法糖,使得装饰器的使用更加简洁明了。
2. 创建简单装饰器
下面是一个简单的装饰器示例,用于记录函数执行时间:
import timedef timer_decorator(func):def wrapper(*args, **kwargs):start_time = time.time()result = func(*args, **kwargs)end_time = time.time()print(f"{func.__name__} executed in {end_time - start_time:.4f} seconds")return resultreturn wrapper# 使用装饰器
@timer_decorator
def slow_function():time.sleep(2)print("Function executed")slow_function()
在这个例子中,timer_decorator 是一个装饰器函数,它接受一个函数作为参数,并返回一个新的函数 wrapper。wrapper 函数在执行原函数前后记录时间,并打印执行时间。
3. 装饰器的工作原理
当使用 @decorator 语法糖时,Python 实际上做了以下几件事:
- 调用 decorator 函数,将目标函数作为参数传入。
- 装饰器函数返回一个新的函数(通常是包装函数)。
- 将目标函数的引用替换为新函数的引用。
因此,@timer_decorator 等价于 slow_function = timer_decorator(slow_function)。
4. 带参数的装饰器
有时候,我们可能需要为装饰器本身传递参数。这可以通过再嵌套一层函数来实现:
def repeat_decorator(times):def decorator(func):def wrapper(*args, **kwargs):for _ in range(times):result = func(*args, **kwargs)return resultreturn wrapperreturn decorator# 使用带参数的装饰器
@repeat_decorator(3)
def say_hello():print("Hello, World!")say_hello()
在这个例子中,repeat_decorator 是一个返回装饰器的函数,它接受一个参数 times,表示目标函数需要被执行的次数。
5. 保留原函数的元数据
使用装饰器后,原函数的元数据(如函数名、文档字符串等)可能会丢失。为了保留这些元数据,可以使用 functools 模块中的 wraps 装饰器:
from functools import wrapsdef my_decorator(func):@wraps(func)def wrapper(*args, **kwargs):print("Something is happening before the function is called.")result = func(*args, **kwargs)print("Something is happening after the function is called.")return resultreturn wrapper@my_decorator
def example_function():"""This is an example function."""print("Hello from example_function!")print(example_function.__name__) # 输出: example_function
print(example_function.__doc__) # 输出: This is an example function.
6. 装饰器的应用场景
- 日志记录:记录函数的调用时间、参数和返回值。
- 性能分析:测量函数的执行时间,找出性能瓶颈。
- 访问控制:根据用户权限决定是否允许执行函数。
- 事务处理:在函数执行前后开启和提交事务。
- 缓存:缓存函数的计算结果,避免重复计算。
装饰器是 Python 中一个非常强大的特性,它允许我们以一种优雅且灵活的方式扩展函数的功能。通过掌握装饰器的使用,我们可以编写出更加模块化、可重用和易于维护的代码。希望本文能够帮助你更好地理解和应用 Python 中的装饰器。