ibm-cloud-sdk-core 3.18.1__tar.gz → 3.19.0__tar.gz

{ibm-cloud-sdk-core-3.18.1/ibm_cloud_sdk_core.egg-info → ibm-cloud-sdk-core-3.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.18.1
+Version: 3.19.0
 Summary: Core library used by SDKs for IBM Cloud Services
 Home-page: https://github.com/IBM/python-sdk-core
 Author: IBM
@@ -29,7 +29,7 @@ License-File: LICENSE
 [![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.18.1
+# IBM Python SDK Core Version 3.19.0
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/README.md

@@ -4,7 +4,7 @@
 [![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.18.1
+# IBM Python SDK Core Version 3.19.0
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/ibm_cloud_sdk_core/api_exception.py

@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import warnings
 from http import HTTPStatus
 from typing import Optional
 
@@ -39,15 +40,28 @@ class ApiException(Exception):
         # Call the base class constructor with the parameters it needs
         super().__init__(message)
         self.message = message
-        self.code = code
+        self.status_code = code
         self.http_response = http_response
         self.global_transaction_id = None
         if http_response is not None:
             self.global_transaction_id = http_response.headers.get('X-Global-Transaction-ID')
             self.message = self.message if self.message else self._get_error_message(http_response)
 
+    # pylint: disable=fixme
+    # TODO: delete this by the end of 2024.
+    @property
+    def code(self):
+        """The old `code` property with a deprecation warning."""
+
+        warnings.warn(
+            'Using the `code` attribute on the `ApiException` is deprecated and'
+            'will be removed in the future. Use `status_code` instead.',
+            DeprecationWarning,
+        )
+        return self.status_code
+
     def __str__(self) -> str:
-        msg = 'Error: ' + str(self.message) + ', Code: ' + str(self.code)
+        msg = 'Error: ' + str(self.message) + ', Status code: ' + str(self.status_code)
         if self.global_transaction_id is not None:
             msg += ' , X-global-transaction-id: ' + str(self.global_transaction_id)
         return msg

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/ibm_cloud_sdk_core/base_service.py

@@ -117,20 +117,21 @@ class BaseService:
         self.http_client.mount('http://', self.http_adapter)
         self.http_client.mount('https://', self.http_adapter)
 
-    def enable_retries(self, max_retries: int = 4, retry_interval: float = 1.0) -> None:
+    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.
 
         Args:
           max_retries: the maximum number of retries to attempt for a failed retryable request
-          retry_interval: the default wait time (in seconds) to use for the first retry attempt.
+          retry_interval: the maximum wait time (in seconds) to use for retry attempts.
             In general, if a response includes the Retry-After header, that will be used for
             the wait time associated with the retry attempt.  If the Retry-After header is not
-            present, then the wait time is based on the retry_interval and retry attempt number:
-               wait_time = retry_interval * (2 ^ (n-1)), where n is the retry attempt number
+            present, then the wait time is based on an exponential backoff policy with a maximum
+            backoff time of "retry_interval".
         """
         self.retry_config = Retry(
             total=max_retries,
-            backoff_factor=retry_interval,
+            backoff_factor=1.0,
+            backoff_max=retry_interval,
             # List of HTTP status codes to retry on in addition to Timeout/Connection Errors
             status_forcelist=[429, 500, 502, 503, 504],
             # List of HTTP methods to retry on

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/ibm_cloud_sdk_core/detailed_response.py

@@ -65,7 +65,7 @@ class DetailedResponse:
         """
         return self.headers
 
-    def get_status_code(self) -> int:
+    def get_status_code(self) -> Union[int, None]:
         """The HTTP status code of the service request.
 
         Returns:

ibm-cloud-sdk-core-3.19.0/ibm_cloud_sdk_core/version.py

@@ -0,0 +1 @@
+__version__ = '3.19.0'

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0/ibm_cloud_sdk_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.18.1
+Version: 3.19.0
 Summary: Core library used by SDKs for IBM Cloud Services
 Home-page: https://github.com/IBM/python-sdk-core
 Author: IBM
@@ -29,7 +29,7 @@ License-File: LICENSE
 [![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.18.1
+# IBM Python SDK Core Version 3.19.0
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/setup.py

@@ -19,7 +19,7 @@ import pkg_resources
 from setuptools import setup, find_packages
 from setuptools.command.test import test as TestCommand
 
-__version__ = '3.18.1'
+__version__ = '3.19.0'
 
 if sys.argv[-1] == 'publish':
     # test server

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/test/test_api_exception.py

@@ -85,4 +85,4 @@ def test_api_exception():
     mock_response = requests.get('https://test-for-text.com', timeout=None)
     exception = ApiException(500, http_response=mock_response)
     assert exception.message == 'plain text error'
-    assert str(exception) == 'Error: plain text error, Code: 500 , X-global-transaction-id: xx'
+    assert str(exception) == 'Error: plain text error, Status code: 500 , X-global-transaction-id: xx'

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/test/test_base_service.py

@@ -1,5 +1,5 @@
 # coding=utf-8
-# pylint: disable=missing-docstring,protected-access,too-few-public-methods
+# pylint: disable=missing-docstring,protected-access,too-few-public-methods,too-many-lines
 import gzip
 import json
 import os
@@ -357,6 +357,7 @@ def test_request_server_error():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 500
+    assert err.value.status_code == 500
     assert err.value.http_response.headers['Content-Type'] == 'application/json'
     assert err.value.message == 'internal server error'
 
@@ -399,6 +400,7 @@ def test_request_success_invalid_json():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 200
+    assert err.value.status_code == 200
     assert err.value.http_response.headers['Content-Type'] == 'application/json; charset=utf8'
     assert isinstance(err.value.__cause__, requests.exceptions.JSONDecodeError)
     assert "Expecting ':' delimiter: line 1" in str(err.value.__cause__)
@@ -453,6 +455,7 @@ def test_request_fail_401_nonerror_json():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 401
+    assert err.value.status_code == 401
     assert err.value.http_response.headers['Content-Type'] == 'application/json'
     assert err.value.message == error_msg
 
@@ -473,6 +476,7 @@ def test_request_fail_401_error_json():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 401
+    assert err.value.status_code == 401
     assert err.value.http_response.headers['Content-Type'] == 'application/json'
     assert err.value.message == error_msg
 
@@ -492,6 +496,7 @@ def test_request_fail_401_nonjson():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 401
+    assert err.value.status_code == 401
     assert err.value.http_response.headers['Content-Type'] == 'text/plain'
     assert err.value.message == response_body
 
@@ -514,6 +519,7 @@ def test_request_fail_401_badjson():
         prepped = service.prepare_request('GET', url='')
         service.send(prepped)
     assert err.value.code == 401
+    assert err.value.status_code == 401
     assert err.value.http_response.headers['Content-Type'] == 'application/json'
     assert err.value.message == response_body
 
@@ -724,6 +730,7 @@ def test_retry_config_default():
     service.enable_retries()
     assert service.retry_config.total == 4
     assert service.retry_config.backoff_factor == 1.0
+    assert service.retry_config.backoff_max == 30.0
     assert service.http_client.get_adapter('https://').max_retries.total == 4
 
     # Ensure retries fail after 4 retries
@@ -756,9 +763,10 @@ def test_retry_config_disable():
 
 def test_retry_config_non_default():
     service = BaseService(service_url='https://mockurl/', authenticator=NoAuthAuthenticator())
-    service.enable_retries(2, 0.3)
+    service.enable_retries(2, 10.0)
     assert service.retry_config.total == 2
-    assert service.retry_config.backoff_factor == 0.3
+    assert service.retry_config.backoff_factor == 1.0
+    assert service.retry_config.backoff_max == 10.0
 
     # Ensure retries fail after 2 retries
     error = ConnectTimeoutError()
@@ -775,7 +783,8 @@ def test_retry_config_external():
     os.environ['IBM_CREDENTIALS_FILE'] = file_path
     service = IncludeExternalConfigService('v1', authenticator=NoAuthAuthenticator())
     assert service.retry_config.total == 3
-    assert service.retry_config.backoff_factor == 0.2
+    assert service.retry_config.backoff_factor == 1.0
+    assert service.retry_config.backoff_max == 25.0
 
     # Ensure retries fail after 3 retries
     error = ConnectTimeoutError()

{ibm-cloud-sdk-core-3.18.1 → ibm-cloud-sdk-core-3.19.0}/test/test_container_token_manager.py

@@ -251,7 +251,7 @@ def test_authenticate_fail_iam():
     with pytest.raises(ApiException) as err:
         authenticator.authenticate(request)
 
-    assert str(err.value) == 'Error: Bad Request, Code: 400'
+    assert str(err.value) == 'Error: Bad Request, Status code: 400'
 
 
 @mock_iam_response

ibm-cloud-sdk-core-3.18.1/ibm_cloud_sdk_core/version.py

@@ -1 +0,0 @@
-__version__ = '3.18.1'