Python 装饰器入门
在 Python 里写过几个函数之后,很多人都会遇到同一种重复劳动:给函数加日志、计时、缓存、权限检查……每个函数里都写一遍同样的代码,又啰嗦又容易改漏。装饰器就是为了解决这类“横切”需求而生的语法,它让你在不改动函数本身的前提下,给函数穿上一层“外衣”,把通用逻辑抽出来复用。
一、装饰器是什么
装饰器的本质是一个函数:它接收一个函数作为参数,返回一个新的函数。返回的新函数通常会在合适的时机调用原函数,并在调用前后做一些额外的事情。听起来有点绕,换个角度就清楚了:装饰器做的是“包装”,而不是“修改”。
打个比方,寄快递时物品本身不用变,只要在外面套一个包装盒、贴上运单,就可以寄走了。装饰器就是这个包装盒:被装饰的函数是物品,装饰器给它加上日志、计时这些“运单信息”,函数核心的业务逻辑一行都不用动。
Python 的函数是一等公民,可以像普通值一样被当作参数传递、作为返回值返回、赋值给变量。正是这个特性,让装饰器成为可能。没有一等函数,就没有装饰器。
二、@ 语法糖:装饰器的简写
手写包装的写法是这样的:先定义好装饰器,再写一句 greet = log(greet),把原函数替换成包装后的版本。这种写法能用,但不够直观,尤其当一个函数要套多层装饰器时,赋值语句会越写越多。
于是 Python 提供了 @ 语法糖:
@log
def greet(name):
return f"你好,{name}"
这行 @log 写在函数定义的上方,意思和 greet = log(greet) 完全等价,只是可读性更好。多个装饰器可以上下叠放,离函数最近的装饰器最先执行包装,执行顺序是从下往上、由内向外。
理解 @ 只是语法糖非常重要:它本身没有魔法,背后仍然是普通的函数调用和赋值。
三、一个计时/日志装饰器
下面写一个同时做日志和计时的装饰器 log_time,给任意函数加上“开始—结束—耗时”三行日志:
import time
import functools
def log_time(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
start = time.time()
print(f"开始执行 {func.__name__}...")
result = func(*args, **kwargs)
cost = time.time() - start
print(f"{func.__name__} 执行完毕,耗时 {cost:.3f} 秒")
return result
return wrapper
@log_time
def slow_work():
time.sleep(1)
return "完成"
print(slow_work())
把这段代码保存到 decorator_demo.py 里运行,会看到三行日志依次打印出来:开始执行、执行完毕和耗时。函数本身只管业务,耗时统计全部由装饰器承担。以后想给别的函数计时,只要在定义上方加一行 @log_time 就行,不用再复制粘贴计时代码。
四、functools.wraps 的作用
细心的读者可能注意到了,例子里的 wrapper 上方还写了一行 @functools.wraps(func)。它有什么用呢?
装饰器返回的是 wrapper 这个新函数,如果不做处理,被装饰函数的“身份信息”就会被 wrapper 覆盖:比如 slow_work.__name__ 会变成 'wrapper',文档字符串 __doc__ 也会丢掉。这会让调试、日志和文档生成工具都认不出原来的函数。
functools.wraps 的作用就是把原函数的元数据——函数名、文档字符串、模块名等——复制到 wrapper 身上,让包装后的函数“看起来还是原来的函数”。写装饰器时加上这一行,几乎是约定俗成的规范。
五、带参数的装饰器简介
有时候装饰器本身也需要参数,比如日志装饰器想让用户指定日志级别,或者重试装饰器想指定重试次数。这时就需要再包一层:外层函数接收装饰器的参数,返回真正的装饰器;真正的装饰器再接收被装饰的函数。
def repeat(times):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
for _ in range(times):
result = func(*args, **kwargs)
return result
return wrapper
return decorator
@repeat(3)
def say_hello():
print("你好")
调用 @repeat(3) 时,先执行 repeat(3) 得到装饰器,再用它去包装 say_hello。多了一层嵌套,思路还是一样的:函数返回函数。
小结
回顾一下:装饰器是接收函数、返回函数的函数;@ 只是让包装写法更简洁的语法糖;一个好的装饰器会用 functools.wraps 保留原函数的元数据;需要参数时就再包一层工厂函数。掌握装饰器之后,日志、计时、缓存、权限校验这些重复逻辑都可以写一次、到处复用,代码会立刻清爽很多。不妨从给自己的工具函数加一个计时装饰器开始,亲手试一试。
- 点赞
- 收藏
- 关注作者
评论(0)