Use 'body' instead of 'raw' for responses

Author: sethmlarson

dev-requirements.txt

@@ -1,4 +1,4 @@
-elastic-transport>=8.0.0a1, <9
+elastic-transport>=8.0.0a7, <9
 requests>=2, <3
 aiohttp
 pytest

elasticsearch/_async/client/_base.py

@@ -248,7 +248,7 @@ async def _perform_request(
         target: str,
         headers: Optional[Mapping[str, str]] = None,
         body: Optional[Any] = None,
-    ) -> ApiResponse[Any, Any]:
+    ) -> ApiResponse[Any]:
         if headers:
             request_headers = self._headers.copy()
             request_headers.update(headers)
@@ -327,18 +327,18 @@ async def _perform_request(
         if method == "HEAD":
             response = HeadApiResponse(meta=meta)
         elif isinstance(resp_body, dict):
-            response = ObjectApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ObjectApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         elif isinstance(resp_body, list):
-            response = ListApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ListApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         elif isinstance(resp_body, str):
             response = TextApiResponse(  # type: ignore[assignment]
-                raw=resp_body,
+                body=resp_body,
                 meta=meta,
             )
         elif isinstance(resp_body, bytes):
-            response = BinaryApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = BinaryApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         else:
-            response = ApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
 
         return response
 

elasticsearch/_async/helpers.py

@@ -119,7 +119,7 @@ async def _process_bulk_chunk(
         )
     else:
         gen = _process_bulk_chunk_success(
-            resp=resp.raw,
+            resp=resp.body,
             bulk_data=bulk_data,
             ignore_status=ignore_status,
             raise_on_error=raise_on_error,
@@ -442,20 +442,20 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> MutableMapping[str, An
         search_kwargs["size"] = size
         resp = await client.search(body=query, **search_kwargs)  # type: ignore[call-arg]
 
-    scroll_id: Optional[str] = resp.raw.get("_scroll_id")
+    scroll_id: Optional[str] = resp.get("_scroll_id")
     scroll_transport_kwargs = pop_transport_kwargs(scroll_kwargs)
     if scroll_transport_kwargs:
         scroll_client = client.options(**scroll_transport_kwargs)
     else:
         scroll_client = client
 
     try:
-        while scroll_id and resp.raw["hits"]["hits"]:
-            for hit in resp.raw["hits"]["hits"]:
+        while scroll_id and resp["hits"]["hits"]:
+            for hit in resp["hits"]["hits"]:
                 yield hit
 
             # Default to 0 if the value isn't included in the response
-            shards_info: Dict[str, int] = resp.raw["_shards"]
+            shards_info: Dict[str, int] = resp["_shards"]
             shards_successful = shards_info.get("successful", 0)
             shards_skipped = shards_info.get("skipped", 0)
             shards_total = shards_info.get("total", 0)
@@ -482,7 +482,7 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> MutableMapping[str, An
             resp = await scroll_client.scroll(
                 scroll_id=scroll_id, scroll=scroll, **scroll_kwargs
             )
-            scroll_id = resp.raw.get("_scroll_id")
+            scroll_id = resp.get("_scroll_id")
 
     finally:
         if scroll_id and clear_scroll:

elasticsearch/_sync/client/_base.py

@@ -248,7 +248,7 @@ def _perform_request(
         target: str,
         headers: Optional[Mapping[str, str]] = None,
         body: Optional[Any] = None,
-    ) -> ApiResponse[Any, Any]:
+    ) -> ApiResponse[Any]:
         if headers:
             request_headers = self._headers.copy()
             request_headers.update(headers)
@@ -327,18 +327,18 @@ def _perform_request(
         if method == "HEAD":
             response = HeadApiResponse(meta=meta)
         elif isinstance(resp_body, dict):
-            response = ObjectApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ObjectApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         elif isinstance(resp_body, list):
-            response = ListApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ListApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         elif isinstance(resp_body, str):
             response = TextApiResponse(  # type: ignore[assignment]
-                raw=resp_body,
+                body=resp_body,
                 meta=meta,
             )
         elif isinstance(resp_body, bytes):
-            response = BinaryApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = BinaryApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
         else:
-            response = ApiResponse(raw=resp_body, meta=meta)  # type: ignore[assignment]
+            response = ApiResponse(body=resp_body, meta=meta)  # type: ignore[assignment]
 
         return response
 

elasticsearch/helpers/actions.py

@@ -347,7 +347,7 @@ def _process_bulk_chunk(
         )
     else:
         gen = _process_bulk_chunk_success(
-            resp=resp.raw,
+            resp=resp.body,
             bulk_data=bulk_data,
             ignore_status=ignore_status,
             raise_on_error=raise_on_error,
@@ -704,19 +704,19 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> Dict[str, Any]:
         search_kwargs["size"] = size
         resp = client.search(body=query, **search_kwargs)  # type: ignore[call-arg]
 
-    scroll_id = resp.raw.get("_scroll_id")
+    scroll_id = resp.get("_scroll_id")
     scroll_transport_kwargs = pop_transport_kwargs(scroll_kwargs)
     if scroll_transport_kwargs:
         scroll_client = client.options(**scroll_transport_kwargs)
     else:
         scroll_client = client
 
     try:
-        while scroll_id and resp.raw["hits"]["hits"]:
-            yield from resp.raw["hits"]["hits"]
+        while scroll_id and resp["hits"]["hits"]:
+            yield from resp["hits"]["hits"]
 
             # Default to 0 if the value isn't included in the response
-            shards_info: Dict[str, int] = resp.raw["_shards"]
+            shards_info: Dict[str, int] = resp["_shards"]
             shards_successful = shards_info.get("successful", 0)
             shards_skipped = shards_info.get("skipped", 0)
             shards_total = shards_info.get("total", 0)
@@ -743,7 +743,7 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> Dict[str, Any]:
             resp = scroll_client.scroll(
                 scroll_id=scroll_id, scroll=scroll, **scroll_kwargs
             )
-            scroll_id = resp.raw.get("_scroll_id")
+            scroll_id = resp.get("_scroll_id")
 
     finally:
         if scroll_id and clear_scroll:

setup.py

@@ -51,7 +51,7 @@
     if package == package_name or package.startswith(package_name + ".")
 ]
 
-install_requires = ["elastic-transport>=8.0.0a1,<9"]
+install_requires = ["elastic-transport>=8.0.0a7,<9"]
 async_requires = ["aiohttp>=3,<4"]
 
 setup(

test_elasticsearch/test_async/test_server/test_helpers.py

@@ -425,7 +425,7 @@ async def __call__(self, *args, **kwargs):
         self.calls.append((args, kwargs))
         if len(self.calls) == 1:
             return ObjectApiResponse(
-                raw={
+                body={
                     "_scroll_id": "dummy_id",
                     "_shards": {"successful": 4, "total": 5, "skipped": 0},
                     "hits": {"hits": [{"scroll_data": 42}]},
@@ -434,7 +434,7 @@ async def __call__(self, *args, **kwargs):
             )
         elif len(self.calls) == 2:
             return ObjectApiResponse(
-                raw={
+                body={
                     "_scroll_id": "dummy_id",
                     "_shards": {"successful": 4, "total": 5, "skipped": 0},
                     "hits": {"hits": []},
@@ -549,7 +549,7 @@ async def test_initial_search_error(self, async_client, scan_teardown):
                 "search",
                 MockResponse(
                     ObjectApiResponse(
-                        raw={
+                        body={
                             "_scroll_id": "dummy_id",
                             "_shards": {"successful": 4, "total": 5, "skipped": 0},
                             "hits": {"hits": [{"search_data": 1}]},
@@ -576,7 +576,7 @@ async def test_initial_search_error(self, async_client, scan_teardown):
                 "search",
                 MockResponse(
                     ObjectApiResponse(
-                        raw={
+                        body={
                             "_scroll_id": "dummy_id",
                             "_shards": {"successful": 4, "total": 5, "skipped": 0},
                             "hits": {"hits": [{"search_data": 1}]},
@@ -606,7 +606,7 @@ async def test_no_scroll_id_fast_route(self, async_client, scan_teardown):
         ), patch.object(async_client, "scroll") as scroll_mock, patch.object(
             async_client,
             "search",
-            MockResponse(ObjectApiResponse(raw={"no": "_scroll_id"}, meta=None)),
+            MockResponse(ObjectApiResponse(body={"no": "_scroll_id"}, meta=None)),
         ), patch.object(
             async_client, "clear_scroll"
         ) as clear_mock:
@@ -720,7 +720,7 @@ async def test_scan_auth_kwargs_forwarded(
             "search",
             return_value=MockResponse(
                 ObjectApiResponse(
-                    raw={
+                    body={
                         "_scroll_id": "scroll_id",
                         "_shards": {"successful": 5, "total": 5, "skipped": 0},
                         "hits": {"hits": [{"search_data": 1}]},
@@ -734,7 +734,7 @@ async def test_scan_auth_kwargs_forwarded(
                 "scroll",
                 return_value=MockResponse(
                     ObjectApiResponse(
-                        raw={
+                        body={
                             "_scroll_id": "scroll_id",
                             "_shards": {"successful": 5, "total": 5, "skipped": 0},
                             "hits": {"hits": []},
@@ -773,7 +773,7 @@ async def test_scan_auth_kwargs_favor_scroll_kwargs_option(
             "search",
             return_value=MockResponse(
                 ObjectApiResponse(
-                    raw={
+                    body={
                         "_scroll_id": "scroll_id",
                         "_shards": {"successful": 5, "total": 5, "skipped": 0},
                         "hits": {"hits": [{"search_data": 1}]},
@@ -787,7 +787,7 @@ async def test_scan_auth_kwargs_favor_scroll_kwargs_option(
                 "scroll",
                 return_value=MockResponse(
                     ObjectApiResponse(
-                        raw={
+                        body={
                             "_scroll_id": "scroll_id",
                             "_shards": {"successful": 5, "total": 5, "skipped": 0},
                             "hits": {"hits": []},

test_elasticsearch/test_async/test_server/test_mapbox_vector_tile.py

@@ -140,10 +140,10 @@ async def test_mapbox_vector_tile_response(elasticsearch_url, mvt_setup, ca_cert
     )
 
     assert resp.meta.status == 200
-    assert isinstance(resp.raw, bytes)
+    assert isinstance(resp.body, bytes)
 
     # Decode the binary as MVT
-    tile = mapbox_vector_tile.decode(resp.raw)
+    tile = mapbox_vector_tile.decode(resp.body)
 
     # Assert some general things about the structure, mostly we want
     # to know that we got back a valid MVT.

test_elasticsearch/test_async/test_server/test_rest_api_spec.py

@@ -174,7 +174,7 @@ async def run_do(self, action):
         warnings.simplefilter("always", category=ElasticsearchWarning)
         with warnings.catch_warnings(record=True) as caught_warnings:
             try:
-                self.last_response = (await api(**args)).raw
+                self.last_response = (await api(**args)).body
             except Exception as e:
                 self._skip_intentional_type_errors(e)
                 if not catch:

test_elasticsearch/test_server/test_mapbox_vector_tile.py

@@ -142,10 +142,10 @@ def test_mapbox_vector_tile_response(
     )
 
     assert resp.meta.status == 200
-    assert isinstance(resp.raw, bytes)
+    assert isinstance(resp.body, bytes)
 
     # Decode the binary as MVT
-    tile = mapbox_vector_tile.decode(resp.raw)
+    tile = mapbox_vector_tile.decode(resp.body)
 
     # Assert some general things about the structure, mostly we want
     # to know that we got back a valid MVT.

test_elasticsearch/test_server/test_responses.py

@@ -19,24 +19,24 @@
 def test_text_response(sync_client):
     resp = sync_client.cat.tasks()
     assert resp.meta.status == 200
-    assert isinstance(resp.raw, str)
-    assert str(resp.raw) == str(resp)
+    assert isinstance(resp.body, str)
+    assert str(resp.body) == str(resp)
 
 
 def test_object_response(sync_client):
     resp = sync_client.search(size=1)
-    assert isinstance(resp.raw, dict)
-    assert set(resp) == set(resp.raw)
+    assert isinstance(resp.body, dict)
+    assert set(resp) == set(resp.body)
     assert resp.items()
     assert resp.keys()
-    assert str(resp) == str(resp.raw)
-    assert resp["hits"] == resp.raw["hits"]
+    assert str(resp) == str(resp.body)
+    assert resp["hits"] == resp.body["hits"]
     assert type(resp.copy()) is dict
 
 
 def test_exists_response(sync_client):
     resp = sync_client.indices.exists(index="no")
-    assert resp.raw is False
+    assert resp.body is False
     assert not resp
     if resp:
         assert False, "Didn't evaluate to 'False'"

test_elasticsearch/test_server/test_rest_api_spec.py

@@ -276,7 +276,7 @@ def run_do(self, action):
         warnings.simplefilter("always", category=ElasticsearchWarning)
         with warnings.catch_warnings(record=True) as caught_warnings:
             try:
-                self.last_response = api(**args).raw
+                self.last_response = api(**args).body
             except Exception as e:
                 self._skip_intentional_type_errors(e)
                 if not catch: