Release 2.13.1

Author: avinash1IBM

CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 2.13.1
+
+### Content
+
+#### Defect Fixes
+
+* IBM Python SDK aligned with AWS Python SDK - Boto3(v1.26.64), Botocore(v1.29.65) and S3transfer(v0.6.0)
+* Update dependencies
+
 ## 2.13.0
 
 ### Content

README.md

@@ -27,7 +27,7 @@ You\'ll need:
 * Token acquisition endpoint.
 * Service endpoint.
 
-These values can be found in the IBM Cloud Console by [generating a \'service credential\'](https://cloud.ibm.com/docs/services/cloud-object-storage/iam/service-credentials.html).
+These values can be found in the IBM Cloud Console by [generating a \'service credential\'](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-service-credentials).
 
 ## Using Python
 

ibm_boto3/__init__.py

@@ -19,7 +19,7 @@
 
 
 __author__ = 'IBM'
-__version__ = '2.13.0'
+__version__ = '2.13.1'
 
 
 # The default Boto3 session; autoloaded when needed.

ibm_boto3/compat.py

@@ -16,22 +16,15 @@
 import socket
 import warnings
 
-from ibm_botocore.vendored import six
 from ibm_boto3.exceptions import PythonDeprecationWarning
 
-if six.PY3:
-    # In python3, socket.error is OSError, which is too general
-    # for what we want (i.e FileNotFoundError is a subclass of OSError).
-    # In py3 all the socket related errors are in a newly created
-    # ConnectionError
-    SOCKET_ERROR = ConnectionError
-else:
-    SOCKET_ERROR = socket.error
+# In python3, socket.error is OSError, which is too general
+# for what we want (i.e FileNotFoundError is a subclass of OSError).
+# In py3 all the socket related errors are in a newly created
+# ConnectionError
+SOCKET_ERROR = ConnectionError
 
-if six.PY3:
-    import collections.abc as collections_abc
-else:
-    import collections as collections_abc
+import collections.abc as collections_abc
 
 
 if sys.platform.startswith('win'):
@@ -64,18 +57,17 @@ def filter_python_deprecation_warnings():
 
 
 def _warn_deprecated_python():
-    """Python 2.7 is deprecated so this code will no longer run.
-
-    Use this template for future deprecation campaigns as needed.
-    """
-    py_27_params = {
-        'date': 'July 15, 2021',
-        'blog_link': 'https://aws.amazon.com/blogs/developer/announcing-end-'
-                     'of-support-for-python-2-7-in-aws-sdk-for-python-and-'
-                     'aws-cli-v1/'
+    """Use this template for future deprecation campaigns as needed."""
+    py_36_params = {
+        'date': 'May 30, 2022',
+        'blog_link': (
+            'https://aws.amazon.com/blogs/developer/'
+            'python-support-policy-updates-for-aws-sdks-and-tools/'
+        )
     }
     deprecated_versions = {
-        (2,7): py_27_params,
+        # Example template for future deprecations
+        # (3, 6): py_36_params,
     }
     py_version = sys.version_info[:2]
 
@@ -84,7 +76,7 @@ def _warn_deprecated_python():
         warning = (
             "Boto3 will no longer support Python {}.{} "
             "starting {}. To continue receiving service updates, "
-            "bug fixes, and security updates please upgrade to Python 3.6 or "
+            "bug fixes, and security updates please upgrade to Python 3.7 or "
             "later. More information can be found here: {}"
         ).format(py_version[0], py_version[1], params['date'], params['blog_link'])
         warnings.warn(warning, PythonDeprecationWarning)

ibm_boto3/s3/transfer.py

@@ -122,6 +122,8 @@ def __call__(self, bytes_amount):
 
 
 """
+from os import PathLike, fspath
+
 from ibm_botocore.exceptions import ClientError
 from ibm_s3transfer.exceptions import (
     RetriesExceededError as S3TransferRetriesExceededError,
@@ -210,7 +212,7 @@ def __init__(
 
         :param use_threads: If True, threads will be used when performing
             S3 transfers. If False, no threads will be used in
-            performing transfers: all logic will be ran in the main thread.
+            performing transfers; all logic will be run in the main thread.
 
         :param max_bandwidth: The maximum bandwidth that will be consumed
             in uploading and downloading file content. The value is an integer
@@ -277,8 +279,10 @@ def upload_file(
             :py:meth:`S3.Client.upload_file`
             :py:meth:`S3.Client.upload_fileobj`
         """
+        if isinstance(filename, PathLike):
+            filename = fspath(filename)
         if not isinstance(filename, str):
-            raise ValueError('Filename must be a string')
+            raise ValueError('Filename must be a string or a path-like object')
 
         subscribers = self._get_subscribers(callback)
         future = self._manager.upload(
@@ -309,8 +313,10 @@ def download_file(
             :py:meth:`S3.Client.download_file`
             :py:meth:`S3.Client.download_fileobj`
         """
+        if isinstance(filename, PathLike):
+            filename = fspath(filename)
         if not isinstance(filename, str):
-            raise ValueError('Filename must be a string')
+            raise ValueError('Filename must be a string or a path-like object')
 
         subscribers = self._get_subscribers(callback)
         future = self._manager.download(

requirements-dev.txt

@@ -2,7 +2,7 @@ wheel==0.40.0
 coverage==5.5
 
 # Pytest specific deps
-pytest==7.2.2
+pytest==7.3.1
 pytest-cov==2.12.1
 atomicwrites>=1.0 # Windows requirement
 colorama>0.3.0 # Windows requirement

requirements-docs.txt

@@ -3,6 +3,6 @@
 # removed python 3.5 support we need to add our own pins.
 markupsafe>=1.1,<2.0
 jinja2>=2.3,<3.0
-docutils>=0.10,<0.15
+docutils>=0.10,<0.17
 Sphinx>=1.1.3,<=1.6.7
 guzzle_sphinx_theme>=0.7.10,<0.8

setup.cfg

@@ -3,9 +3,9 @@ universal = 0
 
 [metadata]
 requires_dist =
-    ibm-cos-sdk-core==2.13.0
-    ibm-cos-sdk-s3transfer==2.13.0
-    jmespath>=0.7.1,<=1.0.1
+    ibm-cos-sdk-core==2.13.1
+    ibm-cos-sdk-s3transfer==2.13.1
+    jmespath>=0.10.0,<=1.0.1
 
 [flake8]
 ignore = E203,E501,W503,W504

setup.py

@@ -9,8 +9,8 @@
 
 
 requires = [
-    'ibm-cos-sdk-core==2.13.0',
-    'ibm-cos-sdk-s3transfer==2.13.0',
+    'ibm-cos-sdk-core==2.13.1',
+    'ibm-cos-sdk-s3transfer==2.13.1',
     'jmespath>=0.10.0,<=1.0.1'
 ]
 

tests/functional/test_s3.py

@@ -10,10 +10,11 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
+import io
+
 import ibm_botocore
 import ibm_botocore.stub
 import pytest
-from ibm_botocore.compat import six
 from ibm_botocore.config import Config
 from ibm_botocore.stub import Stubber
 
@@ -244,7 +245,7 @@ def progress_callback(amount):
 class TestUploadFileobj(BaseTransferTest):
     def setUp(self):
         super().setUp()
-        self.contents = six.BytesIO(b'foo\n')
+        self.contents = io.BytesIO(b'foo\n')
 
     def stub_put_object(self):
         put_object_response = {
@@ -330,7 +331,7 @@ def test_object_upload(self):
 
     def test_multipart_upload(self):
         chunksize = 8 * (1024**2)
-        contents = six.BytesIO(b'0' * (chunksize * 3))
+        contents = io.BytesIO(b'0' * (chunksize * 3))
         self.stub_multipart_upload(num_parts=3)
         transfer_config = TransferConfig(
             multipart_chunksize=chunksize,
@@ -354,7 +355,7 @@ class TestDownloadFileobj(BaseTransferTest):
     def setUp(self):
         super().setUp()
         self.contents = b'foo'
-        self.fileobj = six.BytesIO()
+        self.fileobj = io.BytesIO()
 
     def stub_single_part_download(self):
         self.stub_head(content_length=len(self.contents))
@@ -400,7 +401,7 @@ def stub_get_object(self, full_contents, start_byte=0, end_byte=None):
                 "ETag": self.etag,
                 "ContentLength": len(contents),
                 "ContentType": "binary/octet-stream",
-                "Body": six.BytesIO(contents),
+                "Body": io.BytesIO(contents),
                 "ResponseMetadata": {"HTTPStatusCode": 200},
             }
         )

tests/integration/test_s3.py

@@ -12,22 +12,22 @@
 # language governing permissions and limitations under the License.
 import datetime
 import hashlib
+import io
 import logging
 import math
 import os
 import shutil
 import string
 import tempfile
 import threading
+from pathlib import Path
 
 from ibm_botocore.client import Config
-from ibm_botocore.compat import six
 
 import ibm_boto3.s3.transfer
 import ibm_boto3.session
 from tests import unique_id, unittest
 
-urlopen = six.moves.urllib.request.urlopen
 LOG = logging.getLogger('ibm_boto3.tests.integration')
 
 
@@ -338,7 +338,7 @@ def test_copy(self):
         self.object_exists('bar')
 
     def test_upload_fileobj(self):
-        fileobj = six.BytesIO(b'foo')
+        fileobj = io.BytesIO(b'foo')
         self.client.upload_fileobj(
             Fileobj=fileobj, Bucket=self.bucket_name, Key='foo'
         )
@@ -356,7 +356,7 @@ def test_upload_fileobj_progress(self):
             multipart_threshold=chunksize,
             max_concurrency=1,
         )
-        fileobj = six.BytesIO(b'0' * (chunksize * 3))
+        fileobj = io.BytesIO(b'0' * (chunksize * 3))
 
         def progress_callback(amount):
             self.progress += amount
@@ -374,7 +374,7 @@ def progress_callback(amount):
         self.assertEqual(self.progress, chunksize * 3)
 
     def test_download_fileobj(self):
-        fileobj = six.BytesIO()
+        fileobj = io.BytesIO()
         self.client.put_object(
             Bucket=self.bucket_name, Key='foo', Body=b'beach'
         )
@@ -387,6 +387,13 @@ def test_download_fileobj(self):
 
         self.assertEqual(fileobj.getvalue(), b'beach')
 
+    def test_upload_via_path(self):
+        transfer = self.create_s3_transfer()
+        filename = self.files.create_file_with_size('path.txt', filesize=1024)
+        transfer.upload_file(Path(filename), self.bucket_name, 'path.txt')
+        self.addCleanup(self.delete_object, 'path.txt')
+        self.assertTrue(self.object_exists('path.txt'))
+
     def test_upload_below_threshold(self):
         config = ibm_boto3.s3.transfer.TransferConfig(
             multipart_threshold=2 * 1024 * 1024
@@ -397,7 +404,6 @@ def test_upload_below_threshold(self):
         )
         transfer.upload_file(filename, self.bucket_name, 'foo.txt')
         self.addCleanup(self.delete_object, 'foo.txt')
-
         self.assertTrue(self.object_exists('foo.txt'))
 
     def test_upload_above_threshold(self):
@@ -692,7 +698,7 @@ def test_transfer_methods_do_not_use_threads(self):
         self.addCleanup(self.delete_object, key)
         self.assertTrue(self.object_exists(key))
 
-        fileobj = six.BytesIO()
+        fileobj = io.BytesIO()
         self.client.download_fileobj(
             Bucket=self.bucket_name, Key='foo', Fileobj=fileobj, Config=config
         )