feat: Generation of Gitlab class with custom requests session

Liora Milbaum · Liora Milbaum · commit 6c962b018ce7 · 2022-11-26T22:20:55.000+02:00
diff --git a/docs/api-usage-advanced.rst b/docs/api-usage-advanced.rst
@@ -181,3 +181,15 @@ on your own, such as for nested API responses and ``Union`` return types. For ex
 
    if TYPE_CHECKING:
       assert isinstance(license["plan"], str)
+
+Custom session (Bring your own Session) 
+---------------------------------------
+
+You can use configuration files and a custom session to create 
+``gitlab.Gitlab`` objects:
+
+.. code-block:: python
+
+   gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'], session=custom_session)
+
+
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/conftest.py b/tests/conftest.py
@@ -1,4 +1,5 @@
 import pathlib
+import tempfile
 
 import _pytest.config
 import pytest
@@ -38,3 +39,8 @@ def valid_gitlab_ci_yml() -> str:
 @pytest.fixture
 def invalid_gitlab_ci_yml() -> str:
     return "invalid"
+
+
+@pytest.fixture(scope="session")
+def temp_dir() -> pathlib.Path:
+    return pathlib.Path(tempfile.gettempdir())
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
@@ -1,7 +1,6 @@
 import dataclasses
 import logging
 import pathlib
-import tempfile
 import time
 import uuid
 from subprocess import check_output
@@ -164,11 +163,6 @@ def pytest_addoption(parser):
     )
 
 
-@pytest.fixture(scope="session")
-def temp_dir() -> pathlib.Path:
-    return pathlib.Path(tempfile.gettempdir())
-
-
 @pytest.fixture(scope="session")
 def check_is_alive():
     """
diff --git a/tests/unit/test_gitlab.py b/tests/unit/test_gitlab.py
@@ -4,6 +4,7 @@
 from http.client import HTTPConnection
 
 import pytest
+import requests
 import responses
 
 import gitlab
@@ -412,3 +413,21 @@ def test_gitlab_keep_base_url(kwargs, link_header, expected_next_url, show_warni
     else:
         obj = gl.http_list("/tests", iterator=True)
     assert obj._next_url == expected_next_url
+
+
+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
