Improve test_rewrite_parameters tests

Author: pquentin

elasticsearch/_sync/client/utils.py

@@ -289,7 +289,7 @@ def _merge_kwargs_no_duplicates(kwargs: Dict[str, Any], values: Dict[str, Any])
         if key in kwargs:
             raise ValueError(
                 f"Received multiple values for '{key}', specify parameters "
-                "directly instead of using 'body' or 'params'"
+                "directly instead of using 'params'"
             )
         kwargs[key] = val
 
@@ -301,10 +301,16 @@ def _merge_body_fields_no_duplicates(
         if key in body:
             raise ValueError(
                 f"Received multiple values for '{key}', specify parameters "
-                "directly instead of using 'body' or 'params'"
+                "using either body or parameters, not both."
             )
         if key in body_fields:
-            # deprecate this
+            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 "
+                "version. Instead, use only 'body' or only specific paremeters.",
+                category=DeprecationWarning,
+                stacklevel=warn_stacklevel(),
+            )
             body[key] = kwargs.pop(key)
 
 
@@ -398,7 +404,7 @@ def wrapped(*args: Any, **kwargs: Any) -> Any:
                             )
                         kwargs[body_name] = body
 
-                    elif body_fields:
+                    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. "

test_elasticsearch/test_client/test_rewrite_parameters.py

@@ -42,17 +42,19 @@ def wrapped_func_default(self, *args, **kwargs):
     def wrapped_func_body_name(self, *args, **kwargs):
         self.calls.append((args, kwargs))
 
-    @_rewrite_parameters(body_fields=True)
+    @_rewrite_parameters(body_fields=("query", "source"))
     def wrapped_func_body_fields(self, *args, **kwargs):
         self.calls.append((args, kwargs))
 
     @_rewrite_parameters(
-        body_fields=True, ignore_deprecated_options={"api_key", "body", "params"}
+        body_fields=("query",), ignore_deprecated_options={"api_key", "body", "params"}
     )
     def wrapped_func_ignore(self, *args, **kwargs):
         self.calls.append((args, kwargs))
 
-    @_rewrite_parameters(body_fields=True, parameter_aliases={"_source": "source"})
+    @_rewrite_parameters(
+        body_fields=("source",), parameter_aliases={"_source": "source"}
+    )
     def wrapped_func_aliases(self, *args, **kwargs):
         self.calls.append((args, kwargs))
 
@@ -81,6 +83,16 @@ def test_default(self):
             ((), {"query": {"match_all": {}}, "key": "value"}),
         ]
 
+    def test_default_params_conflict(self):
+        with pytest.raises(ValueError) as e:
+            self.wrapped_func_default(
+                query={"match_all": {}},
+                params={"query": {"match_all": {}}},
+            )
+        assert str(e.value) == (
+            "Received multiple values for 'query', specify parameters directly instead of using 'params'"
+        )
+
     def test_body_name_using_body(self):
         with warnings.catch_warnings(record=True) as w:
             self.wrapped_func_body_name(
@@ -167,6 +179,25 @@ def test_error_on_params_merge(self, params):
             "using 'params' use individual API parameters"
         )
 
+    def test_body_fields_merge(self):
+        with warnings.catch_warnings(record=True) as w:
+            self.wrapped_func_body_fields(source=False, body={"query": {}})
+
+        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 "
+            "'body' parameter, which is deprecated and will be removed in a future "
+            "version. Instead, use only 'body' or only specific paremeters."
+        )
+
+    def test_body_fields_conflict(self):
+        with pytest.raises(ValueError) as e:
+            self.wrapped_func_body_fields(query={"match_all": {}}, body={"query": {}})
+        assert str(e.value) == (
+            "Received multiple values for 'query', specify parameters using either body or parameters, not both."
+        )
+
     def test_ignore_deprecated_options(self):
         with warnings.catch_warnings(record=True) as w:
             self.wrapped_func_ignore(