[rest] add kwargs to iter_bytes and iter_raw (Azure#21529)

Author: iscai-msft

sdk/core/azure-core/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- add kwargs to the methods for `iter_raw` and `iter_bytes`  #21529
+
 ### Breaking Changes
 
 - SansIOHTTPPolicy.on_exception returns None instead of bool.

sdk/core/azure-core/azure/core/rest/_http_response_impl.py

@@ -392,8 +392,8 @@ def read(self):
         self._set_read_checks()
         return self.content
 
-    def iter_bytes(self):
-        # type: () -> Iterator[bytes]
+    def iter_bytes(self, **kwargs):
+        # type: (Any) -> Iterator[bytes]
         """Iterates over the response's bytes. Will decompress in the process.
 
         :return: An iterator of bytes from the response
@@ -413,8 +413,8 @@ def iter_bytes(self):
                 yield part
         self.close()
 
-    def iter_raw(self):
-        # type: () -> Iterator[bytes]
+    def iter_raw(self, **kwargs):
+        # type: (Any) -> Iterator[bytes]
         """Iterates over the response's bytes. Will not decompress in the process.
 
         :return: An iterator of bytes from the response
@@ -453,10 +453,10 @@ class RestHttpClientTransportResponse(_RestHttpClientTransportResponseBase, Http
     """Create a Rest HTTPResponse from an http.client response.
     """
 
-    def iter_bytes(self):
+    def iter_bytes(self, **kwargs):
         raise TypeError("We do not support iter_bytes for this transport response")
 
-    def iter_raw(self):
+    def iter_raw(self, **kwargs):
         raise TypeError("We do not support iter_raw for this transport response")
 
     def read(self):

sdk/core/azure-core/azure/core/rest/_http_response_impl_async.py

@@ -23,7 +23,7 @@
 # IN THE SOFTWARE.
 #
 # --------------------------------------------------------------------------
-from typing import AsyncIterator
+from typing import Any, AsyncIterator
 from ._rest_py3 import AsyncHttpResponse as _AsyncHttpResponse
 from ._http_response_impl import (
     _HttpResponseBaseImpl, _HttpResponseBackcompatMixinBase, _RestHttpClientTransportResponseBase
@@ -90,7 +90,7 @@ async def read(self) -> bytes:
         await self._set_read_checks()
         return self._content
 
-    async def iter_raw(self) -> AsyncIterator[bytes]:
+    async def iter_raw(self, **kwargs: Any) -> AsyncIterator[bytes]:
         """Asynchronously iterates over the response's bytes. Will not decompress in the process
         :return: An async iterator of bytes from the response
         :rtype: AsyncIterator[bytes]
@@ -102,7 +102,7 @@ async def iter_raw(self) -> AsyncIterator[bytes]:
             yield part
         await self.close()
 
-    async def iter_bytes(self) -> AsyncIterator[bytes]:
+    async def iter_bytes(self, **kwargs: Any) -> AsyncIterator[bytes]:
         """Asynchronously iterates over the response's bytes. Will decompress in the process
         :return: An async iterator of bytes from the response
         :rtype: AsyncIterator[bytes]
@@ -145,10 +145,10 @@ class RestAsyncHttpClientTransportResponse(_RestHttpClientTransportResponseBase,
     """Create a Rest HTTPResponse from an http.client response.
     """
 
-    async def iter_bytes(self):
+    async def iter_bytes(self, **kwargs):
         raise TypeError("We do not support iter_bytes for this transport response")
 
-    async def iter_raw(self):
+    async def iter_raw(self, **kwargs):
         raise TypeError("We do not support iter_raw for this transport response")
 
     async def read(self):

sdk/core/azure-core/azure/core/rest/_rest.py

@@ -361,17 +361,17 @@ def read(self):
         """
 
     @abc.abstractmethod
-    def iter_raw(self):
-        # type: () -> Iterator[bytes]
+    def iter_raw(self, **kwargs):
+        # type: (Any) -> Iterator[bytes]
         """Iterates over the response's bytes. Will not decompress in the process.
 
         :return: An iterator of bytes from the response
         :rtype: Iterator[str]
         """
 
     @abc.abstractmethod
-    def iter_bytes(self):
-        # type: () -> Iterator[bytes]
+    def iter_bytes(self, **kwargs):
+        # type: (Any) -> Iterator[bytes]
         """Iterates over the response's bytes. Will decompress in the process.
 
         :return: An iterator of bytes from the response

sdk/core/azure-core/azure/core/rest/_rest_py3.py

@@ -352,7 +352,7 @@ def read(self) -> bytes:
         ...
 
     @abc.abstractmethod
-    def iter_raw(self) -> Iterator[bytes]:
+    def iter_raw(self, **kwargs: Any) -> Iterator[bytes]:
         """Iterates over the response's bytes. Will not decompress in the process.
 
         :return: An iterator of bytes from the response
@@ -361,7 +361,7 @@ def iter_raw(self) -> Iterator[bytes]:
         ...
 
     @abc.abstractmethod
-    def iter_bytes(self) -> Iterator[bytes]:
+    def iter_bytes(self, **kwargs: Any) -> Iterator[bytes]:
         """Iterates over the response's bytes. Will decompress in the process.
 
         :return: An iterator of bytes from the response
@@ -403,7 +403,7 @@ async def read(self) -> bytes:
         ...
 
     @abc.abstractmethod
-    async def iter_raw(self) -> AsyncIterator[bytes]:
+    async def iter_raw(self, **kwargs: Any) -> AsyncIterator[bytes]:
         """Asynchronously iterates over the response's bytes. Will not decompress in the process.
 
         :return: An async iterator of bytes from the response
@@ -414,7 +414,7 @@ async def iter_raw(self) -> AsyncIterator[bytes]:
         yield  # pylint: disable=unreachable
 
     @abc.abstractmethod
-    async def iter_bytes(self) -> AsyncIterator[bytes]:
+    async def iter_bytes(self, **kwargs: Any) -> AsyncIterator[bytes]:
         """Asynchronously iterates over the response's bytes. Will decompress in the process.
 
         :return: An async iterator of bytes from the response

sdk/core/azure-core/tests/async_tests/test_rest_stream_responses_async.py

@@ -203,3 +203,17 @@ async def test_error_reading(client):
     await response.read()
     assert response.content == b""
     await client.close()
+
+@pytest.mark.asyncio
+async def test_pass_kwarg_to_iter_bytes(client):
+    request = HttpRequest("GET", "/basic/string")
+    response = await client.send_request(request, stream=True)
+    async for part in response.iter_bytes(chunk_size=5):
+        assert part
+
+@pytest.mark.asyncio
+async def test_pass_kwarg_to_iter_raw(client):
+    request = HttpRequest("GET", "/basic/string")
+    response = await client.send_request(request, stream=True)
+    async for part in response.iter_raw(chunk_size=5):
+        assert part

sdk/core/azure-core/tests/test_rest_stream_responses.py

@@ -229,3 +229,15 @@ def test_error_reading(client):
     response.read()
     assert response.content == b""
     # try giving a really slow response, see what happens
+
+def test_pass_kwarg_to_iter_bytes(client):
+    request = HttpRequest("GET", "/basic/string")
+    response = client.send_request(request, stream=True)
+    for part in response.iter_bytes(chunk_size=5):
+        assert part
+
+def test_pass_kwarg_to_iter_raw(client):
+    request = HttpRequest("GET", "/basic/string")
+    response = client.send_request(request, stream=True)
+    for part in response.iter_raw(chunk_size=5):
+        assert part