Decorators for functions that you wish to retry
Project description
# trythatagain
This provides decorators for super simple function/method call retries when an exception is raised.
## Installation
```bash
pip install trythatagain
```
## Examples
Here's a simple use case: querying the AWS API, knowing you might hit API limits.
```python
from trythatagain import retry
@retry
def find_ebs_volumes(unattached=True, no_snapshots=True):
...
try:
find_ebs_volumes()
except CaughtException as e:
print('Failed to list EBS volumes')
print(e.caught_exception)
```
This will retry calling `func` three times. If was not successful in calling the function without an exception, it will re-raise the exception as `CaughtException`, with the original exception available at the attribute `caught_exception`.
Retry as many times as times as necessary:
```python
from trythatagain import retry
@retry(retries=5)
def try_five_times():
raise Exception('This always fails')
@retry(retries=0)
def retry_forever():
raise Exception('Terrible waste of CPU cycles')
```
Raise immediately on specific exceptions:
```python
@retry(raise_for=ValueError)
def update_cache():
...
```
Suppress re-raising exceptions:
```python
@retry(reraise=False)
def reload_user_data():
...
```
There's also exponential and linear backoff retries things like cooling down after hitting API limits. In fact, AWS recommends exponential backoff to deal with API limits.
```python
# waits 1 second, then 4, then 9, etc.
@retry_exp_backoff(unit=MILLISECONDS)
def update_instance_tags():
...
@retry_linear_backoff(unit=SECONDS)
def scrape_url():
...
```
Custom wait functions are also possible:
```python
def fixed(i, unit):
time.sleep(5 * unit)
@retry(wait_func=fixed, unit=MILLISECONDS)
def func():
...
```
This provides decorators for super simple function/method call retries when an exception is raised.
## Installation
```bash
pip install trythatagain
```
## Examples
Here's a simple use case: querying the AWS API, knowing you might hit API limits.
```python
from trythatagain import retry
@retry
def find_ebs_volumes(unattached=True, no_snapshots=True):
...
try:
find_ebs_volumes()
except CaughtException as e:
print('Failed to list EBS volumes')
print(e.caught_exception)
```
This will retry calling `func` three times. If was not successful in calling the function without an exception, it will re-raise the exception as `CaughtException`, with the original exception available at the attribute `caught_exception`.
Retry as many times as times as necessary:
```python
from trythatagain import retry
@retry(retries=5)
def try_five_times():
raise Exception('This always fails')
@retry(retries=0)
def retry_forever():
raise Exception('Terrible waste of CPU cycles')
```
Raise immediately on specific exceptions:
```python
@retry(raise_for=ValueError)
def update_cache():
...
```
Suppress re-raising exceptions:
```python
@retry(reraise=False)
def reload_user_data():
...
```
There's also exponential and linear backoff retries things like cooling down after hitting API limits. In fact, AWS recommends exponential backoff to deal with API limits.
```python
# waits 1 second, then 4, then 9, etc.
@retry_exp_backoff(unit=MILLISECONDS)
def update_instance_tags():
...
@retry_linear_backoff(unit=SECONDS)
def scrape_url():
...
```
Custom wait functions are also possible:
```python
def fixed(i, unit):
time.sleep(5 * unit)
@retry(wait_func=fixed, unit=MILLISECONDS)
def func():
...
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for trythatagain-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2350eb60b06c20de4535efdae5a134b23afff40f035f9d80d7b0685f123b5f65 |
|
MD5 | db12aa78dc727cacef20f720ba90818d |
|
BLAKE2b-256 | 3d61b208fc53f50440b2150cbe802da1619dfb84a5d07aae959eaec3c562f1d4 |