Fix body fields handling with str/bytes

Author: pquentin

elasticsearch/_sync/client/utils.py

@@ -74,6 +74,8 @@
     str, Sequence[Union[str, Mapping[str, Union[str, int]], NodeConfig]]
 ]
 
+_TYPE_BODY = Union[bytes, str, Dict[str, Any]]
+
 _TYPE_ASYNC_SNIFF_CALLBACK = Callable[
     [AsyncTransport, SniffOptions], Awaitable[List[NodeConfig]]
 ]
@@ -295,15 +297,21 @@ def _merge_kwargs_no_duplicates(kwargs: Dict[str, Any], values: Dict[str, Any])
 
 
 def _merge_body_fields_no_duplicates(
-    body: Dict[str, Any], kwargs: Dict[str, Any], body_fields: Tuple[str, ...]
+    body: _TYPE_BODY, kwargs: Dict[str, Any], body_fields: Tuple[str, ...]
 ) -> None:
     for key in list(kwargs.keys()):
-        if key in body:
-            raise ValueError(
-                f"Received multiple values for '{key}', specify parameters "
-                "using either body or parameters, not both."
-            )
         if key in body_fields:
+            if isinstance(body, (str, bytes)):
+                raise ValueError(
+                    "Couldn't merge 'body' with other parameters as it wasn't a mapping."
+                )
+
+            if key in body:
+                raise ValueError(
+                    f"Received multiple values for '{key}', specify parameters "
+                    "using either body or parameters, not both."
+                )
+
             warnings.warn(
                 f"Received '{key}' via a specific parameter in the presence of a "
                 "'body' parameter, which is deprecated and will be removed in a future "
@@ -392,7 +400,7 @@ def wrapped(*args: Any, **kwargs: Any) -> Any:
             if "body" in kwargs and (
                 not ignore_deprecated_options or "body" not in ignore_deprecated_options
             ):
-                body = kwargs.pop("body")
+                body: Optional[_TYPE_BODY] = kwargs.pop("body")
                 if body is not None:
                     if body_name:
                         if body_name in kwargs:
@@ -405,11 +413,6 @@ def wrapped(*args: Any, **kwargs: Any) -> Any:
                         kwargs[body_name] = body
 
                     elif body_fields is not None:
-                        if not hasattr(body, "items"):
-                            raise ValueError(
-                                "Couldn't merge 'body' with other parameters as it wasn't a mapping. "
-                                "Instead of using 'body' use individual API parameters"
-                            )
                         _merge_body_fields_no_duplicates(body, kwargs, body_fields)
                         kwargs["body"] = body
 

test_elasticsearch/test_client/test_rewrite_parameters.py

@@ -158,14 +158,17 @@ def test_body_fields(self):
         ]
 
     @pytest.mark.parametrize(
-        "body", ['{"query": {"match_all": {}}}', b'{"query": {"match_all": {}}}']
+        "body, kwargs",
+        [
+            ('{"query": {"match_all": {}}}', {"query": {"match_all": {}}}),
+            (b'{"query": {"match_all": {}}}', {"query": {"match_all": {}}}),
+        ],
     )
-    def test_error_on_body_merge(self, body):
+    def test_error_on_body_merge(self, body, kwargs):
         with pytest.raises(ValueError) as e:
-            self.wrapped_func_body_fields(body=body)
+            self.wrapped_func_body_fields(body=body, **kwargs)
         assert str(e.value) == (
-            "Couldn't merge 'body' with other parameters as it wasn't a mapping. Instead of "
-            "using 'body' use individual API parameters"
+            "Couldn't merge 'body' with other parameters as it wasn't a mapping."
         )
 
     @pytest.mark.parametrize(
@@ -186,7 +189,7 @@ def test_body_fields_merge(self):
         assert len(w) == 1
         assert w[0].category == DeprecationWarning
         assert str(w[0].message) == (
-            f"Received 'source' via a specific parameter in the presence of a "
+            "Received 'source' via a specific parameter in the presence of a "
             "'body' parameter, which is deprecated and will be removed in a future "
             "version. Instead, use only 'body' or only specific paremeters."
         )