Skip to main content

Handy decorator to set retry policies for async callables with some useful features

Project description

aioretry

Handy decorator to set retry policies for async callables with some useful features

Usage examples

@retry(
    tries=5,
    allowed_exceptions=(RuntimeError,),
    intervals=(5, 7, 10),
    fail_cb=make_request_callback,
)
async def make_request(address, client):

    ... http request code goes here...

    if response.status_code >= 300:
        raise RuntimeError()

def make_request_callback(address, client)
    ...
  • 5 retries will be performed
  • with 5, 7, 10, 10 and 10 seconds interval between retries. I.e. if intervals tuple length more than tries number, the last tuple interval will be used for the rest of the tries.
  • make_request_callback() synchronous function will be called if all attempts are failed
  • The accepted exceptions tuple allows you to control when to retry.
  • You can optionally pass a custom logger: logging.Logger to the decorator within a logger= parameter. Otherwise retry_decorator logger will be created to log retries.

Other possible ways to use this decorator:

@retry(5, (MyCustomError,), (5, 7, 10), make_request_callback)

@retry(3, (MyCustomError,), (1,))

# this actually will either successfully return or fail on first exception occured
@retry(3)

Look into tests.py to see more on usage.

Installation

Available as a package on pypi:

pip install aioretry-decorator

Or install it directly from GitHub:

pip install git+https://github.com/remort/aioretry.git#egg=aioretry_decorator

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

aioretry-decorator-1.0.5.tar.gz (2.7 kB view details)

Uploaded Source

File details

Details for the file aioretry-decorator-1.0.5.tar.gz.

File metadata

  • Download URL: aioretry-decorator-1.0.5.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/6.8.0 keyring/24.2.0 pkginfo/1.9.6 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.2 rfc3986/1.5.0 tqdm/4.64.1 urllib3/1.26.14 CPython/3.10.12

File hashes

Hashes for aioretry-decorator-1.0.5.tar.gz
Algorithm Hash digest
SHA256 fcf2b073c201b8c3e7e75d1c46f032450df963564f559f006b97a8e8e6a6806f
MD5 23e9915b3dc43a518df99b372849687a
BLAKE2b-256 f91614674a53d1e42cb42add566ea46f7abbaa74910fd5a2ea9a8e30e30f7759

See more details on using hashes here.

Provenance

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