refactor: RequestsResponse

Liora Milbaum · Liora Milbaum · commit 459af58020af · 2022-12-10T16:01:49.000+02:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -774,47 +774,51 @@ def http_request(
 
                 raise
 
-            self._check_redirects(result)
+            self._check_redirects(result.response)
 
-            if 200 <= result.status_code < 300:
-                return result
+            if 200 <= result.response.status_code < 300:
+                return result.response
 
-            if (429 == result.status_code and obey_rate_limit) or (
-                result.status_code in gitlab.const.RETRYABLE_TRANSIENT_ERROR_CODES
+            if (429 == result.response.status_code and obey_rate_limit) or (
+                result.response.status_code
+                in gitlab.const.RETRYABLE_TRANSIENT_ERROR_CODES
                 and retry_transient_errors
             ):
                 # Response headers documentation:
                 # https://docs.gitlab.com/ee/user/admin_area/settings/user_and_ip_rate_limits.html#response-headers
                 if max_retries == -1 or cur_retries < max_retries:
                     wait_time = 2**cur_retries * 0.1
-                    if "Retry-After" in result.headers:
-                        wait_time = int(result.headers["Retry-After"])
-                    elif "RateLimit-Reset" in result.headers:
-                        wait_time = int(result.headers["RateLimit-Reset"]) - time.time()
+                    if "Retry-After" in result.response.headers:
+                        wait_time = int(result.response.headers["Retry-After"])
+                    elif "RateLimit-Reset" in result.response.headers:
+                        wait_time = (
+                            int(result.response.headers["RateLimit-Reset"])
+                            - time.time()
+                        )
                     cur_retries += 1
                     time.sleep(wait_time)
                     continue
 
-            error_message = result.content
+            error_message = result.response.content
             try:
-                error_json = result.json()
+                error_json = result.response.json()
                 for k in ("message", "error"):
                     if k in error_json:
                         error_message = error_json[k]
             except (KeyError, ValueError, TypeError):
                 pass
 
-            if result.status_code == 401:
+            if result.response.status_code == 401:
                 raise gitlab.exceptions.GitlabAuthenticationError(
-                    response_code=result.status_code,
+                    response_code=result.response.status_code,
                     error_message=error_message,
-                    response_body=result.content,
+                    response_body=result.response.content,
                 )
 
             raise gitlab.exceptions.GitlabHttpError(
-                response_code=result.status_code,
+                response_code=result.response.status_code,
                 error_message=error_message,
-                response_body=result.content,
+                response_body=result.response.content,
             )
 
     def http_get(
diff --git a/gitlab/http_backends/__init__.py b/gitlab/http_backends/__init__.py
@@ -2,6 +2,7 @@
 Defines http backends for processing http requests
 """
 
-from .requests_backend import RequestsBackend
+from .requests_backend import RequestsBackend, RequestsResponse
 
 DefaultBackend = RequestsBackend
+DefaultResponse = RequestsResponse
diff --git a/gitlab/http_backends/requests_backend.py b/gitlab/http_backends/requests_backend.py
@@ -4,6 +4,15 @@
 from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
 
 
+class RequestsResponse:
+    def __init__(self, response: requests.Response) -> None:
+        self._response: requests.Response = response
+
+    @property
+    def response(self) -> requests.Response:
+        return self._response
+
+
 class RequestsBackend:
     def __init__(self, session: Optional[requests.Session] = None) -> None:
         self._client: requests.Session = session or requests.Session()
@@ -23,7 +32,7 @@ def http_request(
         verify: Optional[Union[bool, str]] = True,
         stream: Optional[bool] = False,
         **kwargs: Any
-    ) -> requests.Response:
+    ) -> RequestsResponse:
         """Make HTTP request
 
         Args:
@@ -40,7 +49,7 @@ def http_request(
         Returns:
             A requests Response object.
         """
-        return self._client.request(
+        response: requests.Response = self._client.request(
             method=method,
             url=url,
             params=params,
@@ -51,3 +60,4 @@ def http_request(
             json=json,
             **kwargs
         )
+        return RequestsResponse(response=response)
