Reverting a potential breaking change

Author: leandrodamascena

Diff for: aws_lambda_powertools/utilities/streaming/_s3_seekable_io.py

@@ -14,9 +14,9 @@
 )
 
 import boto3
-from botocore.response import StreamingBody
 
 from aws_lambda_powertools.shared import user_agent
+from aws_lambda_powertools.utilities.streaming.compat import PowertoolsStreamingBody
 
 if TYPE_CHECKING:
     from mmap import mmap
@@ -68,7 +68,7 @@ def __init__(
         self._size: Optional[int] = None
 
         self._s3_client: Optional["Client"] = boto3_client
-        self._raw_stream: Optional[StreamingBody] = None
+        self._raw_stream: Optional[PowertoolsStreamingBody] = None
 
         self._sdk_options = sdk_options
         self._sdk_options["Bucket"] = bucket
@@ -100,7 +100,7 @@ def size(self) -> int:
         return self._size
 
     @property
-    def raw_stream(self) -> StreamingBody:
+    def raw_stream(self) -> PowertoolsStreamingBody:
         """
         Returns the boto3 StreamingBody, starting the stream from the seeked position.
         """
@@ -110,7 +110,7 @@ def raw_stream(self) -> StreamingBody:
             self._raw_stream = self.s3_client.get_object(Range=range_header, **self._sdk_options).get("Body")
             self._closed = False
 
-        return cast(StreamingBody, self._raw_stream)
+        return cast(PowertoolsStreamingBody, self._raw_stream)
 
     def seek(self, offset: int, whence: int = io.SEEK_SET) -> int:
         """

Diff for: aws_lambda_powertools/utilities/streaming/compat.py

@@ -0,0 +1,3 @@
+from botocore.response import StreamingBody
+
+PowertoolsStreamingBody = StreamingBody

Diff for: examples/streaming/src/assert_transformation.py

@@ -3,9 +3,9 @@
 import boto3
 from assert_transformation_module import UpperTransform
 from botocore import stub
-from botocore.response import StreamingBody
 
 from aws_lambda_powertools.utilities.streaming import S3Object
+from aws_lambda_powertools.utilities.streaming.compat import PowertoolsStreamingBody
 
 
 def test_upper_transform():
@@ -24,7 +24,7 @@ def test_s3_object_with_upper_transform():
     s3_stub = stub.Stubber(s3_client)
     s3_stub.add_response(
         "get_object",
-        {"Body": StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))},
+        {"Body": PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))},
     )
     s3_stub.activate()
 

Diff for: tests/functional/streaming/test_s3_seekable_io.py

@@ -3,9 +3,9 @@
 import boto3
 import pytest
 from botocore import stub
-from botocore.response import StreamingBody
 
 from aws_lambda_powertools.utilities.streaming._s3_seekable_io import _S3SeekableIO
+from aws_lambda_powertools.utilities.streaming.compat import PowertoolsStreamingBody
 
 
 @pytest.fixture
@@ -89,7 +89,7 @@ def test_raw_stream_fetches_with_range_header_after_seek(s3_seekable_obj, s3_cli
 
 def test_read(s3_seekable_obj, s3_client_stub):
     payload = b"hello world"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",
@@ -105,7 +105,7 @@ def test_read(s3_seekable_obj, s3_client_stub):
 
 def test_readline(s3_seekable_obj, s3_client_stub):
     payload = b"hello world\nworld hello"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",
@@ -120,7 +120,7 @@ def test_readline(s3_seekable_obj, s3_client_stub):
 
 def test_readlines(s3_seekable_obj, s3_client_stub):
     payload = b"hello world\nworld hello"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",
@@ -134,7 +134,7 @@ def test_readlines(s3_seekable_obj, s3_client_stub):
 
 def test_closed(s3_seekable_obj, s3_client_stub):
     payload = b"test"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",
@@ -148,7 +148,7 @@ def test_closed(s3_seekable_obj, s3_client_stub):
 
 def test_next(s3_seekable_obj, s3_client_stub):
     payload = b"test"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",
@@ -163,7 +163,7 @@ def test_next(s3_seekable_obj, s3_client_stub):
 
 def test_context_manager(s3_seekable_obj, s3_client_stub):
     payload = b"test"
-    streaming_body = StreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
+    streaming_body = PowertoolsStreamingBody(raw_stream=io.BytesIO(payload), content_length=len(payload))
 
     s3_client_stub.add_response(
         "get_object",