# 0.1.2

* added `auto_read_body` to request and backends in order to automatically read response body so that all retry logic could happen in case of errors

Author: igorcoding

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.1.2
+* added `auto_read_body` to request and backends in order to automatically read response body so that all retry logic could happen in case of errors
+
 # 0.1.1
 * Response: added `original` proxy property
 

extapi/http/abc.py

@@ -45,6 +45,7 @@ async def get(
         data: Any = None,
         headers: CIMultiDict | Mapping[str, Any] | None = None,
         timeout: Any | float | None = None,
+        auto_read_body: bool | None = None,
         **kwargs,
     ) -> Response[T_co]:
         return await self.execute(
@@ -56,6 +57,7 @@ async def get(
                 data=data,
                 headers=_map_headers(headers),
                 timeout=timeout,
+                auto_read_body=auto_read_body,
                 kwargs=kwargs,
             )
         )
@@ -69,6 +71,7 @@ async def post(
         data: Any = None,
         headers: CIMultiDict | Mapping[str, Any] | None = None,
         timeout: Any | float | None = None,
+        auto_read_body: bool | None = None,
         **kwargs,
     ) -> Response[T_co]:
         return await self.execute(
@@ -80,6 +83,7 @@ async def post(
                 data=data,
                 headers=_map_headers(headers),
                 timeout=timeout,
+                auto_read_body=auto_read_body,
                 kwargs=kwargs,
             )
         )
@@ -93,6 +97,7 @@ async def delete(
         data: Any = None,
         headers: CIMultiDict | Mapping[str, Any] | None = None,
         timeout: Any | float | None = None,
+        auto_read_body: bool | None = None,
         **kwargs,
     ) -> Response[T_co]:
         return await self.execute(
@@ -104,6 +109,7 @@ async def delete(
                 data=data,
                 headers=_map_headers(headers),
                 timeout=timeout,
+                auto_read_body=auto_read_body,
                 kwargs=kwargs,
             )
         )
@@ -117,6 +123,7 @@ async def put(
         data: Any = None,
         headers: CIMultiDict | Mapping[str, Any] | None = None,
         timeout: Any | float | None = None,
+        auto_read_body: bool | None = None,
         **kwargs,
     ) -> Response[T_co]:
         return await self.execute(
@@ -128,6 +135,7 @@ async def put(
                 data=data,
                 headers=_map_headers(headers),
                 timeout=timeout,
+                auto_read_body=auto_read_body,
                 kwargs=kwargs,
             )
         )
@@ -141,6 +149,7 @@ async def patch(
         data: Any = None,
         headers: CIMultiDict | Mapping[str, Any] | None = None,
         timeout: Any | float | None = None,
+        auto_read_body: bool | None = None,
         **kwargs,
     ) -> Response[T_co]:
         return await self.execute(
@@ -152,6 +161,7 @@ async def patch(
                 data=data,
                 headers=_map_headers(headers),
                 timeout=timeout,
+                auto_read_body=auto_read_body,
                 kwargs=kwargs,
             )
         )

extapi/http/backends/aiohttp.py

@@ -15,8 +15,9 @@
 class AiohttpResponseWrap(BackendResponseProtocol[aiohttp.ClientResponse]):
     __slots__ = ("_original",)
 
-    def __init__(self, response: aiohttp.ClientResponse):
+    def __init__(self, response: aiohttp.ClientResponse, *, body: bytes | None = None):
         self._original = response
+        self._body = body
 
     def original(self) -> aiohttp.ClientResponse:
         return self._original
@@ -26,6 +27,10 @@ async def close(self) -> None:
         await self._original.wait_for_close()
 
     async def read(self) -> bytes:
+        if self._body is not None:
+            return self._body
+
+        # if body is not supplied - delegate to original
         return await self._original.read()
 
     async def json(
@@ -34,6 +39,14 @@ async def json(
         encoding: str | None,
         loads: Callable[[str], Any] = DEFAULT_JSON_DECODER,
     ) -> Any:
+        if self._body is not None:
+            if encoding is None:
+                s = self._body.decode()
+            else:
+                s = self._body.decode(encoding=encoding)
+            return loads(s)
+
+        # if body is not supplied - delegate to original
         return await self._original.json(encoding=encoding, loads=loads)
 
 
@@ -67,12 +80,18 @@ class AiohttpExecutor(AbstractExecutor[aiohttp.ClientResponse]):
     )
 
     def __init__(
-        self, *args, ssl: bool | Any = True, default_timeout: float = 10.0, **kwargs
+        self,
+        *args,
+        ssl: bool | Any = True,
+        default_timeout: float = 10.0,
+        auto_read_body: bool = True,
+        **kwargs,
     ):
         super().__init__()
         self._ssl = ssl
         self._session = self._make_session(*args, **kwargs)
         self._default_timeout = default_timeout
+        self._auto_read_body = auto_read_body
 
     def _make_session(self, *args, **kwargs) -> aiohttp.ClientSession:
         return aiohttp.ClientSession(*args, **kwargs)
@@ -82,6 +101,11 @@ async def close(self):
 
     async def execute(self, request: RequestData) -> Response[aiohttp.ClientResponse]:
         timeout = request.timeout or self._default_timeout
+        auto_read_body = (
+            request.auto_read_body
+            if request.auto_read_body is not None
+            else self._auto_read_body
+        )
 
         # aiohttp-specific kwargs
         # we need to pull them individually because
@@ -104,10 +128,14 @@ async def execute(self, request: RequestData) -> Response[aiohttp.ClientResponse
             **aiohttp_kwargs,
         )
 
+        body: bytes | None = None
+        if auto_read_body:
+            body = await response.read()
+
         return Response[aiohttp.ClientResponse](
             method=request.method,
             url=request.url,
             status=response.status,
             headers=response.headers.copy(),
-            backend_response=AiohttpResponseWrap(response),
+            backend_response=AiohttpResponseWrap(response, body=body),
         )

extapi/http/backends/httpx.py

@@ -14,8 +14,9 @@
 class HttpxResponseWrap(BackendResponseProtocol[httpx.Response]):
     __slots__ = ("_original",)
 
-    def __init__(self, response: httpx.Response):
+    def __init__(self, response: httpx.Response, *, body: bytes | None = None):
         self._original = response
+        self._body = body
 
     def original(self) -> httpx.Response:
         return self._original
@@ -24,6 +25,10 @@ async def close(self) -> None:
         return await self._original.aclose()
 
     async def read(self) -> bytes:
+        if self._body is not None:
+            return self._body
+
+        # if body is not supplied - delegate to original
         return await self._original.aread()
 
 
@@ -49,6 +54,7 @@ def __init__(
         ssl: bool = True,
         default_timeout: float = 10.0,
         follow_redirects: bool = True,
+        auto_read_body: bool = True,
         **kwargs,
     ):
         super().__init__()
@@ -59,6 +65,7 @@ def __init__(
             verify=verify, follow_redirects=follow_redirects, **kwargs
         )
         self._default_timeout = default_timeout
+        self._auto_read_body = auto_read_body
 
     def _make_client(self, *args, **kwargs) -> httpx.AsyncClient:
         return httpx.AsyncClient(*args, **kwargs)
@@ -68,6 +75,12 @@ async def close(self):
 
     async def execute(self, request: RequestData) -> Response[httpx.Response]:
         timeout = request.timeout or self._default_timeout
+        auto_read_body = (
+            request.auto_read_body
+            if request.auto_read_body is not None
+            else self._auto_read_body
+        )
+
         url = str(request.url)
 
         if request.headers is None:
@@ -95,10 +108,14 @@ async def execute(self, request: RequestData) -> Response[httpx.Response]:
             **httpx_kwargs,
         ).__aenter__()
 
+        body: bytes | None = None
+        if auto_read_body:
+            body = await response.aread()
+
         return Response[httpx.Response](
             method=request.method,
             url=request.url,
             status=response.status_code,
             headers=CIMultiDict(response.headers),
-            backend_response=HttpxResponseWrap(response),
+            backend_response=HttpxResponseWrap(response, body=body),
         )

extapi/http/types.py

@@ -29,6 +29,7 @@ class RequestData:
     data: Any = None
     headers: CIMultiDict | None = None
     timeout: Any | float | None = None
+    auto_read_body: bool | None = None
     kwargs: dict[str, Any] = field(default_factory=dict)
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "extapi"
-version = "0.1.1"
+version = "0.1.2"
 description = "External API library"
 authors = [
     { name = "KTS", email = "hello@kts.tech" }

tests/exthttp/backends/test_aiohttp.py

@@ -44,18 +44,46 @@ async def test_read(self, dummy_server: TestServer):
             request = RequestData(
                 method="GET",
                 url=URL(f"http://localhost:{dummy_server.port}/get"),
+                auto_read_body=False,
             )
 
             response = await executor.execute(request)
             async with response:
                 res = await response.read()
                 assert res == b'{"status": "ok"}'
 
+    async def test_read_supplied(self, dummy_server: TestServer):
+        async with AiohttpExecutor() as executor:
+            request = RequestData(
+                method="GET",
+                url=URL(f"http://localhost:{dummy_server.port}/get"),
+                auto_read_body=True,
+            )
+
+            response = await executor.execute(request)
+            async with response:
+                res = await response.read()
+                assert res == b'{"status": "ok"}'
+
+    async def test_json_supplied(self, dummy_server: TestServer):
+        async with AiohttpExecutor() as executor:
+            request = RequestData(
+                method="GET",
+                url=URL(f"http://localhost:{dummy_server.port}/get"),
+                auto_read_body=True,
+            )
+
+            response = await executor.execute(request)
+            async with response:
+                res = await response.json()
+                assert res == {"status": "ok"}
+
     async def test_json(self, dummy_server: TestServer):
         async with AiohttpExecutor() as executor:
             request = RequestData(
                 method="GET",
                 url=URL(f"http://localhost:{dummy_server.port}/get"),
+                auto_read_body=False,
             )
 
             response = await executor.execute(request)