python 对函数设置超时时间

看起来很年长的一条鱼

于 2024-08-03 05:06:58 发布

阅读量119

点赞数

文章标签： python 开发语言

Python对函数设置超时时间

在编程中，我们常常会遇到某些操作需要较长时间才能完成的情况，比如网络请求、文件读写等。为了提高程序的响应性，我们可以为这些长时间运行的函数设置超时时间。在Python中，有多种方法可以实现这一点，最常用的是利用装饰器和signal模块。本文将介绍如何在Python中为函数设置超时时间，并举例说明。

使用装饰器设置超时

装饰器是Python中非常强大的功能，它允许我们在不修改原有函数代码的情况下，为其添加额外的功能。以下是一个使用装饰器来设置超时时间的示例：

import signal

class TimeoutException(Exception):
    pass

def timeout(seconds):
    def decorator(func):
        def _handle_timeout(signum, frame):
            raise TimeoutException("Function call timed out.")

        def wrapper(*args, **kwargs):
            signal.signal(signal.SIGALRM, _handle_timeout)
            signal.alarm(seconds)  # 设置超时时间
            try:
                return func(*args, **kwargs)
            finally:
                signal.alarm(0)  # 取消闹钟
        return wrapper
    return decorator

@timeout(3)  # 设置函数超时为3秒
def long_running_function():
    import time
    time.sleep(10)  # 模拟长时间运行的操作

try:
    long_running_function()
except TimeoutException as e:
    print(e)

在以上代码中，我们定义了一个timeout装饰器，它能够为任何函数设置一个超时时间。之后，我们用这个装饰器装饰了一个模拟长时间运行的函数long_running_function。当函数在设定的时间内未能完成，程序将抛出TimeoutException。

使用`threading`模块

除了使用signal模块，我们还可以使用threading模块来实现函数的超时控制。以下是一个示例：

import threading

def run_with_timeout(func, timeout):
    result = [None]  # 存放函数的返回值
    exception = [None]  # 存放异常信息

    def run():
        try:
            result[0] = func()
        except Exception as e:
            exception[0] = e

    thread = threading.Thread(target=run)
    thread.start()
    thread.join(timeout)  # 等待指定的时间

    if thread.is_alive():
        thread.join()  # 可选：等待线程结束
        raise TimeoutException("Function call timed out.")
    if exception[0]:
        raise exception[0]  # 重新抛出异常
    return result[0]

def long_running_function():
    import time
    time.sleep(10)

try:
    run_with_timeout(long_running_function, 3)  # 设置超时为3秒
except TimeoutException as e:
    print(e)