导语:装饰器是Python非常强大的功能之一,它们允许程序员修改或增强已有函数或方法的行为,而无需更改其本身的代码,这篇文章,让我们一起来看看(我自己这里理解的也不是很透彻)
----------更正---------
写完这篇文章,敲了不少示例,我感觉我透彻了
目录
装饰器基础
装饰器简介
创建简单的装饰器
示例:一个简单的装饰器
装饰器的工作原理
装饰器的使用场景
装饰器进阶
带参数的装饰器
示例:带参数的装饰器
示例:通用装饰器
装饰器的嵌套
示例:装饰器嵌套
装饰器的实际应用
日志记录装饰器
示例:日志记录装饰器
性能测试装饰器
示例:性能测试装饰器
权限校验和认证
示例:权限校验装饰器
注意事项
tips
注意!
装饰器基础
装饰器简介
在Python中,装饰器是一种特殊的函数,它允许修改或增强其他函数或方法的功能,而不需要更改其自身代码。装饰器可以看作是对函数进行包装的包装器,它们在不修改原始函数的情况下,提供了一种灵活的方式来添加新功能。
创建简单的装饰器
装饰器本身是一个函数,它接收一个函数作为参数,并返回一个新的函数。使用装饰器的常见方式是使用@
语法,称为语法糖。
示例:一个简单的装饰器
def simple_decorator(func):def wrapper():print("函数前========")func()print("函数后========")return wrapper@simple_decorator
def say_hello():print("Hello world!")say_hello()
输出结果:
在这个例子中,simple_decorator
是一个装饰器,它在被装饰的函数say_hello
执行前后添加了额外的打印语句。
装饰器的工作原理
当你使用@simple_decorator
时,Python会执行以下步骤:
- 将
say_hello
函数作为参数传递给simple_decorator
函数。 simple_decorator
函数返回wrapper
函数。say_hello
现在指向wrapper
函数。
当我调用say_hello()
时,实际上是在调用wrapper()
函数。
装饰器的使用场景
- 日志记录:自动记录函数的调用细节。
- 性能测试:测量和报告函数的执行时间。
- 访问控制和认证:在函数执行前进行权限校验。
- 缓存和备忘:存储函数的结果以避免重复计算。
装饰器进阶
带参数的装饰器
在某些情况下,你可能需要让装饰器接受额外的参数。这可以通过在装饰器外层再添加一个函数来实现。
示例:带参数的装饰器
def repeat(num_times):def decorator_repeat(func):def wrapper(*args, **kwargs):for _ in range(num_times):value = func(*args, **kwargs)return valuereturn wrapperreturn decorator_repeat@repeat(num_times=3)
def greet(name):print(f"Hello {name}")greet("World")
输出结果:
在这个示例中,repeat
是一个接受参数的装饰器工厂函数,它返回一个装饰器。这个装饰器随后应用于greet
函数。
注意 !
为了使装饰器更通用,能够适用于任意参数的函数,通常会在内部函数wrapper
中使用*args
和**kwargs
。
示例:通用装饰器
def debug(func):def wrapper(*args, **kwargs):args_repr = [repr(a) for a in args]kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]signature = ", ".join(args_repr + kwargs_repr)print(f"===》 {func.__name__}({signature})")value = func(*args, **kwargs)print(f"{func.__name__!r} 返回的是: {value!r}")return valuereturn wrapper@debug
def make_greeting(name, age=None):greeting = f"{name}!"if age:greeting += f" 你今年 {age} 岁了"return greetingprint(make_greeting("小明", age=25))
返回结果:
在这个例子中,debug
装饰器打印被装饰函数的调用细节,包括函数名称、传递的参数和返回值。
装饰器的嵌套
装饰器可以嵌套使用,这意味着你可以在一个函数上应用多个装饰器,从而将多个功能叠加到该函数上。
示例:装饰器嵌套
#上面省略@debug
@repeat(num_times=2)
def say_hello(name):greeting = f"Hello {name}"print(greeting)return greetingsay_hello("Alice")
在这个例子中,say_hello
函数同时被debug
和repeat
装饰器装饰。装饰器的应用顺序是从最接近函数定义的装饰器开始向外应用
装饰器的实际应用
装饰器不仅是一个理论概念,它们在实际编程中有着广泛的应用。通过具体的例子,我们可以更好地理解装饰器如何在各种情况下提供优雅的解决方案。
日志记录装饰器
在应用程序中,跟踪函数的调用细节对于调试和性能分析非常重要。装饰器可以用来自动记录函数的调用和返回信息。
示例:日志记录装饰器
在这个例子中,log
装饰器记录了函数名、参数和返回值。
import loggingdef log(func):def wrapper(*args, **kwargs):logging.info(f"Running {func.__name__} with arguments {args} and {kwargs}")output = func(*args, **kwargs)logging.info(f"{func.__name__} returned {output}")return outputreturn wrapper@log
def add(x, y):return x + y
性能测试装饰器
测量函数的执行时间是性能分析中的常见需求。装饰器可以被用来自动化这个过程。
示例:性能测试装饰器
在这个例子中,timeit
装饰器测量并打印了函数的执行时间。
import timedef timeit(func):def wrapper(*args, **kwargs):start_time = time.time()result = func(*args, **kwargs)end_time = time.time()print(f"{func.__name__} took {end_time - start_time} seconds to run.")return resultreturn wrapper@timeit
def do_some_heavy_lifting():time.sleep(2)return "Task completed"
权限校验和认证
装饰器可以用于在函数执行前进行权限检查,这在Web开发和API设计中尤其有用。
示例:权限校验装饰器
在这个例子中,authorized
装饰器检查用户是否具有执行特定函数的权限。
def authorized(roles):def decorator(func):def wrapper(*args, **kwargs):if user.role not in roles:raise Exception("Unauthorized")return func(*args, **kwargs)return wrapperreturn decorator@authorized(["admin", "user"])
def update_database():print("Database updated")
注意事项
tips
- 使用
functools.wraps
装饰器来保留原函数的元数据(如名称和文档字符串)。 - 虽然装饰器是一个强大的工具,但过度使用它们会使代码变得难以理解和维护。
- 尽可能编写通用的装饰器,以便在不同的函数和项目中重用。
- 给装饰器取一个清晰、描述性的名称,让其他开发者一眼就能理解装饰器的功能。
注意!
-
改变函数签名:使用
*args
和**kwargs
来接受任意数量的参数,这样可以确保装饰器不会因为函数参数更改而失败。 -
深层嵌套装饰器的复杂性:嵌套太多层装饰器可能会使代码变得复杂难懂。在可能的情况下,尝试将多个功能合并到一个装饰器中,或重构代码以减少嵌套。
-
装饰器与函数绑定:记住装饰器在定义时就绑定到其装饰的函数上,这意味着它们不能轻易地被重新应用于其他函数或方法。
-
状态管理:如果装饰器维护状态(比如计数),需要确保状态管理的线程安全和一致性。
--------------------------------
以上,欢迎评论交流、点个赞再走吧~