DEPR: Deprecate tupleize_cols in read_csv

xref pandas-devgh-17060.

Author: gfyoung

doc/source/io.rst

@@ -343,6 +343,10 @@ dialect : str or :class:`python:csv.Dialect` instance, default ``None``
   override values, a ParserWarning will be issued. See :class:`python:csv.Dialect`
   documentation for more details.
 tupleize_cols : boolean, default ``False``
+    .. deprecated:: 0.21.0
+
+    This argument will be removed and will always convert to MultiIndex
+
   Leave a list of tuples on columns as is (default is to convert to a MultiIndex
   on the columns).
 

doc/source/whatsnew/v0.21.0.txt

@@ -716,6 +716,7 @@ Deprecations
 
 - :func:`read_excel()` has deprecated ``sheetname`` in favor of ``sheet_name`` for consistency with ``.to_excel()`` (:issue:`10559`).
 - :func:`read_excel()` has deprecated ``parse_cols`` in favor of ``usecols`` for consistency with :func:`read_csv` (:issue:`4988`)
+- :func:`read_csv()` has deprecated the ``tupleize_cols`` argument (:issue:`17060`)
 - The ``convert`` parameter has been deprecated in the ``.take()`` method, as it was not being respected (:issue:`16948`)
 - ``pd.options.html.border`` has been deprecated in favor of ``pd.options.display.html.border`` (:issue:`15793`).
 - :func:`SeriesGroupBy.nth` has deprecated ``True`` in favor of ``'all'`` for its kwarg ``dropna`` (:issue:`11038`).

pandas/io/parsers.py

@@ -260,8 +260,11 @@
     override values, a ParserWarning will be issued. See csv.Dialect
     documentation for more details.
 tupleize_cols : boolean, default False
+    .. deprecated:: 0.21.0
+       This argument will be removed and will always convert to MultiIndex
+
     Leave a list of tuples on columns as is (default is to convert to
-    a Multi Index on the columns)
+    a MultiIndex on the columns)
 error_bad_lines : boolean, default True
     Lines with too many fields (e.g. a csv line with too many commas) will by
     default cause an exception to be raised, and no DataFrame will be returned.
@@ -510,6 +513,7 @@ def _read(filepath_or_buffer, kwds):
     'buffer_lines': None,
     'error_bad_lines': True,
     'warn_bad_lines': True,
+    'tupleize_cols': False,
     'float_precision': None
 }
 
@@ -529,6 +533,7 @@ def _read(filepath_or_buffer, kwds):
     'buffer_lines',
     'compact_ints',
     'use_unsigned',
+    'tupleize_cols'
 }
 
 
@@ -962,6 +967,9 @@ def _clean_options(self, options, engine):
 
             if arg == 'as_recarray':
                 msg += ' Please call pd.to_csv(...).to_records() instead.'
+            elif arg == 'tupleize_cols':
+                msg += (' Column tuples will then '
+                        'always be converted to MultiIndex')
 
             if result.get(arg, parser_default) != parser_default:
                 depr_warning += msg + '\n\n'

pandas/tests/io/parser/header.py

@@ -105,13 +105,13 @@ def test_header_multi_index(self):
 R_l0_g4,R_l1_g4,R4C0,R4C1,R4C2
 """
 
-        df = self.read_csv(StringIO(data), header=[0, 1, 2, 3], index_col=[
-            0, 1], tupleize_cols=False)
+        df = self.read_csv(StringIO(data), header=[0, 1, 2, 3],
+                           index_col=[0, 1])
         tm.assert_frame_equal(df, expected)
 
         # skipping lines in the header
-        df = self.read_csv(StringIO(data), header=[0, 1, 2, 3], index_col=[
-            0, 1], tupleize_cols=False)
+        df = self.read_csv(StringIO(data), header=[0, 1, 2, 3],
+                           index_col=[0, 1])
         tm.assert_frame_equal(df, expected)
 
         # INVALID OPTIONS
@@ -121,25 +121,22 @@ def test_header_multi_index(self):
                 FutureWarning, check_stacklevel=False):
             pytest.raises(ValueError, self.read_csv,
                           StringIO(data), header=[0, 1, 2, 3],
-                          index_col=[0, 1], as_recarray=True,
-                          tupleize_cols=False)
+                          index_col=[0, 1], as_recarray=True)
 
         # names
         pytest.raises(ValueError, self.read_csv,
                       StringIO(data), header=[0, 1, 2, 3],
-                      index_col=[0, 1], names=['foo', 'bar'],
-                      tupleize_cols=False)
+                      index_col=[0, 1], names=['foo', 'bar'])
 
         # usecols
         pytest.raises(ValueError, self.read_csv,
                       StringIO(data), header=[0, 1, 2, 3],
-                      index_col=[0, 1], usecols=['foo', 'bar'],
-                      tupleize_cols=False)
+                      index_col=[0, 1], usecols=['foo', 'bar'])
 
         # non-numeric index_col
         pytest.raises(ValueError, self.read_csv,
                       StringIO(data), header=[0, 1, 2, 3],
-                      index_col=['foo', 'bar'], tupleize_cols=False)
+                      index_col=['foo', 'bar'])
 
     def test_header_multiindex_common_format(self):
 

pandas/tests/io/parser/python_parser_only.py

@@ -232,9 +232,7 @@ def test_none_delimiter(self):
         result = self.read_csv(StringIO(data), header=0,
                                sep=None,
                                error_bad_lines=False,
-                               warn_bad_lines=True,
-                               engine='python',
-                               tupleize_cols=True)
+                               warn_bad_lines=True)
         tm.assert_frame_equal(result, expected)
 
     def test_skipfooter_bad_row(self):

pandas/tests/io/parser/test_unsupported.py

@@ -136,6 +136,7 @@ def test_deprecated_args(self):
             'buffer_lines': True,
             'compact_ints': True,
             'use_unsigned': True,
+            'tupleize_cols': True,
             'skip_footer': 1,
         }