feat(py): add json() method for Response object (#277)

Adds a `Response.json()` method that parses `Response.text` using the
native `json` module.

Closes #275

Author: barjin

impit-python/python/impit/impit.pyi

@@ -2,7 +2,7 @@ from __future__ import annotations
 from http.cookiejar import CookieJar
 from .cookies import Cookies
 
-from typing import Literal
+from typing import Literal, Any
 from collections.abc import Iterator, AsyncIterator
 from contextlib import AbstractAsyncContextManager, AbstractContextManager
 
@@ -188,6 +188,13 @@ class Response:
     def aiter_bytes(self) -> AsyncIterator[bytes]:
         """Asynchronously iterate over the response content in chunks."""
 
+    def json(self) -> Any:
+        """Parse the response content as JSON.
+
+        Returns:
+            Parsed JSON data as a Python object (dict, list, str, int, float, bool, or None)
+        """
+
     def close(self) -> None:
         """Close the response and release resources."""
 

impit-python/src/response.rs

@@ -460,6 +460,13 @@ impl ImpitPyResponse {
         Ok(decoded_text)
     }
 
+    fn json(&mut self, py: Python<'_>) -> PyResult<Py<PyAny>> {
+        let text = self.text(py)?;
+        let json_module = py.import("json")?;
+        let parsed = json_module.call_method1("loads", (text,))?;
+        Ok(parsed.into())
+    }
+
     fn read(&mut self, py: Python<'_>) -> PyResult<Vec<u8>> {
         match self.inner_state {
             InnerResponseState::Read => self

impit-python/test/async_client_test.py

@@ -432,6 +432,15 @@ async def test_content(self, browser: Browser) -> None:
         assert isinstance(response.text, str)
         assert response.content.decode('utf-8') == response.text
 
+    @pytest.mark.asyncio
+    async def test_json(self, browser: Browser) -> None:
+        impit = AsyncClient(browser=browser)
+
+        response = await impit.get(get_httpbin_url('/get'))
+
+        assert response.status_code == 200
+        assert response.json() == json.loads(response.text)
+
 
 @pytest.mark.parametrize(
     ('browser'),

impit-python/test/basic_client_test.py

@@ -71,22 +71,22 @@ def test_headers_work(self, browser: Browser) -> None:
 
         response = impit.get(get_httpbin_url('/headers'), headers={'Impit-Test': 'foo'})
         assert response.status_code == 200
-        assert json.loads(response.text)['headers']['Impit-Test'] == 'foo'
+        assert response.json()['headers']['Impit-Test'] == 'foo'
 
     def test_client_wide_headers_work(self, browser: Browser) -> None:
         impit = Client(browser=browser, headers={'Impit-Test': 'foo'})
 
         response = impit.get(get_httpbin_url('/headers'))
         assert response.status_code == 200
-        assert json.loads(response.text)['headers']['Impit-Test'] == 'foo'
+        assert response.json()['headers']['Impit-Test'] == 'foo'
 
     def test_request_headers_over_client_headers(self, browser: Browser) -> None:
         impit = Client(browser=browser, headers={'Auth': '123', 'Exception': 'nope'})
 
         response = impit.get(get_httpbin_url('/headers'), headers={'Exception': 'yes'})
         assert response.status_code == 200
-        assert json.loads(response.text)['headers']['Auth'] == '123'
-        assert json.loads(response.text)['headers']['Exception'] == 'yes'
+        assert response.json()['headers']['Auth'] == '123'
+        assert response.json()['headers']['Exception'] == 'yes'
 
     def test_cookies_nonstandard(self, browser: Browser) -> None:
         cookies_jar = CookieJar()
@@ -161,23 +161,19 @@ def test_cookie_jar_works(self, browser: Browser) -> None:
             cookie_jar=cookies.jar,
         )
 
-        response = json.loads(
-            impit.get(
-                get_httpbin_url('/cookies/'),
-            ).text
-        )
+        response = impit.get(
+            get_httpbin_url('/cookies/'),
+        ).json()
 
         assert response['cookies'] == {'preset-cookie': '123'}
 
         impit.get(
             get_httpbin_url('/cookies/set', query={'set-by-server': '321'}),
         )
 
-        response = json.loads(
-            impit.get(
-                get_httpbin_url('/cookies/'),
-            ).text
-        )
+        response = impit.get(
+            get_httpbin_url('/cookies/'),
+        ).json()
 
         assert response['cookies'] == {
             'preset-cookie': '123',
@@ -194,23 +190,19 @@ def test_cookies_param_works(self, browser: Browser) -> None:
             cookies=cookies,
         )
 
-        response = json.loads(
-            impit.get(
-                get_httpbin_url('/cookies/'),
-            ).text
-        )
+        response = impit.get(
+            get_httpbin_url('/cookies/'),
+        ).json()
 
         assert response['cookies'] == {'preset-cookie': '123'}
 
         impit.get(
             get_httpbin_url('/cookies/set', query={'set-by-server': '321'}),
         )
 
-        response = json.loads(
-            impit.get(
-                get_httpbin_url('/cookies/'),
-            ).text
-        )
+        response = impit.get(
+            get_httpbin_url('/cookies/'),
+        ).json()
 
         assert response['cookies'] == {
             'preset-cookie': '123',
@@ -226,7 +218,7 @@ def test_overwriting_headers_work(self, browser: Browser) -> None:
 
         response = impit.get(get_httpbin_url('/headers'), headers={'User-Agent': 'this is impit!'})
         assert response.status_code == 200
-        assert json.loads(response.text)['headers']['User-Agent'] == 'this is impit!'
+        assert response.json()['headers']['User-Agent'] == 'this is impit!'
 
     @pytest.mark.skip(reason='Flaky under the CI environment')
     def test_http3_works(self, browser: Browser) -> None:
@@ -330,7 +322,7 @@ def test_passing_string_body(self, browser: Browser) -> None:
             headers={'Content-Type': 'application/json'},
         )
         assert response.status_code == 200
-        assert json.loads(response.text)['data'] == '{"Impit-Test":"foořžš"}'
+        assert response.json()['data'] == '{"Impit-Test":"foořžš"}'
 
     def test_passing_string_body_in_data(self, browser: Browser) -> None:
         impit = Client(browser=browser)
@@ -341,7 +333,7 @@ def test_passing_string_body_in_data(self, browser: Browser) -> None:
             headers={'Content-Type': 'application/json'},
         )
         assert response.status_code == 200
-        assert json.loads(response.text)['data'] == '{"Impit-Test":"foořžš"}'
+        assert response.json()['data'] == '{"Impit-Test":"foořžš"}'
 
     def test_form_non_ascii(self, browser: Browser) -> None:
         impit = Client(browser=browser)
@@ -351,7 +343,7 @@ def test_form_non_ascii(self, browser: Browser) -> None:
             data={'Impit-Test': '👾🕵🏻‍♂️🧑‍💻'},
         )
         assert response.status_code == 200
-        assert json.loads(response.text)['form']['Impit-Test'] == '👾🕵🏻‍♂️🧑‍💻'
+        assert response.json()['form']['Impit-Test'] == '👾🕵🏻‍♂️🧑‍💻'
 
     def test_passing_binary_body(self, browser: Browser) -> None:
         impit = Client(browser=browser)
@@ -383,7 +375,7 @@ def test_passing_binary_body(self, browser: Browser) -> None:
             headers={'Content-Type': 'application/json'},
         )
         assert response.status_code == 200
-        assert json.loads(response.text)['data'] == 'Impit-Test:foořžš'
+        assert response.json()['data'] == 'Impit-Test:foořžš'
 
     @pytest.mark.parametrize(
         ('method'),
@@ -396,7 +388,7 @@ def test_methods_accept_request_body(self, browser: Browser, method: str) -> Non
 
         response = m(get_httpbin_url(f'/{method.lower()}'), content=b'foo')
         assert response.status_code == 200
-        assert json.loads(response.text)['data'] == 'foo'
+        assert response.json()['data'] == 'foo'
 
     def test_content(self, browser: Browser) -> None:
         impit = Client(browser=browser)
@@ -408,6 +400,14 @@ def test_content(self, browser: Browser) -> None:
         assert isinstance(response.text, str)
         assert response.content.decode('utf-8') == response.text
 
+    def test_json(self, browser: Browser) -> None:
+        impit = Client(browser=browser)
+
+        response = impit.get(get_httpbin_url('/get'))
+
+        assert response.status_code == 200
+        assert response.json() == json.loads(response.text)
+
 
 @pytest.mark.parametrize(
     ('browser'),