Merge master into refactor_public_api_exports

vlad-perevezentsev · vlad-perevezentsev · commit bcb399f6bab9 · 2025-11-18T03:16:27.000-08:00
diff --git a/.github/workflows/openssf-scorecard.yml b/.github/workflows/openssf-scorecard.yml
@@ -72,6 +72,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@0499de31b99561a6d14a36a5f662c2a54f91beee # v4.31.2
+        uses: github/codeql-action/upload-sarif@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
         with:
           sarif_file: results.sarif
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -64,7 +64,7 @@ repos:
         additional_dependencies:
             - tomli
 -   repo: https://github.com/psf/black
-    rev: 25.9.0
+    rev: 25.11.0
     hooks:
     -   id: black
         exclude: "dpnp/_version.py"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,7 @@ Also, that release drops support for Python 3.9, making Python 3.10 the minimum
 * Added implementation of `dpnp.ndarray.tofile` method [#2635](https://github.com/IntelPython/dpnp/pull/2635)
 * Extended `pre-commit` configuration with `pyupgrade`, `actionlint`, and `gersemi` hooks [#2658](https://github.com/IntelPython/dpnp/pull/2658)
 * Added implementation of `dpnp.ndarray.tobytes` method [#2656](https://github.com/IntelPython/dpnp/pull/2656)
+* Added implementation of `dpnp.ndarray.__format__` method [#2662](https://github.com/IntelPython/dpnp/pull/2662)
 
 ### Changed
 
@@ -34,10 +35,12 @@ Also, that release drops support for Python 3.9, making Python 3.10 the minimum
 * Redesigned `dpnp.modf` function to be a part of `ufunc` and `vm` pybind11 extensions [#2654](https://github.com/IntelPython/dpnp/pull/2654)
 * Refactored `dpnp.fft` and `dpnp.random` submodules by removing wildcard imports and defining explicit public exports [#2649](https://github.com/IntelPython/dpnp/pull/2649)
 * Added support for the `out` keyword to accept a tuple, bringing ufunc signatures into alignment with those in NumPy [#2664](https://github.com/IntelPython/dpnp/pull/2664)
+* Unified public API definitions in `dpnp.linalg` and `dpnp.scipy` submodules [#2663](https://github.com/IntelPython/dpnp/pull/2663)
 
 ### Deprecated
 
 * `dpnp.asfarray` is deprecated. Use `dpnp.asarray` with an appropriate dtype instead [#2650](https://github.com/IntelPython/dpnp/pull/2650)
+* Passing the output array ``out`` positionally to `dpnp.minimum` and `dpnp.maximum` is deprecated. Pass the output with the keyword form, e.g. ``dpnp.minimum(a, b, out=c)`` [#2659](https://github.com/IntelPython/dpnp/pull/2659)
 
 ### Removed
 
diff --git a/doc/conf.py b/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)
diff --git a/doc/reference/ndarray.rst b/doc/reference/ndarray.rst
@@ -449,3 +449,4 @@ String representations:
 
    ndarray.__str__
    ndarray.__repr__
+   ndarray.__format__
diff --git a/dpnp/dpnp_algo/dpnp_elementwise_common.py b/dpnp/dpnp_algo/dpnp_elementwise_common.py
@@ -26,6 +26,9 @@
 # THE POSSIBILITY OF SUCH DAMAGE.
 # *****************************************************************************
 
+import warnings
+from functools import wraps
+
 import dpctl.tensor as dpt
 import dpctl.tensor._copy_utils as dtc
 import dpctl.tensor._tensor_impl as dti
@@ -48,6 +51,7 @@
     "DPNPI0",
     "DPNPAngle",
     "DPNPBinaryFunc",
+    "DPNPBinaryFuncOutKw",
     "DPNPFix",
     "DPNPImag",
     "DPNPReal",
@@ -775,6 +779,22 @@ def outer(
         )
 
 
+class DPNPBinaryFuncOutKw(DPNPBinaryFunc):
+    """DPNPBinaryFunc that deprecates positional `out` argument."""
+
+    @wraps(DPNPBinaryFunc.__call__)
+    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."""
 
diff --git a/dpnp/dpnp_array.py b/dpnp/dpnp_array.py
@@ -302,7 +302,9 @@ def __floordiv__(self, other, /):
         r"""Return :math:`\text{self // value}`."""
         return dpnp.floor_divide(self, other)
 
-    # '__format__',
+    def __format__(self, format_spec):
+        r"""Return :math:`\text{format(self, format_spec)}`."""
+        return format(self.asnumpy(), format_spec)
 
     def __ge__(self, other, /):
         r"""Return :math:`\text{self >= value}`."""
diff --git a/dpnp/dpnp_iface_mathematical.py b/dpnp/dpnp_iface_mathematical.py
@@ -64,6 +64,7 @@
     DPNPI0,
     DPNPAngle,
     DPNPBinaryFunc,
+    DPNPBinaryFuncOutKw,
     DPNPFix,
     DPNPImag,
     DPNPReal,
@@ -3178,6 +3179,16 @@ def interp(x, xp, fp, left=None, right=None, period=None):
 
     Default: ``"K"``.
 
+Warning
+-------
+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.
+
+For example, ``dpnp.maximum(a, b, c)`` will emit a ``DeprecationWarning``.
+Always pass the output array as the keyword argument instead, that is
+``dpnp.maximum(a, b, out=c)``.
+
 Returns
 -------
 out : dpnp.ndarray
@@ -3231,7 +3242,7 @@ def interp(x, xp, fp, left=None, right=None, period=None):
 
 """
 
-maximum = DPNPBinaryFunc(
+maximum = DPNPBinaryFuncOutKw(
     "maximum",
     ti._maximum_result_type,
     ti._maximum,
@@ -3275,6 +3286,16 @@ def interp(x, xp, fp, left=None, right=None, period=None):
     An array containing the element-wise minima. The data type of
     the returned array is determined by the Type Promotion Rules.
 
+Warning
+-------
+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.
+
+For example, ``dpnp.minimum(a, b, c)`` will emit a ``DeprecationWarning``.
+Always pass the output array as the keyword argument instead, that is
+``dpnp.minimum(a, b, out=c)``.
+
 Limitations
 -----------
 Parameters `where` and `subok` are supported with their default values.
@@ -3321,7 +3342,7 @@ def interp(x, xp, fp, left=None, right=None, period=None):
 array(-inf)
 """
 
-minimum = DPNPBinaryFunc(
+minimum = DPNPBinaryFuncOutKw(
     "minimum",
     ti._minimum_result_type,
     ti._minimum,
diff --git a/dpnp/linalg/__init__.py b/dpnp/linalg/__init__.py
@@ -38,9 +38,6 @@
 
 from .dpnp_iface_linalg import (
     LinAlgError,
-)
-from .dpnp_iface_linalg import __all__ as __all__linalg
-from .dpnp_iface_linalg import (
     cholesky,
     cond,
     cross,
@@ -74,4 +71,37 @@
     vector_norm,
 )
 
-__all__ = __all__linalg
+__all__ = [
+    "LinAlgError",
+    "cholesky",
+    "cond",
+    "cross",
+    "det",
+    "diagonal",
+    "eig",
+    "eigh",
+    "eigvals",
+    "eigvalsh",
+    "inv",
+    "lstsq",
+    "matmul",
+    "matrix_norm",
+    "matrix_power",
+    "matrix_rank",
+    "matrix_transpose",
+    "multi_dot",
+    "norm",
+    "outer",
+    "pinv",
+    "qr",
+    "solve",
+    "svd",
+    "svdvals",
+    "slogdet",
+    "tensordot",
+    "tensorinv",
+    "tensorsolve",
+    "trace",
+    "vecdot",
+    "vector_norm",
+]
diff --git a/dpnp/linalg/dpnp_iface_linalg.py b/dpnp/linalg/dpnp_iface_linalg.py
@@ -71,41 +71,6 @@
     dpnp_svd,
 )
 
-__all__ = [
-    "LinAlgError",
-    "cholesky",
-    "cond",
-    "cross",
-    "det",
-    "diagonal",
-    "eig",
-    "eigh",
-    "eigvals",
-    "eigvalsh",
-    "inv",
-    "lstsq",
-    "matmul",
-    "matrix_norm",
-    "matrix_power",
-    "matrix_rank",
-    "matrix_transpose",
-    "multi_dot",
-    "norm",
-    "outer",
-    "pinv",
-    "qr",
-    "solve",
-    "svd",
-    "svdvals",
-    "slogdet",
-    "tensordot",
-    "tensorinv",
-    "tensorsolve",
-    "trace",
-    "vecdot",
-    "vector_norm",
-]
-
 # Need to set the module explicitly, because it's initially exposed by LAPACK
 # pybind11 extension and to add the docstrings
 LinAlgError.__module__ = "dpnp.linalg"
diff --git a/dpnp/linalg/dpnp_utils_linalg.py b/dpnp/linalg/dpnp_utils_linalg.py
@@ -52,27 +52,6 @@
 import dpnp.backend.extensions.lapack._lapack_impl as li
 from dpnp.dpnp_utils import get_usm_allocations
 
-__all__ = [
-    "assert_2d",
-    "assert_stacked_2d",
-    "assert_stacked_square",
-    "dpnp_cholesky",
-    "dpnp_cond",
-    "dpnp_det",
-    "dpnp_eigh",
-    "dpnp_inv",
-    "dpnp_lstsq",
-    "dpnp_matrix_power",
-    "dpnp_matrix_rank",
-    "dpnp_multi_dot",
-    "dpnp_norm",
-    "dpnp_pinv",
-    "dpnp_qr",
-    "dpnp_slogdet",
-    "dpnp_solve",
-    "dpnp_svd",
-]
-
 
 # pylint:disable=missing-class-docstring
 class EighResult(NamedTuple):
diff --git a/dpnp/scipy/linalg/_decomp_lu.py b/dpnp/scipy/linalg/_decomp_lu.py
@@ -51,11 +51,6 @@
     dpnp_lu_solve,
 )
 
-__all__ = [
-    "lu_factor",
-    "lu_solve",
-]
-
 
 def lu_factor(a, overwrite_a=False, check_finite=True):
     """
diff --git a/dpnp/scipy/linalg/_utils.py b/dpnp/scipy/linalg/_utils.py
@@ -51,11 +51,6 @@
 from dpnp.dpnp_utils import get_usm_allocations
 from dpnp.linalg.dpnp_utils_linalg import _common_type
 
-__all__ = [
-    "dpnp_lu_factor",
-    "dpnp_lu_solve",
-]
-
 
 def _align_lu_solve_broadcast(lu, b):
     """Align LU and RHS batch dimensions with SciPy-like rules."""
diff --git a/dpnp/scipy/special/_erf.py b/dpnp/scipy/special/_erf.py
@@ -44,8 +44,6 @@
 import dpnp.backend.extensions.ufunc._ufunc_impl as ufi
 from dpnp.dpnp_algo.dpnp_elementwise_common import DPNPUnaryFunc
 
-__all__ = ["erf", "erfc", "erfcinv", "erfcx", "erfinv"]
-
 
 # pylint: disable=too-few-public-methods
 class DPNPErf(DPNPUnaryFunc):
diff --git a/dpnp/tests/test_binary_ufuncs.py b/dpnp/tests/test_binary_ufuncs.py
@@ -183,7 +183,7 @@ def test_invalid_shape(self, func, shape):
     )
     def test_invalid_out_type(self, func, xp, out):
         a = xp.arange(10)
-        assert_raises(TypeError, getattr(xp, func), a, 2, out)
+        assert_raises(TypeError, getattr(xp, func), a, 2, out=out)
 
 
 class TestDivide:
diff --git a/dpnp/tests/test_mathematical.py b/dpnp/tests/test_mathematical.py
@@ -2795,3 +2795,15 @@ def test_elemenwise_outer_scalar():
     expected = dpnp.add.outer(x, y)
     result = dpnp.add.outer(x, s)
     assert dpnp.allclose(result, expected)
+
+
+@testing.with_requires("numpy>=2.4")
+@pytest.mark.parametrize("xp", [dpnp, numpy])
+@pytest.mark.parametrize("func", ["minimum", "maximum"])
+def test_minimum_maximum_out_deprecated(xp, func):
+    a = xp.array([1, 3, 2])
+    b = xp.array([2, 2, 2])
+    out = xp.empty_like(a)
+
+    with pytest.warns(DeprecationWarning, match="deprecated"):
+        _ = getattr(xp, func)(a, b, out)
diff --git a/dpnp/tests/test_ndarray.py b/dpnp/tests/test_ndarray.py
@@ -108,6 +108,21 @@ def test_strides(self):
         assert xp.full_like(a, fill_value=6) not in a
 
 
+class TestFormat:
+    def test_basic(self):
+        a = numpy.array(3.14159)
+        ia = dpnp.array(a)
+
+        spec = ".3f"
+        assert_equal(format(ia, spec), format(a, spec))
+
+    @pytest.mark.parametrize("xp", [dpnp, numpy])
+    def test_1d(self, xp):
+        a = xp.array([3.14159])
+        with pytest.raises(TypeError, match="unsupported format string"):
+            _ = format(a, ".2f")
+
+
 class TestToBytes:
     @pytest.mark.parametrize("order", ["C", "F", "K", "A", None])
     def test_roundtrip_binary_str(self, order):
diff --git a/dpnp/tests/test_special.py b/dpnp/tests/test_special.py
@@ -29,7 +29,7 @@ def test_basic(self, func, dt):
         expected = getattr(scipy.special, func)(a)
 
         # scipy >= 0.16.0 returns float64, but dpnp returns float32
-        to_float32 = dt in (dpnp.bool, dpnp.float16)
+        to_float32 = dpnp.result_type(dt, dpnp.float32) == dpnp.float32
         only_type_kind = installed("scipy>=0.16.0") and to_float32
         assert_dtype_allclose(
             result, expected, check_only_type_kind=only_type_kind
diff --git a/dpnp/tests/test_sycl_queue.py b/dpnp/tests/test_sycl_queue.py
@@ -1016,7 +1016,10 @@ def test_invalid_stream(self, stream):
         "asarray_chkfinite",
         "asanyarray",
         "ascontiguousarray",
-        "asfarray",
+        pytest.param(
+            "asfarray",
+            marks=pytest.mark.filterwarnings("ignore::DeprecationWarning"),
+        ),
         "asfortranarray",
     ],
 )
diff --git a/dpnp/tests/test_usm_type.py b/dpnp/tests/test_usm_type.py
diff --git a/dpnp/tests/third_party/cupy/core_tests/test_ndarray.py b/dpnp/tests/third_party/cupy/core_tests/test_ndarray.py

Original file line number	Diff line number	Diff line change
`@@ -449,3 +449,4 @@ String representations:`
`449`	`449`
`450`	`450`	`ndarray.__str__`
`451`	`451`	`ndarray.__repr__`
	`452`	`+ ndarray.__format__`