From d3c4a9d7399cf680c22196d2ea24d69e7431eb67 Mon Sep 17 00:00:00 2001 From: Dmitry Inyutin Date: Fri, 5 Aug 2022 17:59:55 +0300 Subject: [PATCH] add description of breaking api changes --- README.md | 7 ++++++- setup.py | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11e4e00..8834edc 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/setup.py b/setup.py index 9d79d15..5774e8c 100644 --- a/setup.py +++ b/setup.py @@ -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",