bring your own requests.Session() (#98)

* feat: bring your own requests session

* use request method instead of post

* fix: user-agent

* refactor logic from ContextHttpClient into wrapping class to be api compatible to requests.Session

* fix test

* feat: release v2.1.16

* Update libs/foundry-dev-tools/src/foundry_dev_tools/config/context.py

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: nicornk

docs/changelog.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
+## [2.1.16] - 2025-05-16
+
+## Added 
+- add multipass API to delete Users. (#96)
+- bring your own requests.Session() (#98)
+
+## Fixed
+- update deploy-pages version to v4	
+
 ## [2.1.15] - 2024-12-18
 
 ## Added
@@ -333,6 +342,7 @@ and this project adheres to [Semantic Versioning].
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
 
+[2.1.16]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.15...v2.1.16
 [2.1.15]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.14...v2.1.15
 [2.1.14]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.13...v2.1.14
 [2.1.13]: https://github.com/emdgroup/foundry-dev-tools/compare/v2.1.12...v2.1.13

docs/configuration.md

@@ -78,6 +78,7 @@ ctx.config.cache_dir = cache_dir
 Configuring Foundry DevTools in Python works through the [FoundryContext].
 
 ```python
+import requests
 from foundry_dev_tools import FoundryContext
 
 # this way it will take the configuration and credentials
@@ -104,6 +105,9 @@ ctx = FoundryContext(config=Config())
 
 # For example to enable some debug logging
 ctx = FoundryContext(config=Config(debug=True))
+
+# if you want to bring your own requests.session
+ctx = FoundryContext(config=Config(debug=True, requests_session=requests.Session()))
 ```
 ### Configuration for Transforms
 

libs/foundry-dev-tools/src/foundry_dev_tools/clients/api_client.py

@@ -4,6 +4,7 @@
 
 from typing import TYPE_CHECKING, ClassVar, Literal
 
+from foundry_dev_tools.errors.handling import ErrorHandlingConfig, raise_foundry_api_error
 from foundry_dev_tools.utils.clients import build_api_url, build_public_api_url
 
 if TYPE_CHECKING:
@@ -23,7 +24,6 @@
     )
 
     from foundry_dev_tools.config.context import FoundryContext
-    from foundry_dev_tools.errors.handling import ErrorHandlingConfig
 
 
 class APIClient:
@@ -93,7 +93,7 @@ def api_request(
         else:
             headers = {"content-type": "application/json"}
 
-        return self.context.client.request(
+        response = self.context.client.request(
             method=method,
             url=self.api_url(api_path),
             params=params,
@@ -110,8 +110,9 @@ def api_request(
             verify=verify,
             cert=cert,
             json=json,
-            error_handling=error_handling,
         )
+        raise_foundry_api_error(response, error_handling)
+        return response
 
 
 class PublicAPIClient:
@@ -196,7 +197,7 @@ def api_request(
                 params["preview"] = "true"
             else:
                 params = {"preview": "true"}
-        return self.context.client.request(
+        response = self.context.client.request(
             method=method,
             url=self.api_url(api_path, version=api_version),
             params=params,
@@ -213,5 +214,6 @@ def api_request(
             verify=verify,
             cert=cert,
             json=json,
-            error_handling=error_handling,
         )
+        raise_foundry_api_error(response, error_handling)
+        return response

libs/foundry-dev-tools/src/foundry_dev_tools/clients/context_client.py

@@ -4,17 +4,15 @@
 
 import logging
 import numbers
-import os
 import time
 import typing
-from typing import TYPE_CHECKING, Literal
+from typing import TYPE_CHECKING
 
 import requests
 
-from foundry_dev_tools.__about__ import __version__
-from foundry_dev_tools.errors.handling import ErrorHandlingConfig, raise_foundry_api_error
-
 if TYPE_CHECKING:
+    from os import PathLike
+
     from requests import Response
     from requests.cookies import RequestsCookieJar
     from requests.sessions import (  # type: ignore[attr-defined]
@@ -31,7 +29,6 @@
         _Verify,
     )
 
-    from foundry_dev_tools.config.context import FoundryContext
 
 DEFAULT_TIMEOUT = (60, None)
 LOGGER = logging.getLogger(__name__)
@@ -73,14 +70,12 @@ def newfn(*args, **kwargs) -> typing.Callable:
 class ContextHTTPClient(requests.Session):
     """Requests Session with config and authentication applied."""
 
-    def __init__(self, context: FoundryContext) -> None:
-        self.context = context
+    def __init__(self, debug: bool = False, requests_ca_bundle: PathLike[str] | None = None) -> None:
+        self.debug = debug
+        self.requests_ca_bundle = requests_ca_bundle
         super().__init__()
-        if self.context.config.requests_ca_bundle:
-            self.verify = os.fspath(self.context.config.requests_ca_bundle)
-        self.auth = lambda r: self.context.token_provider.requests_auth_handler(r)
+
         self._counter = 0
-        self.headers = {"User-Agent": f"foundry-dev-tools/{__version__}/python-requests"}
 
     @retry(times=3, exceptions=requests.exceptions.ConnectionError)
     def request(
@@ -101,7 +96,6 @@ def request(
         verify: _Verify | None = None,
         cert: _Cert | None = None,
         json: Incomplete | None = None,
-        error_handling: ErrorHandlingConfig | Literal[False] | None = None,
     ) -> Response:
         """Make an authenticated HTTP request.
 
@@ -122,11 +116,10 @@ def request(
             verify: see :py:meth:`requests.Session.request`
             cert: see :py:meth:`requests.Session.request`
             json: see :py:meth:`requests.Session.request`
-            error_handling: error handling config; if set to False, errors won't be automatically handled
         """
-        if verify is None and (rcab := self.context.config.requests_ca_bundle) is not None:
+        if verify is None and (rcab := self.requests_ca_bundle) is not None:
             verify = rcab
-        if self.context.config.debug:
+        if self.debug:
             self._counter = count = self._counter + 1
             LOGGER.debug(f"(r{count}) Making {method!s} request to {url!s}")  # noqa: G004
 
@@ -155,12 +148,11 @@ def request(
             cert=cert,
             json=json,
         )
-        if self.context.config.debug:
+        if self.debug:
             LOGGER.debug(
                 f"(r{count}) Got response status={response.status_code}, "  # noqa: G004
                 f"content_type={response.headers.get('content-type')}, "
                 f"content_length={response.headers.get('content-length')}, "
                 f"Server-Timing={response.headers.get('Server-Timing')}",
             )
-        raise_foundry_api_error(response, error_handling)
         return response

libs/foundry-dev-tools/src/foundry_dev_tools/clients/s3_client.py

@@ -177,7 +177,8 @@ def api_assume_role_with_webidentity(self, expiration_duration: int = 3600) -> r
             expiration_duration: seconds the credentials should be valid, defaults to 3600 (the upper bound)
         """
         # does not call the api_request method, as this is not a regular api
-        resp = self.context.client.post(
+        resp = self.context.client.request(
+            "POST",
             self.get_url(),
             params={
                 "Action": "AssumeRoleWithWebIdentity",

libs/foundry-dev-tools/src/foundry_dev_tools/config/config.py

@@ -32,6 +32,8 @@
     from collections.abc import Iterable
     from os import PathLike
 
+    import requests
+
 # compatibility for python version < 3.11
 if sys.version_info < (3, 11):
     import tomli as tomllib
@@ -54,6 +56,7 @@ def __init__(
         transforms_output_folder: PathLike[str] | None = None,
         rich_traceback: bool = False,
         debug: bool = False,
+        requests_session: requests.Session | None = None,
     ) -> None:
         """Initialize the configuration.
 
@@ -76,6 +79,7 @@ def __init__(
                 files are written to this folder.
             rich_traceback: enables a prettier traceback provided by the module `rich` See: https://rich.readthedocs.io/en/stable/traceback.html
             debug: enables debug logging
+            requests_session (requests.Session): Overwrite the default used requests.Session.
 
         """
         self.requests_ca_bundle = os.fspath(requests_ca_bundle) if requests_ca_bundle else None
@@ -90,6 +94,7 @@ def __init__(
         self.transforms_freeze_cache = bool(transforms_freeze_cache)
         self.rich_traceback = bool(rich_traceback)
         self.debug = bool(debug)
+        self.requests_session = requests_session
 
     def __repr__(self) -> str:
         return "<" + self.__class__.__name__ + "(" + self.__dict__.__str__() + ")>"

libs/foundry-dev-tools/src/foundry_dev_tools/config/context.py

@@ -2,9 +2,13 @@
 
 from __future__ import annotations
 
+import os
 from functools import cached_property, partial
 from typing import TYPE_CHECKING
 
+import requests
+
+from foundry_dev_tools.__about__ import __version__
 from foundry_dev_tools.clients import (
     build2,
     catalog,
@@ -42,7 +46,7 @@ class FoundryContext:
 
     config: Config
     token_provider: TokenProvider
-    client: context_client.ContextHTTPClient
+    client: requests.Session
 
     def __init__(
         self,
@@ -57,7 +61,21 @@ def __init__(
         else:
             self.token_provider = token_provider
             self.config = config
-        self.client = context_client.ContextHTTPClient(self)
+
+        if not self.config.requests_session:
+            self.client = context_client.ContextHTTPClient(
+                debug=self.config.debug, requests_ca_bundle=self.config.requests_ca_bundle
+            )
+        else:
+            self.client = self.config.requests_session
+
+        self.client.auth = lambda r: self.token_provider.requests_auth_handler(r)
+        self.client.headers["User-Agent"] = requests.utils.default_user_agent(
+            f"foundry-dev-tools/{__version__}/python-requests"
+        )
+        if self.config.requests_ca_bundle:
+            self.verify = os.fspath(self.config.requests_ca_bundle)
+
         if self.config.rich_traceback:
             from rich.traceback import install
 

tests/unit/clients/test_context_client.py

@@ -27,7 +27,9 @@ def test_context_http_client(test_context_mock, foundry_client_id):
 
     req = test_context_mock.client.request("POST", "http+mock://test_authorization").request
     assert req.headers["Authorization"] == f"Bearer {test_context_mock.token}"
-    assert req.headers["User-Agent"] == f"foundry-dev-tools/{__version__}/python-requests"
+    from requests import __version__ as requests_version
+
+    assert req.headers["User-Agent"] == f"foundry-dev-tools/{__version__}/python-requests/{requests_version}"
 
     tokens = ["token_from_oauth", "second_token_from_oauth"]