@timeit装饰器需实现__get__描述符协议以适配类方法,否则因self参数错位报TypeError;它在属性访问时动态绑定,在__call__中统计耗时,并用functools.wraps保留原方法元信息。

直接用 @timeit 装饰器就能给类方法加耗时统计,但别急着套模板——类方法里的 self 会让普通函数装饰器失效,必须用带描述符逻辑的装饰器,否则会报 TypeError: timeit() missing 1 required positional argument: 'func'。
为什么普通函数装饰器在类方法上会失效
因为 Python 在调用实例方法时,会自动把实例(self)作为第一个参数传入;而没处理绑定逻辑的装饰器,会在方法被查找时就执行包装,导致实际调用时参数错位。本质是没区分“未绑定方法”和“已绑定方法”。
常见错误现象:
- 装饰后调用报错:
TypeError: wrapper() takes 1 positional argument but 2 were given - 装饰器提前运行(类定义阶段就打印耗时),而非每次调用时统计
- 静态方法或类方法被误当实例方法处理,
self变成第一个真实参数
用描述符协议实现可绑定的 @timeit
核心是让装饰器对象支持 __get__,由 Python 在属性访问时自动注入 self 或 cls。这样既能适配实例方法,也能兼容 @classmethod 和 @staticmethod。
实操建议:
- 不要用
functools.wraps直接包最外层类——它只处理函数,不解决绑定问题 - 在
__get__中判断obj(实例)和owner(类)是否存在,决定返回绑定后的包装器还是原装饰器 - 耗时统计逻辑放在实际调用时(即包装后的
__call__),而非__get__阶段
简短示例:
class timeit:
def __init__(self, func):
self.func = func
def __get__(self, obj, owner):
if obj is None:
return self
# 返回一个绑定到 obj 的可调用对象
import functools
return functools.partial(self.__call__, obj)
def __call__(self, *args, **kwargs):
import time
start = time.time()
result = self.func(*args, **kwargs)
print(f"{self.func.__name__} took {time.time() - start:.4f}s")
return result
更稳妥的做法:用 functools.singledispatchmethod + 显式绑定判断
如果项目已用 Python 3.8+,且需要统一处理实例方法、类方法、静态方法,比手写描述符更清晰的方式是:装饰器内部检查 args[0] 类型,再分发逻辑。但这要求调用方保持参数顺序一致,不如描述符协议健壮。
关键差异点:
-
@timeit加在@staticmethod上时,args[0]是第一个业务参数,不是self—— 必须靠inspect.signature提前分析原始函数的绑定类型 - 性能影响极小(单次调用多一次
time.time()和字符串格式化),但若方法被高频调用(如循环内),应允许开关统计:@timeit(enabled=os.getenv('DEBUG_TIMEIT')) - 日志输出建议走
logging而非print,避免和单元测试捕获冲突
最容易被忽略的是:装饰器返回的包装器必须保留原方法的 __name__、__doc__ 和签名,否则像 help() 或 IDE 自动补全会失效;functools.wraps 要用在最终可调用对象上,不是装饰器类本身。










