feat: Bootstrapping the http_engines concept

Liora Milbaum · Liora Milbaum · commit ba2ee6caafed · 2022-11-26T19:14:40.000+02:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -14,7 +14,7 @@
 import gitlab.config
 import gitlab.const
 import gitlab.exceptions
-from gitlab import utils
+from gitlab import http_backends, utils
 
 REDIRECT_MSG = (
     "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
@@ -32,6 +32,13 @@
 
 
 class Gitlab:
+
+    # The session object is defined here as long as the RequestsBackend is not
+    # fully implemented. The long-term goal is to wrap all the http
+    # requests/responses by the RequestsBackend class
+
+    session: requests.Session
+
     """Represents a GitLab server connection.
 
     Args:
@@ -53,6 +60,10 @@ class Gitlab:
             or 52x responses. Defaults to False.
         keep_base_url: keep user-provided base URL for pagination if it
             differs from response headers
+
+    Keyward Args:
+        requests.Session session: Http Requests Session
+        RequestsBackend http_backend: Backend that will be used to make http requests
     """
 
     def __init__(
@@ -66,15 +77,14 @@ def __init__(
         http_password: Optional[str] = None,
         timeout: Optional[float] = None,
         api_version: str = "4",
-        session: Optional[requests.Session] = None,
         per_page: Optional[int] = None,
         pagination: Optional[str] = None,
         order_by: Optional[str] = None,
         user_agent: str = gitlab.const.USER_AGENT,
         retry_transient_errors: bool = False,
         keep_base_url: bool = False,
+        **kwargs: Any,
     ) -> None:
-
         self._api_version = str(api_version)
         self._server_version: Optional[str] = None
         self._server_revision: Optional[str] = None
@@ -98,7 +108,9 @@ def __init__(
         self._set_auth_info()
 
         #: Create a session object for requests
-        self.session = session or requests.Session()
+        http_backend = kwargs.pop("http_backend", http_backends.DefaultBackend)
+        self.http_backend = http_backend(**kwargs)
+        self.session = self.http_backend.client
 
         self.per_page = per_page
         self.pagination = pagination
diff --git a/gitlab/http_backends/__init__.py b/gitlab/http_backends/__init__.py
@@ -0,0 +1,7 @@
+"""
+Defines http backends for processing http requests
+"""
+
+from .requests_backend import RequestsBackend
+
+DefaultBackend = RequestsBackend
diff --git a/gitlab/http_backends/requests_backend.py b/gitlab/http_backends/requests_backend.py
@@ -0,0 +1,15 @@
+from typing import Optional
+
+import requests
+
+
+class RequestsBackend:
+
+    _client: requests.Session
+
+    def __init__(self, session: Optional[requests.Session] = None) -> None:
+        self._client = session or requests.Session()
+
+    @property
+    def client(self) -> requests.Session:
+        return self._client
