feat: allow global retry_transient_errors

javatarz · javatarz · commit 7eab477c43ab · 2021-08-03T17:01:53.000+05:30
Value set on the `Gitlab` object will be used as a default in case every
subsequent API call does not provide a `retry_transient_errors`
parameter.

This allows code to be succinct and the retry policy to be set for all
calls to the `Gitlab` instance.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -391,6 +391,19 @@ default an exception is raised for these errors.
    gl = gitlab.gitlab(url, token, api_version=4)
    gl.projects.list(all=True, retry_transient_errors=True)
 
+The default ``retry_transient_errors`` can also be set on the ``Gitlab`` object
+and overridden by individual API calls.
+
+.. code-block:: python
+
+   import gitlab
+   import requests
+
+   gl = gitlab.gitlab(url, token, api_version=4, retry_transient_errors=True)
+   gl.projects.list(all=True) # uses default retry_transient_errors=True
+   gl.projects.list(all=True, retry_transient_errors=False) # uses overridden value retry_transient_errors=False
+
+
 Timeout
 -------
 
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -52,6 +52,8 @@ class Gitlab(object):
         pagination (str): Can be set to 'keyset' to use keyset pagination
         order_by (str): Set order_by globally
         user_agent (str): A custom user agent to use for making HTTP requests.
+        retry_transient_errors (bool): Whether to retry after 500, 502, 503, or
+            504 responses. Defaults to False.
     """
 
     def __init__(
@@ -70,6 +72,7 @@ def __init__(
         pagination: Optional[str] = None,
         order_by: Optional[str] = None,
         user_agent: str = gitlab.const.USER_AGENT,
+        retry_transient_errors: bool = False,
     ) -> None:
 
         self._api_version = str(api_version)
@@ -79,6 +82,7 @@ def __init__(
         self._url = "%s/api/v%s" % (self._base_url, api_version)
         #: Timeout to use for requests to gitlab server
         self.timeout = timeout
+        self.retry_transient_errors = retry_transient_errors
         #: Headers that will be used in request to GitLab
         self.headers = {"User-Agent": user_agent}
 
@@ -511,7 +515,6 @@ def http_request(
         files: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
         obey_rate_limit: bool = True,
-        retry_transient_errors: bool = False,
         max_retries: int = 10,
         **kwargs: Any,
     ) -> requests.Response:
@@ -531,9 +534,6 @@ def http_request(
             timeout (float): The timeout, in seconds, for the request
             obey_rate_limit (bool): Whether to obey 429 Too Many Request
                                     responses. Defaults to True.
-            retry_transient_errors (bool): Whether to retry after 500, 502,
-                                           503, or 504 responses. Defaults
-                                           to False.
             max_retries (int): Max retries after 429 or transient errors,
                                set to -1 to retry forever. Defaults to 10.
             **kwargs: Extra options to send to the server (e.g. sudo)
@@ -598,6 +598,9 @@ def http_request(
             if 200 <= result.status_code < 300:
                 return result
 
+            retry_transient_errors = kwargs.get(
+                "retry_transient_errors", self.retry_transient_errors
+            )
             if (429 == result.status_code and obey_rate_limit) or (
                 result.status_code in [500, 502, 503, 504] and retry_transient_errors
             ):
