如何利用“装饰器”模式为类方法增加自动化的执行耗时统计功能

风萱君_2184

风萱君_2184

2026-04-08

514人浏览

原创

@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 要用在最终可调用对象上,不是装饰器类本身。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5346

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1309

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5264

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1000

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1936

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3705

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4873

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3200

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1028

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习