Timeout function if it takes too long to finish [duplicate]

by

The process for timing out an operations is described in the documentation for signal.

The basic idea is to use signal handlers to set an alarm for some time interval and raise an exception once that timer expires.

Note that this will only work on UNIX.

Here’s an implementation that creates a decorator (save the following code as 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

This creates a decorator called @timeout that can be applied to any long running functions.

So, in your application code, you can use the decorator like so:

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():
    ...

More Related Contents:

  1. How to sum all range output in python 3
  2. How to map dict into another dict Python
  3. How to do parallel programming in Python?
  4. String formatting in Python 3
  5. IndexError: tuple index out of range when using py2exe
  6. Python: pop from empty list
  7. Run / Debug a Django application’s UnitTests from the mouse right click context menu in PyCharm Community Edition?
  8. How to check variable against 2 possible values?
  9. pysftp vs. Paramiko
  10. When should I be using classes in Python?
  11. Which version of Python do I have installed?
  12. Python sqlite3 and concurrency
  13. argparse subparser monolithic help output
  14. Return a list of imported Python modules used in a script?
  15. How can I modify a Python traceback object when raising an exception?
  16. >> operator in Python
  17. Python selenium: wait until element is clickable – not working
  18. “TypeError: method() takes 1 positional argument but 2 were given” but I did only pass one
  19. How to stop the input function from inserting a new line?
  20. Grep and Python
  21. Changing one dict changes all dicts in a list of dicts [duplicate]
  22. How to start threads at the same time in Python [duplicate]
  23. Region of Interest opencv python
  24. Pandas read_csv dtype read all columns but few as string
  25. How can I access a classmethod from inside a class in Python
  26. Is there a MATLAB accumarray equivalent in numpy?
  27. finding last business day of a month in python
  28. Send method using generator. still trying to understand the send method and quirky behaviour
  29. Image overlay in 3d plot
  30. What is this odd sorting algorithm?

Leave a Comment