为什么使用functools.wraps装饰器打印函数调用参数会出现多余逗号?
打印函数入参返回值的装饰器出现单参数拖尾逗号问题
问题背景
我们希望通过装饰器实现「打印每次函数调用的入参与返回值」的能力,示例代码如下:
from functools import wraps def trace(func): @wraps(func) def wrapper(*args): result = func(*args) print(f'{func.__name__}{args!r}' f'->{result!r}') return result return wrapper @trace def fibo(n): if n in (0, 1): return n return fibo(n-2)+fibo(n-1) fib = trace(fibo) fib(3)
运行后输出结果为:
fibo(1,)->1 fibo(0,)->0 fibo(1,)->1 fibo(2,)->1 fibo(3,)->2 fibo(3,)->2
可以看到,所有单参数调用的打印结果中,参数列表末尾都会多一个逗号,和日常书写函数调用的格式不一致。
拖尾逗号的成因
- 装饰器内部
*args本质是捕获所有位置参数生成的元组类型,当前代码直接通过args!r将元组的Python原生字符串表示(repr)拼接进打印内容。 - Python对单元素元组有固定的repr规则:必须在元素后追加拖尾逗号,用来区分数值本身和单元素元组。这是Python的语法强制要求——如果要定义合法的单元素元组,必须写为带拖尾逗号的形式,否则括号仅作为提升运算优先级的符号存在,不会生成元组类型(例如
(1,)是合法单元素元组,而(1)只是被括号包裹的整数)。 - 这个拖尾逗号是元组类型的官方标准格式,不属于打印逻辑错误,只是这种格式和我们日常写的函数调用格式不匹配。
修复方法
不要直接使用args元组的原生repr,手动按照函数调用的常规书写格式拼接参数字符串即可:
- 遍历捕获到的所有位置参数,单独对每个参数取repr值
- 用逗号作为分隔符拼接所有参数的repr值
- 用括号包裹拼接好的参数串,替换原来直接打印元组的逻辑
调整后的装饰器代码如下(同时支持捕获关键字参数,适配更多调用场景):
from functools import wraps def trace(func): @wraps(func) def wrapper(*args, **kwargs): # 拼接位置参数和关键字参数的打印格式 args_repr = [repr(arg) for arg in args] kwargs_repr = [f"{key}={val!r}" for key, val in kwargs.items()] params = ", ".join(args_repr + kwargs_repr) result = func(*args, **kwargs) print(f"{func.__name__}({params}) -> {result!r}") return result return wrapper
调整后运行输出将完全符合日常书写习惯,不再出现多余的拖尾逗号:
fibo(1) -> 1 fibo(0) -> 0 fibo(1) -> 1 fibo(2) -> 1 fibo(3) -> 2 fibo(3) -> 2
注:示例代码中最后一行
fib = trace(fibo)会对已经被@trace装饰的fibo函数再套一层trace装饰器,因此最外层的fib(3)调用会多触发一次打印逻辑,这和拖尾逗号的问题无关。
内容的提问来源于stack exchange,提问作者mhhabib
相关产品推荐
相关产品推荐

