Apply review comments

mtsokol · mtsokol · commit 85cae50a6981 · 2025-04-19T14:35:10.000Z
diff --git a/doc/release/upcoming_changes/28678.deprecation.rst b/doc/release/upcoming_changes/28678.deprecation.rst
@@ -1,4 +1,5 @@
 * ``arr.T`` property has been deprecated for array scalars and arrays with dimensionality
-  different than ``2`` to be compatible with the Array API standard. To achieve the same
-  behavior when ``arr.ndim != 2``, either ``np.permute_dims(arr, range(arr.ndim)[::-1])``
-  (also compatible with the Array API) or ``arr.transpose()`` can be used.
+  different than ``2`` to be compatible with the Array API standard. To achieve similar
+  behavior when ``arr.ndim != 2``, either ``arr.transpose()``, or ``arr.mT`` (swaps
+  the last two axes only), or ``np.permute_dims(arr, range(arr.ndim)[::-1])`` (compatible
+  with the Array API) or can be used.
diff --git a/numpy/_core/src/multiarray/getset.c b/numpy/_core/src/multiarray/getset.c
@@ -850,13 +850,13 @@ array_transpose_get(PyArrayObject *self, void *NPY_UNUSED(ignored))
 {
     int ndim = PyArray_NDIM(self);
     if (ndim != 2) {
-        if (PyErr_WarnFormat(PyExc_UserWarning, 1,
+        /* Deprecated 2025-04-19, NumPy 2.3 */
+        if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
                 "In the future `.T` property will be supported for "
                 "2-dim arrays only. Received %d-dim array. Either "
-                "`np.permute_dims(arr, range(arr.ndim)[::-1])` "
-                "(compatible with the Array API) or `arr.transpose()` "
-                "should be used instead.",
-                ndim) < 0) {
+                "`arr.transpose()` or `.mT` (which swaps the last "
+                "two axes only) should be used instead."
+                "(Deprecated NumPy 2.3)", ndim) < 0) {
             return NULL;
         }
     }
diff --git a/numpy/_core/src/multiarray/scalartypes.c.src b/numpy/_core/src/multiarray/scalartypes.c.src
@@ -1910,13 +1910,14 @@ gentype_flat_get(PyObject *self, void *NPY_UNUSED(ignored))
 static PyObject *
 gentype_transpose_get(PyObject *self, void *NPY_UNUSED(ignored))
 {
-    if (PyErr_WarnEx(PyExc_UserWarning,
+    /* Deprecated 2025-04-19, NumPy 2.3 */
+    if (DEPRECATE(
             "In the future `.T` property for array scalars will "
             "raise an error. If you call `.T` on an array scalar "
             "intentionally you can safely drop it. In other cases "
-            "`np.permute_dims(arr, range(arr.ndim)[::-1])` "
-            "(compatible with the Array API) or `arr.transpose()` "
-            "should be used instead.", 1) < 0) {
+            "`arr.transpose()` or `.mT` (which swaps the last "
+            "two axes only) should be used instead. "
+            "(Deprecated NumPy 2.3)") < 0) {
         return NULL;
     }
     Py_INCREF(self);
diff --git a/numpy/_core/tests/test_deprecations.py b/numpy/_core/tests/test_deprecations.py
@@ -5,24 +5,13 @@
 """
 import warnings
 import pytest
-import tempfile
 import re
 
 import numpy as np
-from numpy.testing import (
-    assert_raises, assert_warns, assert_, assert_array_equal, SkipTest,
-    KnownFailureException, break_cycles, temppath
-    )
+from numpy.testing import assert_raises, temppath
 
-from numpy._core._multiarray_tests import fromstring_null_term_c_api
 import numpy._core._struct_ufunc_tests as struct_ufunc
 
-try:
-    import pytz
-    _has_pytz = True
-except ImportError:
-    _has_pytz = False
-
 
 class _DeprecationTestCase:
     # Just as warning: warnings uses re.match, so the start of this message
@@ -47,7 +36,8 @@ def setup_method(self):
     def teardown_method(self):
         self.warn_ctx.__exit__()
 
-    def assert_deprecated(self, function, num=1, ignore_others=False,
+    def assert_deprecated(self, function, num=1, msg_patterns=None,
+                          ignore_others=False,
                           function_fails=False,
                           exceptions=np._NoValue,
                           args=(), kwargs={}):
@@ -65,6 +55,11 @@ def assert_deprecated(self, function, num=1, ignore_others=False,
             The function to test
         num : int
             Number of DeprecationWarnings to expect. This should normally be 1.
+        msg_patterns : str or tuple of str
+            Patterns for which warning messages should match. For `str` each
+            warning should match to the same pattern. For a tuple of `str`
+            each warning should match against the corresponding pattern.
+            For `None` this check is skipped.
         ignore_others : bool
             Whether warnings of the wrong type should be ignored (note that
             the message is not checked)
@@ -96,6 +91,14 @@ def assert_deprecated(self, function, num=1, ignore_others=False,
         # just in case, clear the registry
         num_found = 0
         for warning in self.log:
+            if msg_patterns is not None:
+                pattern = (msg_patterns if isinstance(msg_patterns, str) else
+                           msg_patterns[num_found])
+                msg = warning.message.args[0]
+                if re.match(pattern, msg) is None:
+                    raise AssertionError(
+                        "expected %s warning message pattern but got: %s" %
+                        (pattern, msg))
             if warning.category is self.warning_cls:
                 num_found += 1
             elif not ignore_others:
@@ -145,9 +148,17 @@ def test_assert_deprecated(self):
                       lambda: None)
 
         def foo():
+            warnings.warn("foo bar", category=DeprecationWarning,
+                          stacklevel=2)
+
+        def foo_many():
             warnings.warn("foo", category=DeprecationWarning, stacklevel=2)
+            warnings.warn("bar", category=DeprecationWarning, stacklevel=2)
 
         test_case_instance.assert_deprecated(foo)
+        test_case_instance.assert_deprecated(foo, msg_patterns="foo")
+        test_case_instance.assert_deprecated(foo_many, num=2,
+                                             msg_patterns=("foo", "^bar$"))
         test_case_instance.teardown_method()
 
 
@@ -456,15 +467,18 @@ def test_deprecated(self):
         )
 
 
-def test_deprecated_T_non_2dim():
+class TestDeprecatedTNon2Dim(_DeprecationTestCase):
     # Deprecated in Numpy 2.3, 2025-04
-    with pytest.warns(UserWarning, match="In the future `.T` property for "
-                      "array scalars will raise an error."):
-        np.int64(1).T
-    for shape in [(5,), (2, 3, 4)]:
-        with pytest.warns(
-                UserWarning,
-                match="In the future `.T` property will be "
-                      "supported for 2-dim arrays only. "
-                      f"Received {len(shape)}-dim array."):
-            np.ones(shape).T
+    def test_deprecated(self):
+        self.assert_deprecated(
+            lambda: np.int64(1).T,
+            msg_patterns="In the future `.T` property for "
+                         "array scalars will raise an error."
+        )
+        for shape in [(5,), (2, 3, 4)]:
+            self.assert_deprecated(
+                lambda: np.ones(shape).T,
+                msg_patterns="In the future `.T` property will be "
+                             "supported for 2-dim arrays only. "
+                             f"Received {len(shape)}-dim array."
+            )

Original file line number	Diff line number	Diff line change
`@@ -850,13 +850,13 @@ array_transpose_get(PyArrayObject self, void NPY_UNUSED(ignored))`
`850`	`850`	`{`
`851`	`851`	`int ndim = PyArray_NDIM(self);`
`852`	`852`	`if (ndim != 2) {`
`853`		`- if (PyErr_WarnFormat(PyExc_UserWarning, 1,`
	`853`	`+ /* Deprecated 2025-04-19, NumPy 2.3 */`
	`854`	`+ if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,`
`854`	`855`	"In the future `.T` property will be supported for "
`855`	`856`	`"2-dim arrays only. Received %d-dim array. Either "`
`856`		- "`np.permute_dims(arr, range(arr.ndim)[::-1])` "
`857`		- "(compatible with the Array API) or `arr.transpose()` "
`858`		`- "should be used instead.",`
`859`		`- ndim) < 0) {`
	`857`	+ "`arr.transpose()` or `.mT` (which swaps the last "
	`858`	`+ "two axes only) should be used instead."`
	`859`	`+ "(Deprecated NumPy 2.3)", ndim) < 0) {`
`860`	`860`	`return NULL;`
`861`	`861`	`}`
`862`	`862`	`}`