Skip to main content

Easy to use retry decorator.

Project description

https://img.shields.io/pypi/v/retry-sh.svg?maxAge=2592000 https://img.shields.io/pypi/l/retry-sh.svg?maxAge=2592000 https://github.com/shizacat/retry/actions/workflows/python_package.yaml/badge.svg

Easy to use retry decorator.

Step side

It’s fork: https://github.com/invl/retry

My changes had started from version 0.9.3 (see ChangeLog)

Features

  • No external dependency (stdlib only).

  • (Optionally) Preserve function signatures (pip install decorator).

  • Original traceback, easy to debug.

Installation

$ pip install retry-sh

API

retry decorator

Various retrying logic can be achieved by combination of arguments.

Examples

from retry import retry

@retry()
def make_trouble():
    '''Retry until succeed'''

@retry(ZeroDivisionError, tries=3, delay=2)
def make_trouble():
    '''
    Retry on ZeroDivisionError,
    raise error after 3 attempts, sleep 2 seconds between attempts.
    '''

@retry((ValueError, TypeError), delay=1, backoff=2)
def make_trouble():
    '''
    Retry on ValueError or TypeError,
    sleep 1, 2, 4, 8, ... seconds between attempts.
    '''

@retry((ValueError, TypeError), delay=1, backoff=2, max_delay=4)
def make_trouble():
    '''
    Retry on ValueError or TypeError,
    sleep 1, 2, 4, 4, ... seconds between attempts.
    '''

@retry(ValueError, delay=1, jitter=1)
def make_trouble():
    '''
    Retry on ValueError,
    sleep 1, 2, 3, 4, ... seconds between attempts.
    '''

# If you enable logging, you can get warnings like 'ValueError, retrying in
# 1 seconds'
if __name__ == '__main__':
    import logging
    logging.basicConfig()
    make_trouble()

retry_call

This is very similar to the decorator, except that it takes a function and its arguments as parameters. The use case behind it is to be able to dynamically adjust the retry arguments.

import requests

from retry.api import retry_call


def make_trouble(service, info=None):
    if not info:
        info = ''
    r = requests.get(service + info)
    return r.text


def what_is_my_ip(approach=None):
    if approach == "optimistic":
        tries = 1
    elif approach == "conservative":
        tries = 3
    else:
        # skeptical
        tries = -1
    result = retry_call(
        make_trouble,
        fargs=["http://ipinfo.io/"],
        fkwargs={"info": "ip"},
        tries=tries
    )
    print(result)

what_is_my_ip("conservative")

Project details


Download files

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

Source Distribution

retry-sh-1.0.5.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

retry_sh-1.0.5-py2.py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page