ibm-cloud-sdk-core 3.20.6__tar.gz → 3.21.0__tar.gz

ibm_cloud_sdk_core-3.21.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: ibm-cloud-sdk-core
+Version: 3.21.0
+Summary: Core library used by SDKs for IBM Cloud Services
+Author-email: IBM <devxsdk@us.ibm.com>
+Project-URL: Repository, https://github.com/IBM/python-sdk-core
+Project-URL: Documentation, https://github.com/IBM/python-sdk-core/blob/main/README.md
+Project-URL: Issues, https://github.com/IBM/python-sdk-core/issues
+Project-URL: Changelog, https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md
+Project-URL: Contributing, https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md
+Project-URL: License, https://github.com/IBM/python-sdk-core/blob/main/LICENSE
+Keywords: ibm,cloud,ibm cloud services
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Provides-Extra: dev
+Requires-Dist: coverage<8.0.0,>=7.3.2; extra == "dev"
+Requires-Dist: pylint<4.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: pytest<8.0.0,>=7.4.2; extra == "dev"
+Requires-Dist: pytest-cov<5.0.0,>=4.1.0; extra == "dev"
+Requires-Dist: responses<1.0.0,>=0.23.3; extra == "dev"
+Requires-Dist: black<25.0.0,>=24.0.0; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+
+[![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
+[![Latest Stable Version](https://img.shields.io/pypi/v/ibm-cloud-sdk-core.svg)](https://pypi.python.org/pypi/ibm-cloud-sdk-core)
+[![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+# IBM Python SDK Core Version 3.21.0
+This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
+(openapi-sdkgen).
+
+# Python Version
+The current minimum Python version supported is 3.8.
+
+## Installation
+
+To install, use `pip`:
+
+```bash
+python -m pip install --upgrade ibm-cloud-sdk-core
+```
+
+## Authentication
+The python-sdk-core project supports the following types of authentication:
+- Basic Authentication
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication
+- Container Authentication
+- VPC Instance Authentication
+- Cloud Pak for Data Authentication
+- No Authentication (for testing)
+
+For more information about the various authentication types and how to use them with your services, click [here](Authentication.md).
+
+## Issues
+
+If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/python-sdk-core/issues).
+Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
+
+## Logging
+
+This library uses Python's built-in `logging` module to perform logging of error,
+warning, informational and debug messages.
+The components within the SDK Core library use a single logger named `ibm-cloud-sdk-core`.
+
+For complete information on the logging facility, please see: [Logging facility for Python](https://docs.python.org/3/library/logging.html).
+
+### Enable logging
+
+There are various ways to configure and enable the logging facility.
+
+The code example below demonstrates a simple way to enable debug logging by invoking
+the `logging.basicConfig()` function.
+
+Note that, as a convenience, if you set the logging level to `DEBUG`, then HTTP request/response message logging
+is also enabled.
+
+The following code example shows how debug logging can be enabled:
+```python
+import logging
+
+# Create a basic logging configuration that:
+# 1. Defines a handler to display messages on the console.
+# 2. Sets the root logger's logging level to DEBUG.
+# 3. Sets the 'format' string used to display messages.
+logging.basicConfig(level=logging.DEBUG, format='%(asctime)s [%(name)s:%(levelname)s] %(message)s', force=True)
+```
+
+When running your application, you should see output like this if debug logging is enabled:
+```
+2024-09-16 15:44:45,174 [ibm-cloud-sdk-core:DEBUG] Get authenticator from environment, key=global_search
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set service URL: https://api.global-search-tagging.cloud.ibm.com
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set User-Agent: ibm-python-sdk-core-3.21.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Configuring BaseService instance with service name: global_search
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Performing synchronous token fetch
+2024-09-16 15:44:45,182 [ibm-cloud-sdk-core:DEBUG] Invoking IAM get_token operation: https://iam.cloud.ibm.com/identity/token
+2024-09-16 15:44:45,182 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): iam.cloud.ibm.com:443
+send: b'POST /identity/token HTTP/1.1\r\nHost: iam.cloud.ibm.com\r\nUser-Agent: ibm-python-sdk-core/iam-authenticator-3.21.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\nContent-Type: application/x-www-form-urlencoded\r\nContent-Length: 135\r\n\r\n'
+send: b'grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=[redacted]&response_type=cloud_iam'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Language: en-US
+header: Content-Encoding: gzip
+header: Date: Mon, 16 Sep 2024 20:44:45 GMT
+header: Content-Length: 983
+header: Connection: keep-alive
+2024-09-16 15:44:45,670 [urllib3.connectionpool:DEBUG] https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/11" 200 983
+2024-09-16 15:44:45,672 [ibm-cloud-sdk-core:DEBUG] Returned from IAM get_token operation
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Authenticated outbound request (type=iam)
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Prepared request [POST https://api.global-search-tagging.cloud.ibm.com/v3/resources/search]
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Sending HTTP request message
+2024-09-16 15:44:45,674 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): api.global-search-tagging.cloud.ibm.com:443
+send: b'POST /v3/resources/search?limit=1 HTTP/1.1\r\nHost: api.global-search-tagging.cloud.ibm.com\r\nUser-Agent: platform-services-python-sdk/0.57.0 (lang=python; os.name=Linux; os.version=6.10.9-100.fc39.x86_64; python.version=3.12.5)\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\ncontent-type: application/json\r\nAuthorization: [redacted]\r\nContent-Length: 39\r\n\r\n'
+send: b'{"query": "GST-sdk-*", "fields": ["*"]}'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Length: 22
+header: Date: Mon, 16 Sep 2024 20:44:46 GMT
+header: Connection: keep-alive
+2024-09-16 15:44:46,079 [urllib3.connectionpool:DEBUG] https://api.global-search-tagging.cloud.ibm.com:443 "POST /v3/resources/search?limit=1 HTTP/11" 200 22
+2024-09-16 15:44:46,080 [ibm-cloud-sdk-core:DEBUG] Received HTTP response message, status code 200
+```
+
+## Open source @ IBM
+
+Find more open source projects on the [IBM Github Page](http://github.com/IBM)
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).

ibm_cloud_sdk_core-3.21.0/README.md

@@ -0,0 +1,114 @@
+[![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
+[![Latest Stable Version](https://img.shields.io/pypi/v/ibm-cloud-sdk-core.svg)](https://pypi.python.org/pypi/ibm-cloud-sdk-core)
+[![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+# IBM Python SDK Core Version 3.21.0
+This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
+(openapi-sdkgen).
+
+# Python Version
+The current minimum Python version supported is 3.8.
+
+## Installation
+
+To install, use `pip`:
+
+```bash
+python -m pip install --upgrade ibm-cloud-sdk-core
+```
+
+## Authentication
+The python-sdk-core project supports the following types of authentication:
+- Basic Authentication
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication
+- Container Authentication
+- VPC Instance Authentication
+- Cloud Pak for Data Authentication
+- No Authentication (for testing)
+
+For more information about the various authentication types and how to use them with your services, click [here](Authentication.md).
+
+## Issues
+
+If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/python-sdk-core/issues).
+Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
+
+## Logging
+
+This library uses Python's built-in `logging` module to perform logging of error,
+warning, informational and debug messages.
+The components within the SDK Core library use a single logger named `ibm-cloud-sdk-core`.
+
+For complete information on the logging facility, please see: [Logging facility for Python](https://docs.python.org/3/library/logging.html).
+
+### Enable logging
+
+There are various ways to configure and enable the logging facility.
+
+The code example below demonstrates a simple way to enable debug logging by invoking
+the `logging.basicConfig()` function.
+
+Note that, as a convenience, if you set the logging level to `DEBUG`, then HTTP request/response message logging
+is also enabled.
+
+The following code example shows how debug logging can be enabled:
+```python
+import logging
+
+# Create a basic logging configuration that:
+# 1. Defines a handler to display messages on the console.
+# 2. Sets the root logger's logging level to DEBUG.
+# 3. Sets the 'format' string used to display messages.
+logging.basicConfig(level=logging.DEBUG, format='%(asctime)s [%(name)s:%(levelname)s] %(message)s', force=True)
+```
+
+When running your application, you should see output like this if debug logging is enabled:
+```
+2024-09-16 15:44:45,174 [ibm-cloud-sdk-core:DEBUG] Get authenticator from environment, key=global_search
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set service URL: https://api.global-search-tagging.cloud.ibm.com
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set User-Agent: ibm-python-sdk-core-3.21.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Configuring BaseService instance with service name: global_search
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Performing synchronous token fetch
+2024-09-16 15:44:45,182 [ibm-cloud-sdk-core:DEBUG] Invoking IAM get_token operation: https://iam.cloud.ibm.com/identity/token
+2024-09-16 15:44:45,182 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): iam.cloud.ibm.com:443
+send: b'POST /identity/token HTTP/1.1\r\nHost: iam.cloud.ibm.com\r\nUser-Agent: ibm-python-sdk-core/iam-authenticator-3.21.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\nContent-Type: application/x-www-form-urlencoded\r\nContent-Length: 135\r\n\r\n'
+send: b'grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=[redacted]&response_type=cloud_iam'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Language: en-US
+header: Content-Encoding: gzip
+header: Date: Mon, 16 Sep 2024 20:44:45 GMT
+header: Content-Length: 983
+header: Connection: keep-alive
+2024-09-16 15:44:45,670 [urllib3.connectionpool:DEBUG] https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/11" 200 983
+2024-09-16 15:44:45,672 [ibm-cloud-sdk-core:DEBUG] Returned from IAM get_token operation
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Authenticated outbound request (type=iam)
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Prepared request [POST https://api.global-search-tagging.cloud.ibm.com/v3/resources/search]
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Sending HTTP request message
+2024-09-16 15:44:45,674 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): api.global-search-tagging.cloud.ibm.com:443
+send: b'POST /v3/resources/search?limit=1 HTTP/1.1\r\nHost: api.global-search-tagging.cloud.ibm.com\r\nUser-Agent: platform-services-python-sdk/0.57.0 (lang=python; os.name=Linux; os.version=6.10.9-100.fc39.x86_64; python.version=3.12.5)\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\ncontent-type: application/json\r\nAuthorization: [redacted]\r\nContent-Length: 39\r\n\r\n'
+send: b'{"query": "GST-sdk-*", "fields": ["*"]}'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Length: 22
+header: Date: Mon, 16 Sep 2024 20:44:46 GMT
+header: Connection: keep-alive
+2024-09-16 15:44:46,079 [urllib3.connectionpool:DEBUG] https://api.global-search-tagging.cloud.ibm.com:443 "POST /v3/resources/search?limit=1 HTTP/11" 200 22
+2024-09-16 15:44:46,080 [ibm-cloud-sdk-core:DEBUG] Received HTTP response message, status code 200
+```
+
+## Open source @ IBM
+
+Find more open source projects on the [IBM Github Page](http://github.com/IBM)
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/basic_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,11 +15,15 @@
 # limitations under the License.
 
 import base64
+
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..utils import has_bad_first_or_last_char
 
+logger = get_logger()
+
 
 class BasicAuthenticator(Authenticator):
     """The BasicAuthenticator is used to add basic authentication information to requests.
@@ -41,6 +45,7 @@ class BasicAuthenticator(Authenticator):
         self.password = password
         self.validate()
         self.authorization_header = self.__construct_basic_auth_header()
+        logger.debug('Created new BasicAuthenticator instance!')
 
     def authentication_type(self) -> str:
         """Returns this authenticator's type ('basic')."""
@@ -81,3 +86,4 @@ class BasicAuthenticator(Authenticator):
         """
         headers = req.get('headers')
         headers['Authorization'] = self.authorization_header
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,8 +16,11 @@
 
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 
+logger = get_logger()
+
 
 class BearerTokenAuthenticator(Authenticator):
     """The BearerTokenAuthenticator will add a user-supplied bearer token
@@ -37,6 +40,7 @@ class BearerTokenAuthenticator(Authenticator):
     def __init__(self, bearer_token: str) -> None:
         self.bearer_token = bearer_token
         self.validate()
+        logger.debug('Created BearerTokenAuthenticator instance!')
 
     def authentication_type(self) -> str:
         """Returns this authenticator's type ('bearertoken')."""
@@ -66,6 +70,7 @@ class BearerTokenAuthenticator(Authenticator):
         """
         headers = req.get('headers')
         headers['Authorization'] = 'Bearer {0}'.format(self.bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
 
     def set_bearer_token(self, bearer_token: str) -> None:
         """Set a new bearer token to be sent in subsequent service operations.

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/cp4d_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,13 +15,15 @@
 # limitations under the License.
 
 from typing import Dict, Optional
-
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..token_managers.cp4d_token_manager import CP4DTokenManager
 from ..utils import has_bad_first_or_last_char
 
+logger = get_logger()
+
 
 class CloudPakForDataAuthenticator(Authenticator):
     """The CloudPakForDataAuthenticator utilizes a username and password pair to
@@ -133,6 +135,7 @@ class CloudPakForDataAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
 
     def set_disable_ssl_verification(self, status: bool = False) -> None:
         """Set the flag that indicates whether verification of the server's SSL certificate should be

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/iam_request_based_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,8 +18,11 @@ from typing import Dict
 
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 
+logger = get_logger()
+
 
 class IAMRequestBasedAuthenticator(Authenticator):
     """The IAMRequestBasedAuthenticator class contains code that is common to all authenticators
@@ -60,6 +63,7 @@ class IAMRequestBasedAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
 
     def set_client_id_and_secret(self, client_id: str, client_secret: str) -> None:
         """Set the client_id and client_secret pair the token manager will use for IAM token requests.

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/mcsp_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2023 IBM All Rights Reserved.
+# Copyright 2023, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,12 @@ from typing import Dict, Optional
 
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..token_managers.mcsp_token_manager import MCSPTokenManager
 
+logger = get_logger()
+
 
 class MCSPAuthenticator(Authenticator):
     """The MCSPAuthenticator uses an apikey to obtain an access token from the MCSP token server.
@@ -98,6 +101,7 @@ class MCSPAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
 
     def set_disable_ssl_verification(self, status: bool = False) -> None:
         """Set the flag that indicates whether verification of the server's SSL certificate should be

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/authenticators/vpc_instance_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2021 IBM All Rights Reserved.
+# Copyright 2021, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,12 @@ from typing import Optional
 
 from requests import Request
 
+from ibm_cloud_sdk_core.logger import get_logger
 from ..token_managers.vpc_instance_token_manager import VPCInstanceTokenManager
 from .authenticator import Authenticator
 
+logger = get_logger()
+
 
 class VPCInstanceAuthenticator(Authenticator):
     """VPCInstanceAuthenticator implements an authentication scheme in which it
@@ -89,6 +92,7 @@ class VPCInstanceAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
 
     def set_iam_profile_crn(self, iam_profile_crn: str) -> None:
         """Sets CRN of the IAM profile.

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/base_service.py

@@ -16,9 +16,10 @@
 
 import gzip
 import io
-import json as json_import
 import logging
+import json as json_import
 from http.cookiejar import CookieJar
+from http import client
 from os.path import basename
 from typing import Dict, List, Optional, Tuple, Union
 from urllib3.util.retry import Retry
@@ -42,13 +43,12 @@ from .utils import (
     GzipStream,
 )
 from .private_helpers import _build_user_agent
+from .logger import (
+    get_logger,
+    LoggingFilter,
+)
 
-# Uncomment this to enable http debugging
-# import http.client as http_client
-# http_client.HTTPConnection.debuglevel = 1
-
-
-logger = logging.getLogger(__name__)
+logger = get_logger()
 
 
 # pylint: disable=too-many-instance-attributes
@@ -92,7 +92,7 @@ class BaseService:
         self,
         *,
         service_url: str = None,
-        authenticator: Authenticator = None,
+        authenticator: Optional[Authenticator] = None,
         disable_ssl_verification: bool = False,
         enable_gzip_compression: bool = False,
     ) -> None:
@@ -114,6 +114,12 @@ class BaseService:
 
         self.http_client.mount('http://', self.http_adapter)
         self.http_client.mount('https://', self.http_adapter)
+        # If debug logging is requested, then trigger HTTP message logging as well.
+        if logger.isEnabledFor(logging.DEBUG):
+            client.HTTPConnection.debuglevel = 1
+            # Replace the `print` function in the HTTPClient module to
+            # use the debug logger instead of the bare Python print.
+            client.print = lambda *args: logger.debug(LoggingFilter.filter_message(" ".join(args)))
 
     def enable_retries(self, max_retries: int = 4, retry_interval: float = 30.0) -> None:
         """Enable automatic retries on the underlying http client used by the BaseService instance.
@@ -141,6 +147,7 @@ class BaseService:
         )
         self.http_client.mount('http://', self.http_adapter)
         self.http_client.mount('https://', self.http_adapter)
+        logger.debug('Enabled retries; max_retries=%d, max_retry_interval=%f', max_retries, retry_interval)
 
     def disable_retries(self):
         """Remove retry config from http_adapter"""
@@ -148,6 +155,7 @@ class BaseService:
         self.http_adapter = SSLHTTPAdapter(_disable_ssl_verification=self.disable_ssl_verification)
         self.http_client.mount('http://', self.http_adapter)
         self.http_client.mount('https://', self.http_adapter)
+        logger.debug('Disabled retries')
 
     def configure_service(self, service_name: str) -> None:
         """Look for external configuration of a service. Set service properties.
@@ -166,6 +174,8 @@ class BaseService:
         if not isinstance(service_name, str):
             raise ValueError('Service_name must be of type string.')
 
+        logger.debug('Configuring BaseService instance with service name: %s', service_name)
+
         config = read_external_sources(service_name)
         if config.get('URL'):
             self.set_service_url(config.get('URL'))
@@ -184,6 +194,7 @@ class BaseService:
 
     def _set_user_agent_header(self, user_agent_string: str) -> None:
         self.user_agent_header = {'User-Agent': user_agent_string}
+        logger.debug('Set User-Agent: %s', user_agent_string)
 
     def set_http_config(self, http_config: dict) -> None:
         """Sets the http config dictionary.
@@ -225,6 +236,7 @@ class BaseService:
         )
         self.http_client.mount('http://', self.http_adapter)
         self.http_client.mount('https://', self.http_adapter)
+        logger.debug('Disabled SSL verification in HTTP client')
 
     def set_service_url(self, service_url: str) -> None:
         """Set the url the service will make HTTP requests too.
@@ -243,6 +255,7 @@ class BaseService:
         if service_url is not None:
             service_url = service_url.rstrip('/')
         self.service_url = service_url
+        logger.debug('Set service URL: %s', service_url)
 
     def get_http_client(self) -> requests.sessions.Session:
         """Get the http client session currently used by the service.
@@ -305,7 +318,7 @@ class BaseService:
         # Check to see if the caller specified the 'stream' argument.
         stream_response = kwargs.get('stream') or False
 
-        # Remove the keys we set manually, don't let the user to overwrite these.
+        # Remove the keys we set manually, don't let the user overwrite these.
         reserved_keys = ['method', 'url', 'headers', 'params', 'cookies']
         silent_keys = ['headers']
         for key in reserved_keys:
@@ -314,8 +327,12 @@ class BaseService:
                 if key not in silent_keys:
                     logger.warning('"%s" has been removed from the request', key)
         try:
+            logger.debug('Sending HTTP request message')
+
             response = self.http_client.request(**request, cookies=self.jar, **kwargs)
 
+            logger.debug('Received HTTP response message, status code %d', response.status_code)
+
             # Process a "success" response.
             if 200 <= response.status_code <= 299:
                 if response.status_code == 204 or request['method'] == 'HEAD':
@@ -455,6 +472,7 @@ class BaseService:
                         file_tuple = (filename, file_tuple[1], file_tuple[2])
                 new_files.append((part_name, file_tuple))
         request['files'] = new_files
+        logger.debug('Prepared request [%s %s]', request['method'], request['url'])
         return request
 
     @staticmethod

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.21.0}/ibm_cloud_sdk_core/get_authenticator.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,6 +26,9 @@ from .authenticators import (
     MCSPAuthenticator,
 )
 from .utils import read_external_sources
+from .logger import get_logger
+
+logger = get_logger()
 
 
 def get_authenticator_from_environment(service_name: str) -> Authenticator:
@@ -42,10 +45,13 @@ def get_authenticator_from_environment(service_name: str) -> Authenticator:
     Returns:
         The authenticator found from service information.
     """
+    logger.debug('Get authenticator from environment, key=%s', service_name)
     authenticator = None
     config = read_external_sources(service_name)
     if config:
         authenticator = __construct_authenticator(config)
+    if authenticator is not None:
+        logger.debug('Returning authenticator, type=%s', authenticator.authentication_type())
     return authenticator