summaryrefslogtreecommitdiff
path: root/numpy/tests/test_public_api.py
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2019-09-08 11:57:31 -0700
committerRalf Gommers <ralf.gommers@gmail.com>2019-09-19 08:57:52 +0200
commitd072f12354d1802aa6ac7a3bfa92a24fa5df613d (patch)
treef0b48f84f6378ffba8135f0e2aea904e0f17a152 /numpy/tests/test_public_api.py
parent50cbd096099d71250fa45b2d3332b0faa1341625 (diff)
downloadnumpy-d072f12354d1802aa6ac7a3bfa92a24fa5df613d.tar.gz
MAINT: add missing 'Arrayterator' to `numpy.lib.__all__`
Also finish the TODO about figuring out which np.lib.<submodule>'s are public. This is a giant mess ...
Diffstat (limited to 'numpy/tests/test_public_api.py')
-rw-r--r--numpy/tests/test_public_api.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/numpy/tests/test_public_api.py b/numpy/tests/test_public_api.py
index 4d9066fc9..2b29ea0e9 100644
--- a/numpy/tests/test_public_api.py
+++ b/numpy/tests/test_public_api.py
@@ -33,7 +33,8 @@ def check_dir(module, module_name=None):
sys.version_info[0] < 3,
reason="NumPy exposes slightly different functions on Python 2")
def test_numpy_namespace():
- # None of these objects are publicly documented.
+ # None of these objects are publicly documented to be part of the main
+ # NumPy namespace (some are useful though, others need to be cleaned up)
undocumented = {
'Tester': 'numpy.testing._private.nosetester.NoseTester',
'_add_newdoc_ufunc': 'numpy.core._multiarray_umath._add_newdoc_ufunc',
@@ -144,9 +145,8 @@ PUBLIC_MODULES = [
"f2py",
"fft",
"lib",
- "lib.format",
+ "lib.format", # was this meant to be public?
"lib.mixins",
- "lib.npyio",
"lib.recfunctions",
"lib.scimath",
"linalg",
@@ -276,7 +276,7 @@ PRIVATE_BUT_PRESENT_MODULES = [
"fft.info",
"fft.pocketfft",
"fft.pocketfft_internal",
- "lib.arraypad", # TODO: figure out which numpy.lib submodules are public
+ "lib.arraypad",
"lib.arraysetops",
"lib.arrayterator",
"lib.financial",
@@ -285,13 +285,14 @@ PRIVATE_BUT_PRESENT_MODULES = [
"lib.index_tricks",
"lib.info",
"lib.nanfunctions",
+ "lib.npyio",
"lib.polynomial",
"lib.shape_base",
"lib.stride_tricks",
"lib.twodim_base",
"lib.type_check",
"lib.ufunclike",
- "lib.user_array",
+ "lib.user_array", # note: not in np.lib, but probably should just be deleted
"lib.utils",
"linalg.info",
"linalg.lapack_lite",