Remove mlab.rec2csv

dstansby · dstansby · commit f882efd62d3a · 2018-09-29T11:05:07.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
@@ -39,4 +39,5 @@ in Matplotlib 2.2 has been removed. See below for a list:
 - `mlab.poly_between`
 - `mlab.poly_below`
 - `mlab.inside_poly`
+- `mlab.rec2csv` (use numpy.recarray.tofile instead)
 - `mlab.donothing_callback`
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -2441,78 +2441,6 @@ def format(item, just_pad_prec_spacer):
     return text
 
 
-@cbook.deprecated("2.2", alternative='numpy.recarray.tofile')
-def rec2csv(r, fname, delimiter=',', formatd=None, missing='',
-            missingd=None, withheader=True):
-    """
-    Save the data from numpy recarray *r* into a
-    comma-/space-/tab-delimited file.  The record array dtype names
-    will be used for column headers.
-
-    *fname*: can be a filename or a file handle.  Support for gzipped
-      files is automatic, if the filename ends in '.gz'
-
-    *withheader*: if withheader is False, do not write the attribute
-      names in the first row
-
-    for formatd type FormatFloat, we override the precision to store
-    full precision floats in the CSV file
-
-    See Also
-    --------
-    :func:`csv2rec`
-        For information about *missing* and *missingd*, which can be used to
-        fill in masked values into your CSV file.
-    """
-
-    delimiter = str(delimiter)
-
-    if missingd is None:
-        missingd = dict()
-
-    def with_mask(func):
-        def newfunc(val, mask, mval):
-            if mask:
-                return mval
-            else:
-                return func(val)
-        return newfunc
-
-    if r.ndim != 1:
-        raise ValueError('rec2csv only operates on 1 dimensional recarrays')
-
-    formatd = get_formatd(r, formatd)
-    funcs = []
-    for i, name in enumerate(r.dtype.names):
-        funcs.append(with_mask(csvformat_factory(formatd[name]).tostr))
-
-    fh, opened = cbook.to_filehandle(fname, 'wb', return_opened=True)
-    writer = csv.writer(fh, delimiter=delimiter)
-    header = r.dtype.names
-    if withheader:
-        writer.writerow(header)
-
-    # Our list of specials for missing values
-    mvals = []
-    for name in header:
-        mvals.append(missingd.get(name, missing))
-
-    ismasked = False
-    if len(r):
-        row = r[0]
-        ismasked = hasattr(row, '_fieldmask')
-
-    for row in r:
-        if ismasked:
-            row, rowmask = row.item(), row._fieldmask.item()
-        else:
-            rowmask = [False] * len(row)
-        writer.writerow([func(val, mask, mval) for func, val, mask, mval
-                         in zip(funcs, row, rowmask, mvals)])
-    if opened:
-        fh.close()
-
-
 class GaussianKDE(object):
     """
     Representation of a kernel-density estimate using Gaussian kernels.
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -235,7 +235,7 @@
     frange,
     identity, ispower2, isvector, l1norm,
     l2norm, log2, movavg, norm_flat,
-    rec2csv, rec_append_fields, rec_drop_fields, rec_join, rms_flat,
+    rec_append_fields, rec_drop_fields, rec_join, rms_flat,
     window_hanning, window_none)
 
 from matplotlib import cbook, mlab, pyplot as plt
diff --git a/lib/matplotlib/tests/test_mlab.py b/lib/matplotlib/tests/test_mlab.py
@@ -150,32 +150,6 @@ def tempcsv():
         yield fd
 
 
-def test_recarray_csv_roundtrip(tempcsv):
-    expected = np.recarray((99,), [('x', float), ('y', float), ('t', float)])
-    # initialising all values: uninitialised memory sometimes produces
-    # floats that do not round-trip to string and back.
-    expected['x'][:] = np.linspace(-1e9, -1, 99)
-    expected['y'][:] = np.linspace(1, 1e9, 99)
-    expected['t'][:] = np.linspace(0, 0.01, 99)
-    with pytest.warns(MatplotlibDeprecationWarning):
-        mlab.rec2csv(expected, tempcsv)
-        tempcsv.seek(0)
-        actual = mlab.csv2rec(tempcsv)
-
-    assert_allclose(expected['x'], actual['x'])
-    assert_allclose(expected['y'], actual['y'])
-    assert_allclose(expected['t'], actual['t'])
-
-
-def test_rec2csv_bad_shape_ValueError(tempcsv):
-    bad = np.recarray((99, 4), [('x', float), ('y', float)])
-
-    # the bad recarray should trigger a ValueError for having ndim > 1.
-    with pytest.warns(MatplotlibDeprecationWarning):
-        with pytest.raises(ValueError):
-            mlab.rec2csv(bad, tempcsv)
-
-
 def test_csv2rec_names_with_comments(tempcsv):
 
     tempcsv.write('# comment\n1,2,3\n4,5,6\n')
