让我们超越基础知识来深入了解装饰器。装饰器不仅仅是“额外的层”,而且提供了一种复杂的方法来动态地向函数添加功能,使它们具有高度的适应性和强大的功能。
1.什么是装饰器?
本质上,装饰器是一个高阶函数——一个接受另一个函数作为参数、添加功能并返回一个新函数的函数。这允许我们用附加功能“装饰”原始函数,而不改变原始函数。
语法回顾:
@decorator_name def my_function(): pass
在 my_function 之前使用 @decorator_name 是以下形式的简写:
my_function = decorator_name(my_function)
2.构建一个基本的装饰器
让我们构建一个简单的装饰器,在调用函数时记录日志。
def log_call(func): def wrapper(*args, **kwargs): print(f"calling {func.__name__}") return func(*args, **kwargs) return wrapper @log_call def greet(name): print(f"hello, {name}!") greet("alice") # outputs: calling greet, then hello, alice!
- log_call 是一个包装greet的装饰器。
- *args 和 `kwargs`** 确保它可以与任意数量的位置或关键字参数一起使用。
3.真实世界用例
装饰器通常用于:
- 访问控制:例如,检查用户权限。
- 缓存:存储昂贵的函数调用的结果。
- 重试机制:失败时自动重试函数。
- 输入验证:在函数运行之前检查参数。
4.带参数的装饰器
有时,装饰器需要额外的参数。在这些情况下,我们添加一个外部函数来将参数传递给装饰器。
示例:
def repeat(times): def decorator(func): def wrapper(*args, **kwargs): for _ in range(times): func(*args, **kwargs) return wrapper return decorator @repeat(3) def say_hello(): print("hello!") say_hello() # outputs "hello!" three times
这里,repeat 是一个装饰器工厂,它根据 times 参数生成一个装饰器。
5.堆叠装饰器
您可以在单个函数上堆叠多个装饰器,创建强大的行为链。
示例:
def make_bold(func): def wrapper(): return "<b>" + func() + "</b>" return wrapper def make_italic(func): def wrapper(): return "<i>" + func() + "</i>" return wrapper @make_bold @make_italic def greet(): return "hello!" print(greet()) # outputs: <b><i>hello!</i></b>
堆叠@make_bold和@make_italic以粗体和斜体标签迎接。
6.使用 functools.wraps 保存元数据
装饰函数时,您通常希望保留原始函数的元数据(如其名称和文档字符串)。使用 functools.wraps 确保您的包装器不会覆盖这些详细信息。
from functools import wraps def log_call(func): @wraps(func) def wrapper(*args, **kwargs): print(f"calling {func.__name__}") return func(*args, **kwargs) return wrapper
@wraps(func) 确保保留 func 的名称和文档字符串。
7.类中的装饰器
装饰器不仅仅用于独立功能;它们也可以与类方法一起使用。
示例:
def require_auth(method): @wraps(method) def wrapper(self, *args, **kwargs): if not self.is_authenticated: raise PermissionError("Authentication required.") return method(self, *args, **kwargs) return wrapper class User: def __init__(self, authenticated): self.is_authenticated = authenticated @require_auth def access_dashboard(self): return "Accessing dashboard!" user = User(authenticated=True) print(user.access_dashboard()) # Outputs: Accessing dashboard!
require_auth 装饰器在允许访问 access_dashboard 方法之前检查用户是否经过身份验证。
结论:用装饰器增强你的代码
装饰器是 python 的宝贵组成部分,它允许您以灵活且可重用的方式增强、修改和控制函数行为。它们使您的代码更具表现力、模块化和优雅。使用装饰器,您不仅可以添加功能,还可以完善和丰富您的代码库。