Merge pull request #60 from IvanildoBarauna/feature/MaxOffQuantityOfRetries

feature: added max of retries for protect APIServer

Author: IvanildoBarauna

README.md

@@ -58,20 +58,15 @@ client = ClientBuilder(endpoint="https://api.example.com"
                         ,connection_timeout=2
                         ,headers=headers)
 
-"""
-NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
-"""
-
+# if you can define timeout with EXPONENTIAL_RETRY_STRATEGY and set headers:
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
+                        ,retry_strategy=RetryStrategies.EXPONENTIAL_RETRY_STRATEGY
                         ,connection_timeout=10
                         ,headers=headers
                         ,retries=5
                         ,initial_delay=10)
 
 
-### timeout, retry_strategy and headers are opcionals parameters
-
 # Get data from the API
 data = client.get_api_data()
 
@@ -80,4 +75,28 @@ df = client.api_to_dataframe(data)
 
 # Display the DataFrame
 print(df)
-```
+```
+
+## Important notes:
+* **Opcionals Parameters:** The params timeout, retry_strategy and headers are opcionals.
+* **Default Params Value:** By default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
+* **Max Of Retries:** For security of API Server there is a limit for quantity of retries, actually this value is 5, this value is defined in lib constant. You can inform any value in RETRIES param, but the lib only will try 5x.
+* **Exponential Retry Strategy:** The increment of time between retries is time passed in **initial_delay** param * 2 * the retry_number, e.g with initial_delay=2
+
+    RetryNumber  | WaitingTime
+    ------------ | -----------
+    2            |  2s
+    2            |  4s
+    3            |  6s
+    4            |  8s
+    5            |  10s
+* **Linear Retry Strategy:** The increment of time between retries is time passed in **initial_delay**
+e.g with initial_delay=2
+
+    RetryNumber  | WaitingTime
+    ------------ | -----------
+    1            |  2s
+    2            |  2s
+    3            |  2s
+    4            |  2s
+    5            |  2s

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.3.7"
+version = "1.3.10"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
 readme = "README.md"

src/api_to_dataframe/models/retainer.py

@@ -1,7 +1,9 @@
 import time
 from enum import Enum
+
 from requests.exceptions import RequestException
 from api_to_dataframe.utils.logger import log, LogLevel
+from api_to_dataframe.utils import Constants
 
 
 class Strategies(Enum):
@@ -16,7 +18,7 @@ def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
         while retry_number < args[0].retries:
             try:
                 log(
-                    f"Trying for the {retry_number + 1} of {args[0].retries} retries. "
+                    f"Trying for the {retry_number} of {Constants.MAX_OF_RETRIES} retries. "
                     f"Using {args[0].retry_strategy}",
                     LogLevel.INFO,
                 )
@@ -29,9 +31,9 @@ def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
                 if args[0].retry_strategy == Strategies.LINEAR_RETRY_STRATEGY:
                     time.sleep(args[0].delay)
                 elif args[0].retry_strategy == Strategies.EXPONENTIAL_RETRY_STRATEGY:
-                    time.sleep(args[0].delay * 2**retry_number)
+                    time.sleep(args[0].delay * retry_number)
 
-                if retry_number == args[0].retries:
+                if retry_number in (args[0].retries, Constants.MAX_OF_RETRIES):
                     log(
                         f"Failed after {retry_number} retries using {args[0].retry_strategy}",
                         LogLevel.ERROR,

src/api_to_dataframe/utils/__init__.py

@@ -0,0 +1,2 @@
+class Constants:
+    MAX_OF_RETRIES = 5

tests/test_controller_client_builder.py

@@ -1,6 +1,5 @@
 import pytest
 import pandas as pd
-import requests
 
 from api_to_dataframe import ClientBuilder
 

tests/test_models_retainer.py

@@ -4,6 +4,8 @@
 
 from api_to_dataframe import ClientBuilder, RetryStrategies
 
+# from api_to_dataframe.utils import Constants
+
 
 def test_linear_strategy():
     endpoint = "https://api-to-dataframe/"
@@ -60,7 +62,7 @@ def test_exponential_strategy():
             client.get_api_data()
         except requests.exceptions.RequestException:
             end = time.time()
-            assert end - start >= client.delay * 2**retry_number
+            assert end - start >= client.delay * retry_number
             retry_number += 1
 
     assert retry_number == max_retries