Skip to content

Commit

Permalink
add description of breaking api changes
Browse files Browse the repository at this point in the history
  • Loading branch information
inyutin committed Aug 5, 2022
1 parent bc8fa96 commit d3c4a9d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Python 3.7 or higher.
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/inyutin)


### Breaking API changes
- Since 2.5.6 this is a new parameter in ```get_timeout``` func called "response".
If you have defined your own ```RetryOptions```, you should add this param into it.
Issue about this: https://github.com/inyutin/aiohttp_retry/issues/59

### Examples of usage:
```python
from aiohttp_retry import RetryClient, ExponentialRetry
Expand Down Expand Up @@ -140,7 +145,7 @@ You can define your own timeouts logic or use:
- ```FibonacciRetry``` with backoff that looks like fibonacci sequence
- ```JitterRetry``` exponential retry with a bit of randomness

**Important**: you can server response as an parameter for calculating next timeout.
**Important**: you can proceed server response as an parameter for calculating next timeout.
However this response can be None, server didn't make a response or you have set up ```raise_for_status=True```
Look here for an example: https://github.com/inyutin/aiohttp_retry/issues/59

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

setup(
name='aiohttp_retry',
version='2.5.6',
version='2.6.0',
description='Simple retry client for aiohttp',
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit d3c4a9d

Please sign in to comment.