retry2
======
.. image:: https://img.shields.io/pypi/dm/retry.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/retry2/
.. image:: https://img.shields.io/pypi/v/retry.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/retry2/
.. image:: https://img.shields.io/pypi/l/retry2.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/retry2/
Easy to use retry decorator.
[This is a fork of https://github.com/invl/retry which is not maintained anymore]
Features
--------
- No external dependency (stdlib only).
- (Optionally) Preserve function signatures (`pip install decorator`).
- Original traceback, easy to debug.
Installation
------------
.. code-block:: bash
$ pip install retry2
API
---
retry decorator
^^^^^^^^^^^^^^^
.. code:: python
def retry(exceptions=Exception, tries=-1, delay=0, max_delay=None, backoff=1, jitter=0, logger=logging_logger,
on_exception=None):
"""Return a retry decorator.
:param exceptions: an exception or a tuple of exceptions to catch. default: Exception.
:param tries: the maximum number of attempts. default: -1 (infinite).
:param delay: initial delay between attempts. default: 0.
:param max_delay: the maximum value of delay. default: None (no limit).
:param backoff: multiplier applied to delay between attempts. default: 1 (no backoff).
:param jitter: extra seconds added to delay between attempts. default: 0.
fixed if a number, random if a range tuple (min, max)
:param logger: logger.warning(fmt, error, delay) will be called on failed attempts.
default: retry.logging_logger. if None, logging is disabled.
:param on_exception: handler called when exception occurs. will be passed the captured
exception as an argument. further retries are stopped when handler
returns True. default: None
"""
Various retrying logic can be achieved by combination of arguments.
Examples
""""""""
.. code:: python
from retry import retry
.. code:: python
@retry()
def make_trouble():
'''Retry until succeed'''
.. code:: python
@retry(ZeroDivisionError, tries=3, delay=2)
def make_trouble():
'''Retry on ZeroDivisionError, raise error after 3 attempts, sleep 2 seconds between attempts.'''
.. code:: python
@retry((ValueError, TypeError), delay=1, backoff=2)
def make_trouble():
'''Retry on ValueError or TypeError, sleep 1, 2, 4, 8, ... seconds between attempts.'''
.. code:: python
@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.'''
.. code:: python
@retry(ValueError, delay=1, jitter=1)
def make_trouble():
'''Retry on ValueError, sleep 1, 2, 3, 4, ... seconds between attempts.'''
.. code:: python
# 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
^^^^^^^^^^
.. code:: python
def retry_call(f, fargs=None, fkwargs=None, exceptions=Exception, tries=-1, delay=0, max_delay=None, backoff=1,
jitter=0, logger=logging_logger, on_exception=None):
"""
Calls a function and re-executes it if it failed.
:param f: the function to execute.
:param fargs: the positional arguments of the function to execute.
:param fkwargs: the named arguments of the function to execute.
:param exceptions: an exception or a tuple of exceptions to catch. default: Exception.
:param tries: the maximum number of attempts. default: -1 (infinite).
:param delay: initial delay between attempts. default: 0.
:param max_delay: the maximum value of delay. default: None (no limit).
:param backoff: multiplier applied to delay between attempts. default: 1 (no backoff).
:param jitter: extra seconds added to delay between attempts. default: 0.
fixed if a number, random if a range tuple (min, max)
:param logger: logger.warning(fmt, error, delay) will be called on failed attempts.
default: retry.logging_logger. if None, logging is disabled.
:param on_exception: handler called when exception occurs. will be passed the captured
exception as an argument. further retries are stopped when handler
returns True. default: None
:returns: the result of the f function.
"""
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.
.. code:: python
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")
Raw data
{
"_id": null,
"home_page": "https://github.com/eSAMTrade/retry",
"name": "retry2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.6",
"maintainer_email": "",
"keywords": "",
"author": "Andrei Suiu | eSAMTrade",
"author_email": "andrei.suiu@gmail.com",
"download_url": "",
"platform": null,
"description": "retry2\n======\n\n.. image:: https://img.shields.io/pypi/dm/retry.svg?maxAge=2592000\n :target: https://pypi.python.org/pypi/retry2/\n\n.. image:: https://img.shields.io/pypi/v/retry.svg?maxAge=2592000\n :target: https://pypi.python.org/pypi/retry2/\n\n.. image:: https://img.shields.io/pypi/l/retry2.svg?maxAge=2592000\n :target: https://pypi.python.org/pypi/retry2/\n\n\nEasy to use retry decorator.\n\n\n[This is a fork of https://github.com/invl/retry which is not maintained anymore]\n\nFeatures\n--------\n\n- No external dependency (stdlib only).\n- (Optionally) Preserve function signatures (`pip install decorator`).\n- Original traceback, easy to debug.\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install retry2\n\n\nAPI\n---\n\nretry decorator\n^^^^^^^^^^^^^^^\n\n.. code:: python\n\n def retry(exceptions=Exception, tries=-1, delay=0, max_delay=None, backoff=1, jitter=0, logger=logging_logger,\n on_exception=None):\n \"\"\"Return a retry decorator.\n\n :param exceptions: an exception or a tuple of exceptions to catch. default: Exception.\n :param tries: the maximum number of attempts. default: -1 (infinite).\n :param delay: initial delay between attempts. default: 0.\n :param max_delay: the maximum value of delay. default: None (no limit).\n :param backoff: multiplier applied to delay between attempts. default: 1 (no backoff).\n :param jitter: extra seconds added to delay between attempts. default: 0.\n fixed if a number, random if a range tuple (min, max)\n :param logger: logger.warning(fmt, error, delay) will be called on failed attempts.\n default: retry.logging_logger. if None, logging is disabled.\n :param on_exception: handler called when exception occurs. will be passed the captured\n exception as an argument. further retries are stopped when handler\n returns True. default: None\n \"\"\"\n\nVarious retrying logic can be achieved by combination of arguments.\n\n\nExamples\n\"\"\"\"\"\"\"\"\n\n.. code:: python\n\n from retry import retry\n\n.. code:: python\n\n @retry()\n def make_trouble():\n '''Retry until succeed'''\n\n.. code:: python\n\n @retry(ZeroDivisionError, tries=3, delay=2)\n def make_trouble():\n '''Retry on ZeroDivisionError, raise error after 3 attempts, sleep 2 seconds between attempts.'''\n\n.. code:: python\n\n @retry((ValueError, TypeError), delay=1, backoff=2)\n def make_trouble():\n '''Retry on ValueError or TypeError, sleep 1, 2, 4, 8, ... seconds between attempts.'''\n\n.. code:: python\n\n @retry((ValueError, TypeError), delay=1, backoff=2, max_delay=4)\n def make_trouble():\n '''Retry on ValueError or TypeError, sleep 1, 2, 4, 4, ... seconds between attempts.'''\n\n.. code:: python\n\n @retry(ValueError, delay=1, jitter=1)\n def make_trouble():\n '''Retry on ValueError, sleep 1, 2, 3, 4, ... seconds between attempts.'''\n\n.. code:: python\n\n # If you enable logging, you can get warnings like 'ValueError, retrying in\n # 1 seconds'\n if __name__ == '__main__':\n import logging\n logging.basicConfig()\n make_trouble()\n\nretry_call\n^^^^^^^^^^\n\n.. code:: python\n\n def retry_call(f, fargs=None, fkwargs=None, exceptions=Exception, tries=-1, delay=0, max_delay=None, backoff=1,\n jitter=0, logger=logging_logger, on_exception=None):\n \"\"\"\n Calls a function and re-executes it if it failed.\n\n :param f: the function to execute.\n :param fargs: the positional arguments of the function to execute.\n :param fkwargs: the named arguments of the function to execute.\n :param exceptions: an exception or a tuple of exceptions to catch. default: Exception.\n :param tries: the maximum number of attempts. default: -1 (infinite).\n :param delay: initial delay between attempts. default: 0.\n :param max_delay: the maximum value of delay. default: None (no limit).\n :param backoff: multiplier applied to delay between attempts. default: 1 (no backoff).\n :param jitter: extra seconds added to delay between attempts. default: 0.\n fixed if a number, random if a range tuple (min, max)\n :param logger: logger.warning(fmt, error, delay) will be called on failed attempts.\n default: retry.logging_logger. if None, logging is disabled.\n :param on_exception: handler called when exception occurs. will be passed the captured\n exception as an argument. further retries are stopped when handler\n returns True. default: None\n :returns: the result of the f function.\n \"\"\"\n\nThis 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.\n\n.. code:: python\n\n import requests\n\n from retry.api import retry_call\n\n\n def make_trouble(service, info=None):\n if not info:\n info = ''\n r = requests.get(service + info)\n return r.text\n\n\n def what_is_my_ip(approach=None):\n if approach == \"optimistic\":\n tries = 1\n elif approach == \"conservative\":\n tries = 3\n else:\n # skeptical\n tries = -1\n result = retry_call(make_trouble, fargs=[\"http://ipinfo.io/\"], fkwargs={\"info\": \"ip\"}, tries=tries)\n print(result)\n\n what_is_my_ip(\"conservative\")\n\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Easy to use retry decorator.",
"version": "0.9.5",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97491cae6d9b932378cc75f902fa70648945b7ea7190cb0d09ff83b47de3e60a",
"md5": "e77f87363fd687459fe1cac546d626bf",
"sha256": "f7fee13b1e15d0611c462910a6aa72a8919823988dd0412152bc3719c89a4e55"
},
"downloads": -1,
"filename": "retry2-0.9.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e77f87363fd687459fe1cac546d626bf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.6",
"size": 6013,
"upload_time": "2023-01-11T21:49:08",
"upload_time_iso_8601": "2023-01-11T21:49:08.397085Z",
"url": "https://files.pythonhosted.org/packages/97/49/1cae6d9b932378cc75f902fa70648945b7ea7190cb0d09ff83b47de3e60a/retry2-0.9.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 21:49:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "eSAMTrade",
"github_project": "retry",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "decorator",
"specs": [
[
">=",
"3.4.2"
]
]
}
],
"tox": true,
"lcname": "retry2"
}
JSON
