Add support for retry of HTTP requests

.generator/src/generator/templates/configuration.j2

@@ -22,7 +22,6 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = {
     "minItems",
 }
 
-
 class _UnstableOperations:
 
     def __init__(self, values):
@@ -158,6 +157,9 @@ class Configuration:
         check_input_type=True,
         check_return_type=True,
         spec_property_naming=False,
+        enable_retry= False,
+        retry_backoff_factor= 2,
+        max_retries= 3,
     ):
         """Constructor."""
         self._base_path = "https://api.datadoghq.com" if host is None else host
@@ -200,7 +202,6 @@ class Configuration:
         self.proxy = None
         self.proxy_headers = None
         self.safe_chars_for_path_param = ""
-        self.retries = None
         # Enable client side validation
         self.client_side_validation = True
 
@@ -217,6 +218,11 @@ class Configuration:
         self.check_return_type = check_return_type
         self.spec_property_naming = spec_property_naming
 
+        # Options for http retry
+        self.enable_retry = enable_retry
+        self.retry_backoff_factor = retry_backoff_factor
+        self.max_retries = max_retries
+
         # Keep track of unstable operations
         self.unstable_operations = _UnstableOperations({
         {%- for version, api in apis.items() %}

.generator/src/generator/templates/rest.j2

@@ -6,7 +6,6 @@ import re
 import ssl
 from urllib.parse import urlencode
 import zlib
-
 import urllib3  # type: ignore
 
 from {{ package }}.exceptions import (
@@ -21,6 +20,36 @@ from {{ package }}.exceptions import (
 
 logger = logging.getLogger(__name__)
 
+class DDRetry(urllib3.util.Retry):
+    RETRY_AFTER_STATUS_CODES = frozenset([413, 429, 500, 501, 502, 503, 504, 505, 506, 507, 509, 510, 511])
+    DEFAULT_ALLOWED_METHODS = frozenset(
+        ["HEAD", "GET", "PUT", "DELETE", "OPTIONS", "TRACE", "POST", "CONNECT", "PATCH"]
+    )
+    def __init__(self,**kwargs):
+        super().__init__(**kwargs)
+
+    def get_retry_after(self, response):
+
+        """This method overrides the default "Retry-after" header and uses dd's X-Ratelimit-Reset header
+        and gets the value of X-Ratelimit-Reset in seconds."""
+
+        retry_after = response.headers.get("X-Ratelimit-Reset")
+
+        if retry_after is None:
+            return None
+        return self.parse_retry_after(retry_after)
+
+    def is_retry(self, method, status_code, has_retry_after=False):
+        if not self._is_method_retryable(method):
+            return False
+
+        if self.status_forcelist and status_code in self.status_forcelist:
+            return True
+        return (
+            self.total
+            and self.respect_retry_after_header
+            and (status_code in self.RETRY_AFTER_STATUS_CODES)
+        )
 
 class RESTClientObject:
     def __init__(self, configuration, pools_size=4, maxsize=4):
@@ -40,8 +69,14 @@ class RESTClientObject:
         if configuration.assert_hostname is not None:
             addition_pool_args["assert_hostname"] = configuration.assert_hostname
 
-        if configuration.retries is not None:
-            addition_pool_args["retries"] = configuration.retries
+        if configuration.enable_retry == True:
+            retries = DDRetry(
+                total=configuration.max_retries,
+                backoff_factor=configuration.retry_backoff_factor,
+            )
+            addition_pool_args["retries"] = retries
+        else:
+            addition_pool_args["retries"] = False
 
         if configuration.socket_options is not None:
             addition_pool_args["socket_options"] = configuration.socket_options

src/datadog_api_client/configuration.py

@@ -159,6 +159,9 @@ def __init__(
         check_input_type=True,
         check_return_type=True,
         spec_property_naming=False,
+        enable_retry=False,
+        retry_backoff_factor=2,
+        max_retries=3,
     ):
         """Constructor."""
         self._base_path = "https://api.datadoghq.com" if host is None else host
@@ -201,7 +204,6 @@ def __init__(
         self.proxy = None
         self.proxy_headers = None
         self.safe_chars_for_path_param = ""
-        self.retries = None
         # Enable client side validation
         self.client_side_validation = True
 
@@ -218,6 +220,11 @@ def __init__(
         self.check_return_type = check_return_type
         self.spec_property_naming = spec_property_naming
 
+        # Options for http retry
+        self.enable_retry = enable_retry
+        self.retry_backoff_factor = retry_backoff_factor
+        self.max_retries = max_retries
+
         # Keep track of unstable operations
         self.unstable_operations = _UnstableOperations(
             {

src/datadog_api_client/rest.py

@@ -8,7 +8,6 @@
 import ssl
 from urllib.parse import urlencode
 import zlib
-
 import urllib3  # type: ignore
 
 from datadog_api_client.exceptions import (
@@ -24,6 +23,34 @@
 logger = logging.getLogger(__name__)
 
 
+class DDRetry(urllib3.util.Retry):
+    RETRY_AFTER_STATUS_CODES = frozenset([413, 429, 500, 501, 502, 503, 504, 505, 506, 507, 509, 510, 511])
+    DEFAULT_ALLOWED_METHODS = frozenset(
+        ["HEAD", "GET", "PUT", "DELETE", "OPTIONS", "TRACE", "POST", "CONNECT", "PATCH"]
+    )
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    def get_retry_after(self, response):
+        """This method overrides the default "Retry-after" header and uses dd's X-Ratelimit-Reset header
+        and gets the value of X-Ratelimit-Reset in seconds."""
+
+        retry_after = response.headers.get("X-Ratelimit-Reset")
+
+        if retry_after is None:
+            return None
+        return self.parse_retry_after(retry_after)
+
+    def is_retry(self, method, status_code, has_retry_after=False):
+        if not self._is_method_retryable(method):
+            return False
+
+        if self.status_forcelist and status_code in self.status_forcelist:
+            return True
+        return self.total and self.respect_retry_after_header and (status_code in self.RETRY_AFTER_STATUS_CODES)
+
+
 class RESTClientObject:
     def __init__(self, configuration, pools_size=4, maxsize=4):
         # urllib3.PoolManager will pass all kw parameters to connectionpool
@@ -42,8 +69,14 @@ def __init__(self, configuration, pools_size=4, maxsize=4):
         if configuration.assert_hostname is not None:
             addition_pool_args["assert_hostname"] = configuration.assert_hostname
 
-        if configuration.retries is not None:
-            addition_pool_args["retries"] = configuration.retries
+        if configuration.enable_retry == True:
+            retries = DDRetry(
+                total=configuration.max_retries,
+                backoff_factor=configuration.retry_backoff_factor,
+            )
+            addition_pool_args["retries"] = retries
+        else:
+            addition_pool_args["retries"] = False
 
         if configuration.socket_options is not None:
             addition_pool_args["socket_options"] = configuration.socket_options