fix!: raise TypeError for invalid property setter arguments (#4068)

Author: suzunn

altair/utils/schemapi.py

@@ -1662,6 +1662,19 @@ def __get__(self, obj, cls):
         return self
 
     def __call__(self, *args: Any, **kwargs: Any):
+        name = f"{type(self.obj).__name__}.{self.prop}"
+        if len(args) > 1:
+            msg = (
+                f"{name}() accepts at most one positional argument, "
+                f"but {len(args)} were given"
+            )
+            raise TypeError(msg)
+        if args and kwargs:
+            msg = (
+                f"{name}() cannot combine a positional argument with keyword arguments"
+            )
+            raise TypeError(msg)
+
         obj = self.obj.copy()
         # TODO: use schema to validate
         obj[self.prop] = args[0] if args else kwargs

tests/utils/test_schemapi.py

@@ -1147,6 +1147,24 @@ def test_to_dict_datetime_unsupported_timezone(tzinfo: dt.timezone) -> None:
         alt.FieldEqualPredicate(datetime.replace(tzinfo=tzinfo), "column 1")
 
 
+@pytest.mark.parametrize("setter", ["scale", "axis", "sort"])
+def test_property_setter_rejects_multiple_positional_arguments(setter: str) -> None:
+    method = getattr(alt.X("field:Q"), setter)
+    with pytest.raises(
+        TypeError, match=rf"X\.{setter}\(\) accepts at most one positional argument"
+    ):
+        method(["M", "F"], ["#1FC3AA", "#8624F5"])
+
+
+@pytest.mark.parametrize("setter", ["scale", "axis", "sort"])
+def test_property_setter_rejects_positional_and_keyword_arguments(setter: str) -> None:
+    method = getattr(alt.X("field:Q"), setter)
+    with pytest.raises(
+        TypeError, match=rf"X\.{setter}\(\) cannot combine a positional argument"
+    ):
+        method(["M", "F"], domain=["M", "F"])
+
+
 def test_to_dict_datetime_typing() -> None:
     """
     Enumerating various places that need updated annotations.

tests/vegalite/v6/schema/test_channels.py

@@ -64,19 +64,14 @@ def test_channels_typing() -> None:
     ):
         positional_as_keyword.to_dict()
 
-    keyword_as_positional = angle.sort("field:Q", "min", "descending")  # type: ignore[call-overload]
-    with pytest.raises(SchemaValidationError):
-        keyword_as_positional.to_dict()
+    with pytest.raises(
+        TypeError, match=r"sort\(\) accepts at most one positional argument"
+    ):
+        angle.sort("field:Q", "min", "descending")  # type: ignore[call-overload]
     angle.sort(field="field:Q", op="min", order="descending")
 
-    # NOTE: Doesn't raise `SchemaValidationError`
-    # - `"ascending"` is silently ignored when positional
-    # - Caught as invalid statically, but not at runtime
-    bad = angle.sort("x", "ascending").to_dict()  # type: ignore[call-overload]
-    good = angle.sort(encoding="x", order="ascending").to_dict()
-    assert isinstance(bad, dict)
-    assert isinstance(good, dict)
     with pytest.raises(
-        AssertionError, match=r"'x' == {'encoding': 'x', 'order': 'ascending'}"
+        TypeError, match=r"sort\(\) accepts at most one positional argument"
     ):
-        assert bad["sort"] == good["sort"]
+        angle.sort("x", "ascending")  # type: ignore[call-overload]
+    assert angle.sort(encoding="x", order="ascending").to_dict()

tools/schemapi/schemapi.py

@@ -1660,6 +1660,19 @@ def __get__(self, obj, cls):
         return self
 
     def __call__(self, *args: Any, **kwargs: Any):
+        name = f"{type(self.obj).__name__}.{self.prop}"
+        if len(args) > 1:
+            msg = (
+                f"{name}() accepts at most one positional argument, "
+                f"but {len(args)} were given"
+            )
+            raise TypeError(msg)
+        if args and kwargs:
+            msg = (
+                f"{name}() cannot combine a positional argument with keyword arguments"
+            )
+            raise TypeError(msg)
+
         obj = self.obj.copy()
         # TODO: use schema to validate
         obj[self.prop] = args[0] if args else kwargs