Make mlab.csv2rec private

dstansby · dstansby · commit 2ca407fcfe73 · 2018-09-29T11:05:10.000+01:00
diff --git a/doc/api/next_api_changes/2018-09-18-DS.rst b/doc/api/next_api_changes/2018-09-18-DS.rst
@@ -55,6 +55,7 @@ in Matplotlib 2.2 has been removed. See below for a list:
 - ``mlab.poly_between``
 - ``mlab.poly_below``
 - ``mlab.inside_poly``
+- ``mlab.csv2rec``
 - ``mlab.rec2csv`` (use `numpy.recarray.tofile` instead)
 - ``mlab.rec2text`` (use `numpy.recarray.tofile` instead)
 - ``mlab.rec_summarize``
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1187,10 +1187,9 @@ def cohere(x, y, NFFT=256, Fs=2, detrend=detrend_none, window=window_hanning,
     return Cxy, f
 
 
-@cbook.deprecated("2.2")
-def csv2rec(fname, comments='#', skiprows=0, checkrows=0, delimiter=',',
-            converterd=None, names=None, missing='', missingd=None,
-            use_mrecords=False, dayfirst=False, yearfirst=False):
+def _csv2rec(fname, comments='#', skiprows=0, checkrows=0, delimiter=',',
+             converterd=None, names=None, missing='', missingd=None,
+             use_mrecords=False, dayfirst=False, yearfirst=False):
     """
     Load data from comma/space/tab delimited file in *fname* into a
     numpy record array and return the record array.
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -229,7 +229,6 @@
 ## We are still importing too many things from mlab; more cleanup is needed.
 
 from matplotlib.mlab import (
-    csv2rec,
     demean, detrend, detrend_linear, detrend_mean, detrend_none,
     window_hanning, window_none)
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -46,7 +46,7 @@
 from matplotlib.artist import setp as _setp
 from matplotlib.axes import Axes, Subplot
 from matplotlib.projections import PolarAxes
-from matplotlib import mlab  # for csv2rec, detrend_none, window_hanning
+from matplotlib import mlab  # for _csv2rec, detrend_none, window_hanning
 from matplotlib.scale import get_scale_docs, get_scale_names
 
 from matplotlib import cm
@@ -2231,8 +2231,7 @@ def plotfile(fname, cols=(0,), plotfuncs=None,
     columns.
 
     *comments*, *skiprows*, *checkrows*, *delimiter*, and *names*
-    are all passed on to :func:`matplotlib.mlab.csv2rec` to
-    load the data into a record array.
+    are all used when loading the data into a record array.
 
     If *newfig* is *True*, the plot always will be made in a new figure;
     if *False*, it will be made in the current figure if one exists,
@@ -2267,8 +2266,9 @@ def plotfile(fname, cols=(0,), plotfuncs=None,
     from matplotlib.cbook import MatplotlibDeprecationWarning
     with warnings.catch_warnings():
         warnings.simplefilter('ignore', MatplotlibDeprecationWarning)
-        r = mlab.csv2rec(fname, comments=comments, skiprows=skiprows,
-                         checkrows=checkrows, delimiter=delimiter, names=names)
+        r = mlab._csv2rec(fname, comments=comments, skiprows=skiprows,
+                          checkrows=checkrows, delimiter=delimiter,
+                          names=names)
 
     def getname_val(identifier):
         'return the name and column data for identifier'
diff --git a/lib/matplotlib/tests/test_mlab.py b/lib/matplotlib/tests/test_mlab.py
@@ -151,11 +151,9 @@ def tempcsv():
 
 
 def test_csv2rec_names_with_comments(tempcsv):
-
     tempcsv.write('# comment\n1,2,3\n4,5,6\n')
     tempcsv.seek(0)
-    with pytest.warns(MatplotlibDeprecationWarning):
-        array = mlab.csv2rec(tempcsv, names='a,b,c')
+    array = mlab._csv2rec(tempcsv, names='a,b,c')
     assert len(array) == 2
     assert len(array.dtype) == 3
 
@@ -188,8 +186,7 @@ def test_csv2rec_dates(tempcsv, input, kwargs):
                 datetime.datetime(2054, 6, 20, 14, 31, 45),
                 datetime.datetime(2000, 10, 31, 11, 50, 23)]
     tempcsv.seek(0)
-    with pytest.warns(MatplotlibDeprecationWarning):
-        array = mlab.csv2rec(tempcsv, names='a', **kwargs)
+    array = mlab._csv2rec(tempcsv, names='a', **kwargs)
     assert_array_equal(array['a'].tolist(), expected)
 
 
