如果执行时间过长，如何设置超时函数

Question

我有一个脚本，它会循环读取一个文本文件，这个文件里有我想访问的网址，然后我想给这些网址截图。

这个过程其实很简单。脚本会初始化一个类，当运行时，它会对列表中的每个网站进行截图。不过，有些网站加载得非常非常慢，有些甚至可能根本加载不出来。所以我想把截图的功能放在一个超时的脚本里，如果在10秒内没有完成，就让这个功能返回False。

我希望能找到最简单的解决办法，可能是设置一个异步计时器，让它在10秒后无论函数内部发生了什么都返回False？

Answer 1

我用 with 语句重写了大卫的回答，这样你可以做到：

with timeout(seconds=3):
    time.sleep(4)

这会引发一个超时错误（TimeoutError）。

这段代码仍然使用了 signal，所以它只适用于 UNIX 系统：

import signal

class timeout:
    def __init__(self, seconds=1, error_message='Timeout'):
        self.seconds = seconds
        self.error_message = error_message
    def handle_timeout(self, signum, frame):
        raise TimeoutError(self.error_message)
    def __enter__(self):
        signal.signal(signal.SIGALRM, self.handle_timeout)
        signal.alarm(self.seconds)
    def __exit__(self, type, value, traceback):
        signal.alarm(0)

Answer 2

关于如何设置操作超时的过程，可以在signal的文档中找到。

基本的思路是使用信号处理器来设置一个定时器，当时间到了之后就会抛出一个异常。

需要注意的是，这种方法只适用于UNIX系统。

下面是一个实现示例，它创建了一个装饰器（请将以下代码保存为timeout.py）。

import errno
import os
import signal
import functools

class TimeoutError(Exception):
    pass

def timeout(seconds=10, error_message=os.strerror(errno.ETIME)):
    def decorator(func):
        def _handle_timeout(signum, frame):
            raise TimeoutError(error_message)

        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            signal.signal(signal.SIGALRM, _handle_timeout)
            signal.alarm(seconds)
            try:
                result = func(*args, **kwargs)
            finally:
                signal.alarm(0)
            return result

        return wrapper

    return decorator

这个装饰器叫做@timeout，可以应用到任何运行时间较长的函数上。

所以，在你的应用代码中，你可以这样使用这个装饰器：

from timeout import timeout

# Timeout a long running function with the default expiry of 10 seconds.
@timeout
def long_running_function1():
    ...

# Timeout after 5 seconds
@timeout(5)
def long_running_function2():
    ...

# Timeout after 30 seconds, with the error "Connection timed out"
@timeout(30, os.strerror(errno.ETIMEDOUT))
def long_running_function3():
    ...