refactor: Replacing http_requests return type hint

Liora Milbaum · Liora Milbaum · commit 940a7b79b710 · 2023-02-17T05:48:55.000+02:00
diff --git a/docs/api-levels.rst b/docs/api-levels.rst
@@ -87,19 +87,19 @@ For example, if for whatever reason you want to fetch allowed methods for an end
 
     >>> gl = gitlab.Gitlab(private_token=private_token)
     >>>
-    >>> response = gl.http_request(verb="OPTIONS", path="/projects")
-    >>> response.headers["Allow"]
+    >>> backend_response = gl.http_request(verb="OPTIONS", path="/projects")
+    >>> backend_response.response.headers["Allow"]
     'OPTIONS, GET, POST, HEAD'
 
 Or get the total number of a user's events with a customized HEAD request:
 
 .. code-block:: python
 
-    >>> response = gl.http_request(
+    >>> backend_response = gl.http_request(
             verb="HEAD",
             path="/events",
             query_params={"sudo": "some-user"},
             timeout=10
         )
-    >>> response.headers["X-Total"]
+    >>> backend_response.response.headers["X-Total"]
     '123'
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -653,7 +653,7 @@ def http_request(
         retry_transient_errors: Optional[bool] = None,
         max_retries: int = 10,
         **kwargs: Any,
-    ) -> requests.Response:
+    ) -> _backends.DefaultResponse:
         """Make an HTTP request to the Gitlab server.
 
         Args:
@@ -749,7 +749,7 @@ def http_request(
             self._check_redirects(result.response)
 
             if 200 <= result.status_code < 300:
-                return result.response
+                return result
 
             def should_retry() -> bool:
                 if result.status_code == 429 and obey_rate_limit:
@@ -827,9 +827,10 @@ def http_get(
             GitlabParsingError: If the json data could not be parsed
         """
         query_data = query_data or {}
-        result = self.http_request(
+        backend_response = self.http_request(
             "get", path, query_data=query_data, streamed=streamed, **kwargs
         )
+        result = backend_response.response
 
         if (
             result.headers["Content-Type"] == "application/json"
@@ -866,8 +867,10 @@ def http_head(
         """
 
         query_data = query_data or {}
-        result = self.http_request("head", path, query_data=query_data, **kwargs)
-        return result.headers
+        backend_response = self.http_request(
+            "head", path, query_data=query_data, **kwargs
+        )
+        return backend_response.headers
 
     def http_list(
         self,
@@ -1023,7 +1026,7 @@ def http_post(
         query_data = query_data or {}
         post_data = post_data or {}
 
-        result = self.http_request(
+        backend_response = self.http_request(
             "post",
             path,
             query_data=query_data,
@@ -1032,6 +1035,8 @@ def http_post(
             raw=raw,
             **kwargs,
         )
+        result = backend_response.response
+
         try:
             if result.headers.get("Content-Type", None) == "application/json":
                 json_result = result.json()
@@ -1075,7 +1080,7 @@ def http_put(
         query_data = query_data or {}
         post_data = post_data or {}
 
-        result = self.http_request(
+        backend_response = self.http_request(
             "put",
             path,
             query_data=query_data,
@@ -1085,7 +1090,7 @@ def http_put(
             **kwargs,
         )
         try:
-            json_result = result.json()
+            json_result = backend_response.json()
             if TYPE_CHECKING:
                 assert isinstance(json_result, dict)
             return json_result
@@ -1124,7 +1129,7 @@ def http_patch(
         query_data = query_data or {}
         post_data = post_data or {}
 
-        result = self.http_request(
+        backend_response = self.http_request(
             "patch",
             path,
             query_data=query_data,
@@ -1133,7 +1138,7 @@ def http_patch(
             **kwargs,
         )
         try:
-            json_result = result.json()
+            json_result = backend_response.json()
             if TYPE_CHECKING:
                 assert isinstance(json_result, dict)
             return json_result
@@ -1156,7 +1161,8 @@ def http_delete(self, path: str, **kwargs: Any) -> requests.Response:
         Raises:
             GitlabHttpError: When the return code is not 2xx
         """
-        return self.http_request("delete", path, **kwargs)
+        backend_response = self.http_request("delete", path, **kwargs)
+        return backend_response.response
 
     @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabSearchError)
     def search(
@@ -1210,7 +1216,11 @@ def _query(
         self, url: str, query_data: Optional[Dict[str, Any]] = None, **kwargs: Any
     ) -> None:
         query_data = query_data or {}
-        result = self._gl.http_request("get", url, query_data=query_data, **kwargs)
+        backend_response = self._gl.http_request(
+            "get", url, query_data=query_data, **kwargs
+        )
+        result = backend_response.response
+
         try:
             next_url = result.links["next"]["url"]
         except KeyError:
