changed retry delay variable name

replaced retryBackoff with retryDelay

Author: ashah-splunk

examples/optional_retry.py

@@ -458,8 +458,8 @@ class Context(object):
     :param retires: Number of retries for each HTTP connection (optional, the default is 0).
                     NOTE THAT THIS MAY INCREASE THE NUMBER OF ROUND TRIP CONNECTIONS TO THE SPLUNK SERVER.
     :type retries: ``int``
-    :param retryBackoff: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
-    :type retryBackoff: ``int`` (in seconds)
+    :param retryDelay: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
+    :type retryDelay: ``int`` (in seconds)
     :param handler: The HTTP request handler (optional).
     :returns: A ``Context`` instance.
 
@@ -478,7 +478,7 @@ class Context(object):
     def __init__(self, handler=None, **kwargs):
         self.http = HttpLib(handler, kwargs.get("verify", False), key_file=kwargs.get("key_file"),
                             cert_file=kwargs.get("cert_file"),  context=kwargs.get("context"), # Default to False for backward compat
-                            retries=kwargs.get("retries", 0), retryBackoff=kwargs.get("retryBackoff", 10))
+                            retries=kwargs.get("retries", 0), retryDelay=kwargs.get("retryDelay", 10))
         self.token = kwargs.get("token", _NoAuthenticationToken)
         if self.token is None: # In case someone explicitly passes token=None
             self.token = _NoAuthenticationToken
@@ -1165,14 +1165,14 @@ class HttpLib(object):
 
     If using the default handler, SSL verification can be disabled by passing verify=False.
     """
-    def __init__(self, custom_handler=None, verify=False, key_file=None, cert_file=None, context=None, retries=0, retryBackoff=10):
+    def __init__(self, custom_handler=None, verify=False, key_file=None, cert_file=None, context=None, retries=0, retryDelay=10):
         if custom_handler is None:
             self.handler = handler(verify=verify, key_file=key_file, cert_file=cert_file, context=context)
         else:
             self.handler = custom_handler
         self._cookies = {}
         self.retries = retries
-        self.retryBackoff = retryBackoff
+        self.retryDelay = retryDelay
 
     def delete(self, url, headers=None, **kwargs):
         """Sends a DELETE request to a URL.
@@ -1294,7 +1294,7 @@ def request(self, url, message, **kwargs):
                 if self.retries <= 0:
                     raise
                 else:
-                    time.sleep(self.retryBackoff)
+                    time.sleep(self.retryDelay)
                     self.retries -= 1
         response = record(response)
         if 400 <= response.status:

splunklib/binding.py

@@ -323,8 +323,8 @@ def connect(**kwargs):
     :param retires: Number of retries for each HTTP connection (optional, the default is 0).
                     NOTE THAT THIS MAY INCREASE THE NUMBER OF ROUND TRIP CONNECTIONS TO THE SPLUNK SERVER.
     :type retries: ``int``
-    :param retryBackoff: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
-    :type retryBackoff: ``int`` (in seconds)
+    :param retryDelay: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
+    :type retryDelay: ``int`` (in seconds)
     :param `context`: The SSLContext that can be used when setting verify=True (optional)
     :type context: ``SSLContext``
     :return: An initialized :class:`Service` connection.
@@ -396,8 +396,8 @@ class Service(_BaseService):
     :param retires: Number of retries for each HTTP connection (optional, the default is 0).
                     NOTE THAT THIS MAY INCREASE THE NUMBER OF ROUND TRIP CONNECTIONS TO THE SPLUNK SERVER.
     :type retries: ``int``
-    :param retryBackoff: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
-    :type retryBackoff: ``int`` (in seconds)
+    :param retryDelay: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
+    :type retryDelay: ``int`` (in seconds)
     :return: A :class:`Service` instance.
 
     **Example**::

splunklib/client.py

@@ -178,17 +178,6 @@ def test_hec_event(self):
         self.assertEqual(response.status, 200)
 
 
-# class TestOptionalRetry(unittest.TestCase):
-#
-#     def test_optional_retry(self):
-#         opts = testlib.parse([], {}, ".env")
-#         kwargs = opts.kwargs.copy()
-#         kwargs.update({'retries': 5})
-#         self.service = client.connect(**kwargs)
-#         self.service.restart(timeout=15)  # timeout value kept lower than actual time needed for Splunk to restart
-#         self.assertEqual(self.service.get("/services").status, 200)
-
-
 class TestCookieAuthentication(unittest.TestCase):
     def setUp(self):
         self.opts = testlib.parse([], {}, ".env")