feat: Generation of Gitlab class with custom requests session

Liora Milbaum · Liora Milbaum · commit 3ba13578c4f8 · 2022-11-24T12:42:08.000+02:00
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -62,6 +62,13 @@ You can also use configuration files to create ``gitlab.Gitlab`` objects:
 
    gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'])
 
+With custom session
+
+.. code-block:: python
+
+   gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'], session=custom_session)
+
+
 See the :ref:`cli_configuration` section for more information about
 configuration files.
 
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -232,14 +232,20 @@ def api_version(self) -> str:
 
     @classmethod
     def from_config(
-        cls, gitlab_id: Optional[str] = None, config_files: Optional[List[str]] = None
+        cls,
+        gitlab_id: Optional[str] = None,
+        config_files: Optional[List[str]] = None,
+        **kwargs: Any,
     ) -> "Gitlab":
         """Create a Gitlab connection from configuration files.
 
         Args:
             gitlab_id: ID of the configuration section.
             config_files list[str]: List of paths to configuration files.
 
+        kwargs:
+            session requests.Session: Custom requests Session
+
         Returns:
             A Gitlab connection.
 
@@ -264,6 +270,7 @@ def from_config(
             order_by=config.order_by,
             user_agent=config.user_agent,
             retry_transient_errors=config.retry_transient_errors,
+            **kwargs,
         )
 
     @classmethod
diff --git a/tests/functional/api/test_gitlab.py b/tests/functional/api/test_gitlab.py
@@ -1,4 +1,5 @@
 import pytest
+import requests
 
 import gitlab
 
@@ -23,6 +24,24 @@ def test_auth_from_config(gl, temp_dir):
     assert isinstance(test_gitlab.user, gitlab.v4.objects.CurrentUser)
 
 
+def test_no_custom_session(gl, temp_dir):
+    """Test no custom session"""
+    custom_session = requests.Session()
+    test_gitlab = gitlab.Gitlab.from_config(
+        config_files=[temp_dir / "python-gitlab.cfg"]
+    )
+    assert test_gitlab.session != custom_session
+
+
+def test_custom_session(gl, temp_dir):
+    """Test custom session"""
+    custom_session = requests.Session()
+    test_gitlab = gitlab.Gitlab.from_config(
+        config_files=[temp_dir / "python-gitlab.cfg"], session=custom_session
+    )
+    assert test_gitlab.session == custom_session
+
+
 def test_broadcast_messages(gl, get_all_kwargs):
     msg = gl.broadcastmessages.create({"message": "this is the message"})
     msg.color = "#444444"
