【教程】Python 统计函数调用的耗时

原创

小锋学长生活大爆炸

发布于 2024-04-25 20:48:15

31900

代码可运行

文章被收录于专栏：学习之旅学习之旅

运行总次数：0

代码可运行

相比于timerit等装饰器用法，我希望能不修改函数，只统计函数调用的用时。常规方法是在函数调用前后添加time，比如：

# 开始计时
start_time = time.perf_counter()
 
# 调用函数
x = xxx()
 
# 结束计时
end_time = time.perf_counter()

但如果有很多这样的函数，每次都写这么多实在太麻烦。

实际上我们可以通过with的方式来计时。所以，代码如下：

import time
 
class Timer:
    """
    一个计时上下文管理器，用于测量代码块的执行时间。
    它可以根据用户的需求以秒或纳秒为单位测量时间。
    
    属性:
        use_ns (bool): 如果为True，则计时器以纳秒为单位测量时间；如果为False，则以秒为单位。
        start (float|int): 测量开始的时间。
        end (float|int): 测量结束的时间。
        interval (float|int): 计算的开始和结束时间之间的持续时间。
    """
 
    def __init__(self, use_ns=False):
        """
        使用选择是否使用纳秒精度初始化 Timer。
        参数:
            use_ns (bool): 确定是否使用纳秒进行时间测量，默认为False。
        """
        self.use_ns = use_ns
        self.start = None
        self.end = None
        self.interval = None
 
    def __enter__(self):
        """
        启动计时器。当进入上下文块时记录开始时间。
        返回:
            Timer: 返回自身对象，以便在上下文外部访问属性。
        """
        if self.use_ns:
            self.start = time.perf_counter_ns()
        else:
            self.start = time.perf_counter()
        return self
 
    def __exit__(self, exc_type, exc_value, traceback):
        """
        结束计时器。当退出上下文块时记录结束时间。
        此函数还计算时间间隔并打印经过的时间。
        参数:
            exc_type: 如果在上下文中引发异常，则为异常类型。
            exc_value: 如果引发异常，则为异常值。
            traceback: 如果发生异常，则为回溯详细信息。
        返回:
            None
        """
        if self.use_ns:
            self.end = time.perf_counter_ns()
            self.interval = self.end - self.start
            print(f"经过时间：{self.interval} 纳秒")
        else:
            self.end = time.perf_counter()
            self.interval = self.end - self.start
            print(f"经过时间：{self.interval:.6f} 秒")

用法示例：

def test_func():
    for i in range(100000):
        pass
 
# 使用 Timer 类的示例
with Timer(use_ns=True) as timer_ns:
    test_func()
print(f"记录的时间（纳秒）：{timer_ns.interval}")
 
with Timer(use_ns=False) as timer_sec:
    test_func()
print(f"记录的时间（秒）：{timer_sec.interval:.6f}")