CLN Deprecations position args in PartialDependenceDisplay.plot (scikit-learn#18293)

Author: thomasjpfan

doc/whats_new/v0.24.rst

@@ -93,7 +93,7 @@ Changelog
   When set to `True`, additional messages will be displayed which can aid with
   debugging. :pr:`18052` by :user:`Sean O. Stalley <sstalley>`.
 
-- |Enhancement| Added :func:`cluster.kmeans_plusplus` as public function. 
+- |Enhancement| Added :func:`cluster.kmeans_plusplus` as public function.
   Initialization by KMeans++ can now be called separately to generate
   initial cluster centroids. :pr:`17937` by :user:`g-walsh`
 
@@ -373,6 +373,10 @@ Changelog
   :func:`inspection.permutation_importance`. :pr:`16906` by
   :user:`Roei Kahny <RoeiKa>`.
 
+- |API| Positional arguments are deprecated in
+  :meth:`inspection.PartialDependenceDisplay.plot` and will error in 0.26.
+  :pr:`18293` by `Thomas Fan`_.
+
 :mod:`sklearn.isotonic`
 .......................
 
@@ -741,7 +745,7 @@ Changelog
   when `handle_unknown='error'` and `drop=None` for samples
   encoded as all zeros. :pr:`14982` by
   :user:`Kevin Winata <kwinata>`.
-  
+
 :mod:`sklearn.semi_supervised`
 ..............................
 

sklearn/inspection/_plot/partial_dependence.py

@@ -817,7 +817,8 @@ def _plot_two_way_partial_dependence(
             ax.set_xlabel(self.feature_names[feature_idx[0]])
         ax.set_ylabel(self.feature_names[feature_idx[1]])
 
-    def plot(self, ax=None, n_cols=3, line_kw=None, contour_kw=None):
+    @_deprecate_positional_args(version="0.26")
+    def plot(self, *, ax=None, n_cols=3, line_kw=None, contour_kw=None):
         """Plot partial dependence plots.
 
         Parameters

sklearn/utils/tests/test_validation.py

@@ -1168,6 +1168,16 @@ def f3(a, *, b, c=1, d=1):
         f3(1, 2)
 
 
+def test_deprecate_positional_args_warns_for_function_version():
+    @_deprecate_positional_args(version="0.26")
+    def f1(a, *, b):
+        pass
+
+    with pytest.warns(FutureWarning,
+                      match=r"From version 0.26 passing these as positional"):
+        f1(1, 2)
+
+
 def test_deprecate_positional_args_warns_for_class():
 
     class A1:

sklearn/utils/validation.py

@@ -32,44 +32,52 @@
 FLOAT_DTYPES = (np.float64, np.float32, np.float16)
 
 
-def _deprecate_positional_args(f):
+def _deprecate_positional_args(func=None, *, version="0.25"):
     """Decorator for methods that issues warnings for positional arguments.
 
     Using the keyword-only argument syntax in pep 3102, arguments after the
     * will issue a warning when passed as a positional argument.
 
     Parameters
     ----------
-    f : callable
+    func : callable, default=None
         Function to check arguments on.
+    version : callable, default="0.25"
+        The version when positional arguments will result in error.
     """
-    sig = signature(f)
-    kwonly_args = []
-    all_args = []
-
-    for name, param in sig.parameters.items():
-        if param.kind == Parameter.POSITIONAL_OR_KEYWORD:
-            all_args.append(name)
-        elif param.kind == Parameter.KEYWORD_ONLY:
-            kwonly_args.append(name)
-
-    @wraps(f)
-    def inner_f(*args, **kwargs):
-        extra_args = len(args) - len(all_args)
-        if extra_args <= 0:
-            return f(*args, **kwargs)
-
-        # extra_args > 0
-        args_msg = ['{}={}'.format(name, arg)
-                    for name, arg in zip(kwonly_args[:extra_args],
-                                         args[-extra_args:])]
-        warnings.warn("Pass {} as keyword args. From version 0.25 "
-                      "passing these as positional arguments will "
-                      "result in an error".format(", ".join(args_msg)),
-                      FutureWarning)
-        kwargs.update(zip(sig.parameters, args))
-        return f(**kwargs)
-    return inner_f
+    def _inner_deprecate_positional_args(f):
+        sig = signature(f)
+        kwonly_args = []
+        all_args = []
+
+        for name, param in sig.parameters.items():
+            if param.kind == Parameter.POSITIONAL_OR_KEYWORD:
+                all_args.append(name)
+            elif param.kind == Parameter.KEYWORD_ONLY:
+                kwonly_args.append(name)
+
+        @wraps(f)
+        def inner_f(*args, **kwargs):
+            extra_args = len(args) - len(all_args)
+            if extra_args <= 0:
+                return f(*args, **kwargs)
+
+            # extra_args > 0
+            args_msg = ['{}={}'.format(name, arg)
+                        for name, arg in zip(kwonly_args[:extra_args],
+                                             args[-extra_args:])]
+            args_msg = ", ".join(args_msg)
+            warnings.warn(f"Pass {args_msg} as keyword args. From version "
+                          f"{version} passing these as positional arguments "
+                          "will result in an error", FutureWarning)
+            kwargs.update(zip(sig.parameters, args))
+            return f(**kwargs)
+        return inner_f
+
+    if func is not None:
+        return _inner_deprecate_positional_args(func)
+
+    return _inner_deprecate_positional_args
 
 
 def _assert_all_finite(X, allow_nan=False, msg_dtype=None):