feat: Bootstrapping the http_engines concept

Liora Milbaum · Liora Milbaum · commit e043182e60cf · 2022-11-24T05:19:16.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_engines, utils
 
 REDIRECT_MSG = (
     "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
@@ -55,6 +55,11 @@ class Gitlab:
             differs from response headers
     """
 
+    # The session object is defined here as long as the RequestsEngine is not
+    # fully implemented. The long-term goal is to wrap all the http
+    # requests/responses by the RequestsEngine class
+    session: requests.Session
+
     def __init__(
         self,
         url: Optional[str] = None,
@@ -66,14 +71,20 @@ 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:
+        """
+        kwargs:-
+        :param requests.Session session: (optional). Http Requests Session.
+        :param RequestsEngine http_engine: (optional). Engine that will be used
+               to make http requests.
+        """
 
         self._api_version = str(api_version)
         self._server_version: Optional[str] = None
@@ -98,7 +109,9 @@ def __init__(
         self._set_auth_info()
 
         #: Create a session object for requests
-        self.session = session or requests.Session()
+        http_engine = kwargs.pop("http_engine", http_engines.DefaultEngine)
+        self.http_engine = http_engine(**kwargs)
+        self.session = self.http_engine.client
 
         self.per_page = per_page
         self.pagination = pagination
diff --git a/gitlab/http_engines/__init__.py b/gitlab/http_engines/__init__.py
@@ -0,0 +1,7 @@
+"""
+Defines http engines for processing http requests
+"""
+
+from .requests_engine import RequestsEngine
+
+DefaultEngine = RequestsEngine
diff --git a/gitlab/http_engines/requests_engine.py b/gitlab/http_engines/requests_engine.py
@@ -0,0 +1,15 @@
+from typing import Any
+
+import requests
+
+
+class RequestsEngine:
+
+    _client: requests.Session
+
+    def __init__(self, **kwargs: Any) -> None:
+        self._client = kwargs.pop("session", requests.Session())
+
+    @property
+    def client(self) -> requests.Session:
+        return self._client
