Merge pull request #148 from andrewschenck/requests_session_injection

Injection for requests.Session
cisco-en-programmability · Aug 14, 2024 · a83191f · a83191f
2 parents 410d0d4 + 26b2b08
commit a83191f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/dnacentersdk/api/__init__.py b/dnacentersdk/api/__init__.py
@@ -427,6 +427,7 @@ def __init__(self, username=None,
                  base_url=None,
                  single_request_timeout=None,
                  wait_on_rate_limit=None,
+                 session=None,
                  verify=None,
                  version=None,
                  debug=None,
@@ -479,6 +480,8 @@ def __init__(self, username=None,
                 (or DNA_CENTER_VERIFY_STRING) environment variable or
                 dnacentersdk.config.DEFAULT_VERIFY if the environment
                 variables are not set.
+            session(requests.Session): Optionally inject a `requests.Session`
+                instance to use for HTTP operations.
             version(str): Controls which version of DNA_CENTER to use.
                 Defaults to the DNA_CENTER_VERSION environment variable or
                 dnacentersdk.config.DEFAULT_VERSION
@@ -584,6 +587,7 @@ def get_access_token():
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             wait_on_rate_limit=wait_on_rate_limit,
+            session=session,
             verify=verify,
             version=version,
             debug=debug,

diff --git a/dnacentersdk/restsession.py b/dnacentersdk/restsession.py
@@ -135,6 +135,7 @@ class RestSession(object):
     def __init__(self, get_access_token, access_token, base_url,
                  single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
                  wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT,
+                 session=None,
                  verify=DEFAULT_VERIFY,
                  version=None,
                  debug=False):
@@ -151,6 +152,8 @@ def __init__(self, get_access_token, access_token, base_url,
                 HTTP REST API request.
             wait_on_rate_limit(bool): Enable or disable automatic rate-limit
                 handling.
+            session(requests.Session): Optionally inject a `requests.Session`
+                object to be used for HTTP operations.
             verify(bool,str): Controls whether we verify the server's
                 TLS certificate, or a string, in which case it must be a path
                 to a CA bundle to use.
@@ -194,8 +197,8 @@ def __init__(self, get_access_token, access_token, base_url,
         if verify is False:
             requests.packages.urllib3.disable_warnings()
 
-        # Initialize a new `requests` session
-        self._req_session = requests.session()
+        # Use the injected `requests` session, build a new one if not provided
+        self._req_session = session or requests.session()
 
         # Update the headers of the `requests` session
         self.update_headers({'X-Auth-Token': access_token,