如何为 python unittest 指定测试超时？

Question

我正在使用python 框架unittest。是否可以通过框架的能力指定测试超时？如果不是，是否可以为所有测试优雅地指定 timeout 并为某些单独的测试为每个测试指定一个私有值？
我想为所有测试定义一个global timeout（默认情况下会使用它），并为一些可能需要很长时间的测试定义一个超时。

Answer 1

我使用上下文管理器（with keyowrd）、based on this answer 构建了一个 unittest 超时解决方案。

这种方法也使用signal，所以它可能只在 *nix 系统上有效（我只在我的 Ubuntu 16.04 环境中运行过）。

1. 导入信号，添加TestTimeout异常：

import signal

...

class TestTimeout(Exception):
    pass

1. 定义类test_timeout，它将处理with 块：

class test_timeout:
  def __init__(self, seconds, error_message=None):
    if error_message is None:
      error_message = 'test timed out after {}s.'.format(seconds)
    self.seconds = seconds
    self.error_message = error_message

  def handle_timeout(self, signum, frame):
    raise TestTimeout(self.error_message)

  def __enter__(self):
    signal.signal(signal.SIGALRM, self.handle_timeout)
    signal.alarm(self.seconds)

  def __exit__(self, exc_type, exc_val, exc_tb):
    signal.alarm(0)

1. 在单元测试中嵌入 with test_timeout() 块：

def test_foo(self):
  with test_timeout(5):  # test has 5 seconds to complete
    ... foo unit test code ...

使用这种方法，超时的测试将由于raise TestTimeout 异常而导致错误。

或者，您可以将 with test_timeout() 块包装在 try: except TestTimeout: 块中，并以更精细的方式处理异常（例如，跳过测试而不是错误）。

Answer 2

据我所知unittest 不包含对测试超时的任何支持。

您可以尝试 PyPI 中的 timeout-decorator 库。将装饰器应用于单个测试以使它们在耗时过长时终止：

import timeout_decorator

class TestCaseWithTimeouts(unittest.TestCase):

    # ... whatever ...

    @timeout_decorator.timeout(LOCAL_TIMEOUT)
    def test_that_can_take_too_long(self):
        sleep(float('inf'))

    # ... whatever else ...

要创建全局超时，可以替换调用

unittest.main()

与

timeout_decorator.timeout(GLOBAL_TIMEOUT)(unittest.main)()