API: Update lib.shape_base namespace

mtsokol · mtsokol · commit e03d8ff35985 · 2023-08-30T20:11:08.000+02:00
diff --git a/numpy/__init__.py b/numpy/__init__.py
@@ -183,19 +183,13 @@
 
     from . import lib
     from .lib import (
-        DataSource, apply_along_axis, apply_over_axes,
-        array_split, c_, column_stack, diag_indices,
-        diag_indices_from, dsplit, dstack,
-        emath, expand_dims, fill_diagonal,
-        fromregex, get_array_wrap, genfromtxt,
-        hsplit, index_exp, ix_, kron, load, loadtxt,
-        mgrid, ndenumerate, ndindex, ogrid, 
+        DataSource, c_, diag_indices, diag_indices_from, emath, 
+        fromregex, genfromtxt, index_exp, ix_, load, loadtxt,
+        mgrid, ndenumerate, ndindex, ogrid, fill_diagonal,
         packbits, poly, poly1d, polyadd, polyder,
         polydiv, polyfit, polyint, polymul, polysub, polyval,
-        put_along_axis, r_, ravel_multi_index,
-        roots, row_stack, s_, save, savetxt, savez, 
-        savez_compressed, split, take_along_axis, tile, 
-        unpackbits, unravel_index, vsplit
+        r_, ravel_multi_index, roots, s_, save, savetxt, savez, 
+        savez_compressed, unpackbits, unravel_index
     )
     from .lib._histograms_impl import (
         histogram, histogram_bin_edges, histogramdd
@@ -217,6 +211,11 @@
         histogram2d, mask_indices, tril_indices, tril_indices_from, 
         triu_indices, triu_indices_from
     )
+    from .lib._shape_base_impl import (
+        apply_over_axes, apply_along_axis, array_split, column_stack, dsplit,
+        dstack, expand_dims, hsplit, kron, put_along_axis, row_stack, split,
+        take_along_axis, tile, vsplit
+    )
     from .lib._type_check_impl import (
         iscomplexobj, isrealobj, imag, iscomplex, isreal, nan_to_num, real, 
         real_if_close, typename, mintypecode, common_type
@@ -296,6 +295,7 @@
         set(lib._nanfunctions_impl.__all__) |
         set(lib._function_base_impl.__all__) |
         set(lib._twodim_base_impl.__all__) |
+        set(lib._shape_base_impl.__all__) |
         set(lib._type_check_impl.__all__) |
         set(lib._arraysetops_impl.__all__) |
         set(lib._ufunclike_impl.__all__) |
diff --git a/numpy/__init__.pyi b/numpy/__init__.pyi
@@ -517,7 +517,7 @@ from numpy.lib.polynomial import (
     polyfit as polyfit,
 )
 
-from numpy.lib.shape_base import (
+from numpy.lib._shape_base_impl import (
     column_stack as column_stack,
     row_stack as row_stack,
     dstack as dstack,
@@ -531,7 +531,6 @@ from numpy.lib.shape_base import (
     apply_along_axis as apply_along_axis,
     kron as kron,
     tile as tile,
-    get_array_wrap as get_array_wrap,
     take_along_axis as take_along_axis,
     put_along_axis as put_along_axis,
 )
diff --git a/numpy/_expired_attrs_2_0.py b/numpy/_expired_attrs_2_0.py
@@ -65,5 +65,6 @@
         "`scalar_types` argument, use `numpy.result_type` and pass the "
         "Python values `0`, `0.0`, or `0j`.",
     "round_": "Use `np.round` instead.",
-    "nbytes": "Use `np.dtype(<dtype>).itemsize` instead."   
+    "nbytes": "Use `np.dtype(<dtype>).itemsize` instead.",
+    "get_array_wrap": "",
 }
diff --git a/numpy/core/tests/test_deprecations.py b/numpy/core/tests/test_deprecations.py
@@ -752,7 +752,7 @@ def test_lib_functions_deprecation_call(self):
         from numpy.lib._utils_impl import safe_eval
         from numpy.lib.npyio import recfromcsv, recfromtxt
         from numpy.lib._function_base_impl import disp
-        from numpy.lib.shape_base import get_array_wrap
+        from numpy.lib._shape_base_impl import get_array_wrap
         from numpy.core.numerictypes import maximum_sctype
         from numpy.lib.tests.test_io import TextIO
         
diff --git a/numpy/lib/__init__.py b/numpy/lib/__init__.py
@@ -23,8 +23,8 @@
 from . import index_tricks
 from . import _nanfunctions_impl
 from . import _function_base_impl
-from . import shape_base
 from . import _stride_tricks_impl
+from . import _shape_base_impl
 from . import stride_tricks
 from . import _twodim_base_impl
 from . import _ufunclike_impl
@@ -33,12 +33,12 @@
 from . import _utils_impl
 from . import _arraysetops_impl
 from . import npyio
+from . import stride_tricks
 from . import arrayterator
 from . import _arraypad_impl
 from . import _version
 
 from .index_tricks import *
-from .shape_base import *
 from .polynomial import *
 from .npyio import *
 from .arrayterator import Arrayterator
@@ -49,7 +49,6 @@
 
 __all__ = ['emath']
 __all__ += index_tricks.__all__
-__all__ += shape_base.__all__
 __all__ += polynomial.__all__
 __all__ += npyio.__all__
 
@@ -70,7 +69,8 @@ def __getattr__(attr):
         return math
     elif attr in (
         "histograms", "type_check", "nanfunctions", "function_base", 
-        "arraypad", "arraysetops", "ufunclike", "utils", "twodim_base"
+        "arraypad", "arraysetops", "ufunclike", "utils", "twodim_base",
+        "shape_base"
     ):
         raise AttributeError(
             f"`np.lib.{attr}` is now private. If you are using a public "
diff --git a/numpy/lib/__init__.pyi b/numpy/lib/__init__.pyi
@@ -70,25 +70,6 @@ from numpy.lib.polynomial import (
     poly1d as poly1d,
 )
 
-from numpy.lib.shape_base import (
-    column_stack as column_stack,
-    row_stack as row_stack,
-    dstack as dstack,
-    array_split as array_split,
-    split as split,
-    hsplit as hsplit,
-    vsplit as vsplit,
-    dsplit as dsplit,
-    apply_over_axes as apply_over_axes,
-    expand_dims as expand_dims,
-    apply_along_axis as apply_along_axis,
-    kron as kron,
-    tile as tile,
-    get_array_wrap as get_array_wrap,
-    take_along_axis as take_along_axis,
-    put_along_axis as put_along_axis,
-)
-
 from numpy.core.multiarray import (
     add_docstring as add_docstring,
     tracemalloc_domain as tracemalloc_domain,
diff --git a/numpy/lib/_shape_base_impl.py b/numpy/lib/_shape_base_impl.py
@@ -16,7 +16,7 @@
 __all__ = [
     'column_stack', 'row_stack', 'dstack', 'array_split', 'split',
     'hsplit', 'vsplit', 'dsplit', 'apply_over_axes', 'expand_dims',
-    'apply_along_axis', 'kron', 'tile', 'get_array_wrap', 'take_along_axis',
+    'apply_along_axis', 'kron', 'tile', 'take_along_axis',
     'put_along_axis'
     ]
 
@@ -1039,8 +1039,19 @@ def dsplit(ary, indices_or_sections):
 def get_array_prepare(*args):
     """Find the wrapper for the array with the highest priority.
 
-    In case of ties, leftmost wins. If no wrapper is found, return None
+    In case of ties, leftmost wins. If no wrapper is found, return None.
+
+    .. deprecated:: 2.0
     """
+
+    # Deprecated in NumPy 2.0, 2023-08-28
+    warnings.warn(
+        "`get_array_prepare` is deprecated. "
+        "(deprecated in NumPy 2.0)",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     wrappers = sorted((getattr(x, '__array_priority__', 0), -i,
                  x.__array_prepare__) for i, x in enumerate(args)
                                    if hasattr(x, '__array_prepare__'))
diff --git a/numpy/lib/_shape_base_impl.pyi b/numpy/lib/_shape_base_impl.pyi
diff --git a/numpy/lib/tests/test_shape_base.py b/numpy/lib/tests/test_shape_base.py
@@ -3,12 +3,12 @@
 import sys
 import pytest
 
-from numpy.exceptions import AxisError
-from numpy.lib.shape_base import (
+from numpy import (
     apply_along_axis, apply_over_axes, array_split, split, hsplit, dsplit,
     vsplit, dstack, column_stack, kron, tile, expand_dims, take_along_axis,
     put_along_axis
     )
+from numpy.exceptions import AxisError
 from numpy.testing import (
     assert_, assert_equal, assert_array_equal, assert_raises, assert_warns
     )
diff --git a/numpy/testing/tests/test_utils.py b/numpy/testing/tests/test_utils.py
@@ -1351,7 +1351,7 @@ def warn(arr):
         sup.record(UserWarning)
         # suppress warning from other module (may have .pyc ending),
         # if apply_along_axis is moved, had to be changed.
-        sup.filter(module=np.lib.shape_base)
+        sup.filter(module=np.lib._shape_base_impl)
         warnings.warn("Some warning")
         warn_other_module()
     # Check that the suppression did test the file correctly (this module
diff --git a/numpy/tests/test_public_api.py b/numpy/tests/test_public_api.py
@@ -35,7 +35,6 @@ def test_numpy_namespace():
     # NumPy namespace (some are useful though, others need to be cleaned up)
     undocumented = {
         'compare_chararrays': 'numpy.core._multiarray_umath.compare_chararrays',
-        'get_array_wrap': 'numpy.lib.shape_base.get_array_wrap',
         'show_config': 'numpy.__config__.show',
     }
     # We override dir to not show these members
@@ -197,7 +196,6 @@ def test_NPY_NO_EXPORT():
     "lib.index_tricks",
     "lib.npyio",
     "lib.polynomial",
-    "lib.shape_base",
     "lib.user_array",  # note: not in np.lib, but probably should just be deleted
     "linalg.lapack_lite",
     "linalg.linalg",
diff --git a/numpy/typing/tests/data/reveal/shape_base.pyi b/numpy/typing/tests/data/reveal/shape_base.pyi
@@ -43,9 +43,6 @@ reveal_type(np.vsplit(AR_LIKE_f8, [3, 5, 6, 10]))  # E: list[ndarray[Any, dtype[
 reveal_type(np.dsplit(AR_i8, [3, 5, 6, 10]))  # E: list[ndarray[Any, dtype[{int64}]]]
 reveal_type(np.dsplit(AR_LIKE_f8, [3, 5, 6, 10]))  # E: list[ndarray[Any, dtype[Any]]]
 
-reveal_type(np.lib.shape_base.get_array_prepare(AR_i8))  # E: lib.shape_base._ArrayPrepare
-reveal_type(np.lib.shape_base.get_array_prepare(AR_i8, 1))  # E: Union[None, lib.shape_base._ArrayPrepare]
-
 reveal_type(np.kron(AR_b, AR_b))  # E: ndarray[Any, dtype[bool_]]
 reveal_type(np.kron(AR_b, AR_i8))  # E: ndarray[Any, dtype[signedinteger[Any]]]
 reveal_type(np.kron(AR_f8, AR_f8))  # E: ndarray[Any, dtype[floating[Any]]]

Original file line number	Diff line number	Diff line change
`@@ -65,5 +65,6 @@`
`65`	`65`	"`scalar_types` argument, use `numpy.result_type` and pass the "
`66`	`66`	"Python values `0`, `0.0`, or `0j`.",
`67`	`67`	"round_": "Use `np.round` instead.",
`68`		- "nbytes": "Use `np.dtype(<dtype>).itemsize` instead."
	`68`	+ "nbytes": "Use `np.dtype(<dtype>).itemsize` instead.",
	`69`	`+ "get_array_wrap": "",`
`69`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,12 @@`
`3`	`3`	`import sys`
`4`	`4`	`import pytest`
`5`	`5`
`6`		`-from numpy.exceptions import AxisError`
`7`		`-from numpy.lib.shape_base import (`
	`6`	`+from numpy import (`
`8`	`7`	`apply_along_axis, apply_over_axes, array_split, split, hsplit, dsplit,`
`9`	`8`	`vsplit, dstack, column_stack, kron, tile, expand_dims, take_along_axis,`
`10`	`9`	`put_along_axis`
`11`	`10`	`)`
	`11`	`+from numpy.exceptions import AxisError`
`12`	`12`	`from numpy.testing import (`
`13`	`13`	`assert_, assert_equal, assert_array_equal, assert_raises, assert_warns`
`14`	`14`	`)`