added json decoding to Response

Author: igorcoding

extapi/http/backends/aiohttp.py

@@ -1,9 +1,15 @@
+from collections.abc import Callable
 from typing import Any
 
 import aiohttp
 
 from extapi.http.abc import AbstractExecutor
-from extapi.http.types import BackendResponseProtocol, RequestData, Response
+from extapi.http.types import (
+    DEFAULT_JSON_DECODER,
+    BackendResponseProtocol,
+    RequestData,
+    Response,
+)
 
 
 class AiohttpResponseWrap(BackendResponseProtocol[aiohttp.ClientResponse]):
@@ -22,6 +28,14 @@ async def close(self) -> None:
     async def read(self) -> bytes:
         return await self._original.read()
 
+    async def json(
+        self,
+        *,
+        encoding: str | None,
+        loads: Callable[[str], Any] = DEFAULT_JSON_DECODER,
+    ) -> Any:
+        return await self._original.json(encoding=encoding, loads=loads)
+
 
 class AiohttpExecutor(AbstractExecutor[aiohttp.ClientResponse]):
     __slots__ = (

extapi/http/backends/httpx.py

@@ -5,7 +5,11 @@
 from yarl import URL
 
 from extapi.http.abc import AbstractExecutor
-from extapi.http.types import BackendResponseProtocol, RequestData, Response
+from extapi.http.types import (
+    BackendResponseProtocol,
+    RequestData,
+    Response,
+)
 
 
 class HttpxResponseWrap(BackendResponseProtocol[httpx.Response]):

extapi/http/types.py

@@ -1,6 +1,8 @@
+import json
 from dataclasses import dataclass, field
 from typing import (
     Any,
+    Callable,
     Generic,
     Literal,
     Protocol,
@@ -15,6 +17,8 @@
 HttpMethod = Literal["GET", "POST", "PUT", "PATCH", "DELETE"] | str
 StrOrURL = str | URL
 
+DEFAULT_JSON_DECODER = json.loads
+
 
 @dataclass(slots=True, kw_only=True)
 class RequestData:
@@ -34,9 +38,24 @@ class RequestData:
 @runtime_checkable
 class BackendResponseProtocol(Protocol[T]):
     def original(self) -> T: ...
+
     async def close(self) -> None: ...
+
     async def read(self) -> bytes: ...
 
+    async def json(
+        self,
+        *,
+        encoding: str | None,
+        loads: Callable[[str], Any] = DEFAULT_JSON_DECODER,
+    ) -> Any:
+        data = await self.read()
+        if encoding is None:
+            s = data.decode()
+        else:
+            s = data.decode(encoding=encoding)
+        return loads(s)
+
 
 @dataclass(kw_only=True)
 class Response(Generic[T]):
@@ -54,6 +73,14 @@ async def read(self) -> bytes:
         self._data = await self.backend_response.read()
         return self._data
 
+    async def json(
+        self,
+        *,
+        encoding: str | None = None,
+        loads: Callable[[str], Any] = DEFAULT_JSON_DECODER,
+    ) -> Any:
+        return await self.backend_response.json(encoding=encoding, loads=loads)
+
     async def __aenter__(self) -> Self:
         return self
 

tests/exthttp/executors/test_retry.py

@@ -266,3 +266,16 @@ async def process_error(
 
         assert response.status == 200
         assert base.call_count == 2
+
+    async def test_default_addons(self, request_simple: RequestData):
+        base = _DummyExecutor(responses=[500, 429, 200])
+        executor = RetryableExecutor(
+            base,
+            max_retries=3,
+            retry_sleep_timeout=0,
+        )
+
+        response = await executor.execute(request_simple)
+
+        assert response.status == 200
+        assert base.call_count == 3

tests/exthttp/test_types.py

@@ -18,6 +18,25 @@ async def test_has_data(self):
         assert response.headers == CIMultiDict()
         assert await response.read() == b"some-data"
 
+    async def test_json(self):
+        response = Response(
+            url="example.com",
+            status=200,
+            backend_response=DummyBackendResponse(b'{"a": 1, "b": [10, 20]}'),
+        )
+
+        assert response.status == 200
+        assert response.headers == CIMultiDict()
+        assert await response.json() == {
+            "a": 1,
+            "b": [10, 20],
+        }
+
+        assert await response.json(encoding="latin-1") == {
+            "a": 1,
+            "b": [10, 20],
+        }
+
     async def test_has_data_double(self):
         response = Response(
             url="example.com",
@@ -78,6 +97,9 @@ async def close(self) -> None:
             async def read(self) -> bytes:
                 return b""  # pragma: no cover
 
+            async def json(self, **kwargs) -> Any:
+                return None  # pragma: no cover
+
         response = Response[Any](
             url="example.com", status=200, backend_response=_Resp()
         )