Copy session_utils.create_session_from_gcp_credentials() to ext.gcp.session_utils and add deprecation warning to the original.

Author: agharwal

docs/package.rst

@@ -45,15 +45,23 @@ dicomweb\_client.session_utils module
     :show-inheritance:
 
 dicomweb\_client.uri module
-+++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++
 
 .. automodule:: dicomweb_client.uri
     :members:
     :undoc-members:
     :show-inheritance:
 
+dicomweb\_client.ext.gcp.session_utils module
++++++++++++++++++++++++++++++++++++++++++++++
+
+.. automodule:: dicomweb_client.ext.gcp.session_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 dicomweb\_client.ext.gcp.uri module
-+++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++
 
 .. automodule:: dicomweb_client.ext.gcp.uri
     :members:

src/dicomweb_client/ext/gcp/session_utils.py

@@ -0,0 +1,31 @@
+"""Session management utilities for Google Cloud Platform (GCP)."""
+from typing import Optional, Any
+
+import google.auth
+from google.auth.transport import requests as google_requests
+import requests
+
+
+def create_session_from_gcp_credentials(
+        google_credentials: Optional[Any] = None
+    ) -> requests.Session:
+    """Creates an authorized session for Google Cloud Platform.
+
+    Parameters
+    ----------
+    google_credentials: Any
+        Google Cloud credentials.
+        (see https://cloud.google.com/docs/authentication/production
+        for more information on Google Cloud authentication).
+        If not set, will be initialized to ``google.auth.default()``.
+
+    Returns
+    -------
+    requests.Session
+        Google Cloud authorized session.
+    """
+    if google_credentials is None:
+        google_credentials, _ = google.auth.default(
+            scopes=['https://www.googleapis.com/auth/cloud-platform']
+        )
+    return google_requests.AuthorizedSession(google_credentials)

src/dicomweb_client/session_utils.py

@@ -1,6 +1,7 @@
 import logging
 import os
 from typing import Optional, Any
+import warnings
 
 import requests
 
@@ -128,20 +129,19 @@ def create_session_from_gcp_credentials(
     -------
     requests.Session
         Google cloud authorized session
-
     """
+    warnings.warn(
+        'This method shall be deprecated in a future release. Prefer using the '
+        'underlying implementation directly, now moved to '
+        '`dicomweb_client.ext.gcp.session_utils`.',
+        DeprecationWarning)
     try:
-        from google.auth.transport import requests as google_requests
-        if google_credentials is None:
-            import google.auth
-            google_credentials, _ = google.auth.default(
-                scopes=['https://www.googleapis.com/auth/cloud-platform']
-            )
+        import dicomweb_client.ext.gcp.session_utils as gcp_session_utils
     except ImportError:
         raise ImportError(
             'The dicomweb-client package needs to be installed with the '
             '"gcp" extra requirements to support interaction with the '
             'Google Cloud Healthcare API: pip install dicomweb-client[gcp]'
         )
-    logger.debug('initialize, authenticate and authorize HTTP session')
-    return google_requests.AuthorizedSession(google_credentials)
+    return gcp_session_utils.create_session_from_gcp_credentials(
+        google_credentials)