Skip to main content

Celery Timeout decorator

Project description

Installation

From source code:

python setup.py install

From pypi:

pip install process-timer

Usage

import time
from process_timer import timeout

@timeout(5)
def mytest():
    print("Start")
    for i in range(1,10):
        time.sleep(1)
        print("{i} seconds have passed")

if __name__ == '__main__':
    mytest()

Specify an alternate exception to raise on timeout:

import time
from process_timer import timeout

@timeout(5, timeout_exception=StopIteration)
def mytest():
    print("Start")
    for i in range(1,10):
        time.sleep(1)
        print(f"{i} seconds have passed")

if __name__ == '__main__':
    mytest()

Multithreading

By default, timeout-decorator uses signals to limit the execution time of the given function. This appoach does not work if your function is executed not in a main thread (for example if it’s a worker thread of the web application). There is alternative timeout strategy for this case - by using multiprocessing. To use it, just pass use_signals=False to the timeout decorator function:

import time
from process_timer import timeout
import os

@timeout(5, use_signals=False)
def mytest():
    print("Start")
    for i in range(1,10):
        os.system('sleep 1')
        print(f"{i} seconds have passed")

if __name__ == '__main__':
    mytest()

Warning

Make sure that in case of multiprocessing strategy for timeout, your function does not return objects which cannot be pickled, otherwise it will fail at marshalling it between master and child processes.

Acknowledgement

Derived from Derived from https://github.com/pnpnpn/timeout-decorator to make it work in processes are not allowed to spawn it’s child processes. Ex: celery tasks http://www.saltycrane.com/blog/2010/04/using-python-timeout-decorator-uploading-s3/ and https://code.google.com/p/verse-quiz/source/browse/trunk/timeout.py

Contribute

I would love for you to fork and send me pull request for this project. Please contribute.

License

This software is licensed under the MIT license

See License file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distributions

process_timer-1.1-py3.6.egg (8.2 kB view hashes)

Uploaded 3 6

process_timer-1.1-py3-none-any.whl (5.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page