Add DPNPBinaryFuncOutKw class to handle positional out deprecation

Author: vlad-perevezentsev

doc/conf.py

@@ -12,6 +12,7 @@
 
 from dpnp.dpnp_algo.dpnp_elementwise_common import (
     DPNPBinaryFunc,
+    DPNPBinaryFuncOutKw,
     DPNPUnaryFunc,
     DPNPUnaryTwoOutputsFunc,
 )
@@ -210,7 +211,13 @@
 # -- Options for todo extension ----------------------------------------------
 def _can_document_member(member, *args, **kwargs):
     if isinstance(
-        member, (DPNPBinaryFunc, DPNPUnaryFunc, DPNPUnaryTwoOutputsFunc)
+        member,
+        (
+            DPNPBinaryFunc,
+            DPNPBinaryFuncOutKw,
+            DPNPUnaryFunc,
+            DPNPUnaryTwoOutputsFunc,
+        ),
     ):
         return True
     return orig(member, *args, **kwargs)

dpnp/dpnp_algo/dpnp_elementwise_common.py

@@ -26,6 +26,8 @@
 # THE POSSIBILITY OF SUCH DAMAGE.
 # *****************************************************************************
 
+import warnings
+
 import dpctl.tensor as dpt
 import dpctl.tensor._copy_utils as dtc
 import dpctl.tensor._tensor_impl as dti
@@ -48,6 +50,7 @@
     "DPNPI0",
     "DPNPAngle",
     "DPNPBinaryFunc",
+    "DPNPBinaryFuncOutKw",
     "DPNPFix",
     "DPNPImag",
     "DPNPReal",
@@ -725,6 +728,21 @@ def outer(
         )
 
 
+class DPNPBinaryFuncOutKw(DPNPBinaryFunc):
+    """DPNPBinaryFunc that deprecates positional `out` argument."""
+
+    def __call__(self, *args, **kwargs):
+        if len(args) > self.nin:
+            warnings.warn(
+                "Passing more than 2 positional arguments is deprecated. "
+                "If you meant to use the third argument as an output, "
+                "use the `out` keyword argument instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return super().__call__(*args, **kwargs)
+
+
 class DPNPAngle(DPNPUnaryFunc):
     """Class that implements dpnp.angle unary element-wise functions."""
 

dpnp/dpnp_iface_mathematical.py

@@ -46,7 +46,6 @@
 
 import builtins
 import warnings
-from functools import wraps
 
 import dpctl.tensor as dpt
 import dpctl.tensor._tensor_elementwise_impl as ti
@@ -67,6 +66,7 @@
     DPNPI0,
     DPNPAngle,
     DPNPBinaryFunc,
+    DPNPBinaryFuncOutKw,
     DPNPFix,
     DPNPImag,
     DPNPReal,
@@ -3266,32 +3266,14 @@ def interp(x, xp, fp, left=None, right=None, period=None):
 
 """
 
-_maximum_impl = DPNPBinaryFunc(
+maximum = DPNPBinaryFuncOutKw(
     "maximum",
     ti._maximum_result_type,
     ti._maximum,
     _MAXIMUM_DOCSTRING,
 )
 
 
-@wraps(_maximum_impl)
-def maximum(*args, **kwargs):
-    """
-    Wrapper around `_maximum_impl` that emits a DeprecationWarning
-    when `out` is passed positionally.
-
-    """
-    if len(args) >= 3 and "out" not in kwargs:
-        warnings.warn(
-            "Passing more than 2 positional arguments is deprecated. If you "
-            "meant to use the third argument as an output, use the `out` "
-            "keyword argument instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-    return _maximum_impl(*args, **kwargs)
-
-
 _MINIMUM_DOCSTRING = """
 Computes the minimum value for each element :math:`x1_i` of the input array `x1`
 relative to the respective element :math:`x2_i` of the input array `x2`.
@@ -3382,32 +3364,14 @@ def maximum(*args, **kwargs):
 array(-inf)
 """
 
-_minimum_impl = DPNPBinaryFunc(
+minimum = DPNPBinaryFuncOutKw(
     "minimum",
     ti._minimum_result_type,
     ti._minimum,
     _MINIMUM_DOCSTRING,
 )
 
 
-@wraps(_minimum_impl)
-def minimum(*args, **kwargs):
-    """
-    Wrapper around `_minimum_impl` that emits a DeprecationWarning
-    when `out` is passed positionally.
-
-    """
-    if len(args) >= 3 and "out" not in kwargs:
-        warnings.warn(
-            "Passing more than 2 positional arguments is deprecated. If you "
-            "meant to use the third argument as an output, use the `out` "
-            "keyword argument instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-    return _minimum_impl(*args, **kwargs)
-
-
 def modf(x1, **kwargs):
     """
     Return the fractional and integral parts of an array, element-wise.