rename keyword 'as_table' to 'table', and change type from boolean to string

Author: tdamsma

pandas/core/generic.py

@@ -2182,8 +2182,8 @@ def _repr_data_resource_(self):
     freeze_panes : tuple of int (length 2), optional
         Specifies the one-based bottommost row and rightmost column that
         is to be frozen.
-    as_table : boolean, default False
-        Write the dataframe as a formatted excel table object
+    table : string, default None
+        Write the dataframe to a named and formatted excel table object
 
     See Also
     --------
@@ -2249,7 +2249,7 @@ def to_excel(
         inf_rep="inf",
         verbose=True,
         freeze_panes=None,
-        as_table=False
+        table=None
     ):
         df = self if isinstance(self, ABCDataFrame) else self.to_frame()
 
@@ -2273,7 +2273,7 @@ def to_excel(
             startcol=startcol,
             freeze_panes=freeze_panes,
             engine=engine,
-            as_table=as_table
+            table=None
         )
 
     def to_json(

pandas/io/excel/_openpyxl.py

@@ -467,11 +467,20 @@ def write_cells(
                             for k, v in style_kwargs.items():
                                 setattr(xcell, k, v)
 
-    def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
-                    freeze_panes=None, header=True):
+    def write_table(
+        self,
+        cells,
+        table,
+        sheet_name=None,
+        startrow=0,
+        startcol=0,
+        freeze_panes=None,
+        header=True,
+    ):
         # Write the frame to an excel table using openpyxl.
 
         from openpyxl.worksheet.table import Table, TableStyleInfo
+
         sheet_name = self._get_sheet_name(sheet_name)
 
         if sheet_name in self.sheets:
@@ -482,8 +491,9 @@ def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
             self.sheets[sheet_name] = wks
 
         if _validate_freeze_panes(freeze_panes):
-            wks.freeze_panes = wks.cell(row=freeze_panes[0] + 1,
-                                        column=freeze_panes[1] + 1)
+            wks.freeze_panes = wks.cell(
+                row=freeze_panes[0] + 1, column=freeze_panes[1] + 1
+            )
 
         header_rows = 1 if header > 0 else 0
 
@@ -496,9 +506,7 @@ def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
                 header_cells[cell.col] = cell.val
                 continue
             wks.cell(
-                row=startrow + cell.row + 1,
-                column=startcol + cell.col + 1,
-                value=val,
+                row=startrow + cell.row + 1, column=startcol + cell.col + 1, value=val
             )
             n_cols = max(n_cols, cell.col)
             n_rows = max(n_rows, cell.row)
@@ -508,25 +516,27 @@ def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
             if col in header_cells:
                 val = str(header_cells[col])
             else:
-                val = 'Column%d' % (col + 1)
-            wks.cell(
-                row=startrow + 1,
-                column=startcol + col + 1,
-                value=val,
-            )
+                val = "Column%d" % (col + 1)
+            wks.cell(row=startrow + 1, column=startcol + col + 1, value=val)
 
-        ref = self._to_excel_range(startrow, startcol, startrow + n_rows,
-                                   startcol + n_cols)
-        tab = Table(displayName="Table1", ref=ref, headerRowCount=header_rows)
+        ref = self._to_excel_range(
+            startrow, startcol, startrow + n_rows, startcol + n_cols
+        )
+        tab = Table(displayName=table, ref=ref, headerRowCount=header_rows)
 
         # Add a default style with striped rows
         style = TableStyleInfo(
-            name="TableStyleMedium9", showFirstColumn=False,
-            showLastColumn=False, showRowStripes=True, showColumnStripes=False)
+            name="TableStyleMedium9",
+            showFirstColumn=False,
+            showLastColumn=False,
+            showRowStripes=True,
+            showColumnStripes=False,
+        )
         tab.tableStyleInfo = style
 
         wks.add_table(tab)
 
+
 class _OpenpyxlReader(_BaseExcelReader):
     def __init__(self, filepath_or_buffer: FilePathOrBuffer) -> None:
         """Reader using openpyxl engine.

pandas/io/excel/_xlsxwriter.py

@@ -236,8 +236,16 @@ def write_cells(
             else:
                 wks.write(startrow + cell.row, startcol + cell.col, val, style)
 
-    def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
-                    freeze_panes=None, header=True):
+    def write_table(
+        self,
+        cells,
+        table,
+        sheet_name=None,
+        startrow=0,
+        startcol=0,
+        freeze_panes=None,
+        header=True,
+    ):
         # Write the frame to an excel table using xlsxwriter.
         sheet_name = self._get_sheet_name(sheet_name)
 
@@ -258,18 +266,21 @@ def write_table(self, cells, sheet_name=None, startrow=0, startcol=0,
             if header and cell.row == 0:
                 header_cells[cell.col] = cell.val
                 continue
-            wks.write(startrow + cell.row,
-                      startcol + cell.col,
-                      val)
+            wks.write(startrow + cell.row, startcol + cell.col, val)
             n_cols = max(n_cols, cell.col)
             n_rows = max(n_rows, cell.row)
 
         # add generic name for every unnamed (index) column that is included
-        columns = [{'header': str(header_cells[col])
-                    if col in header_cells else 'Column%d' % (col + 1)}
-                   for col in range(n_cols + 1)]
+        columns = [
+            {
+                "header": str(header_cells[col])
+                if col in header_cells
+                else "Column%d" % (col + 1)
+            }
+            for col in range(n_cols + 1)
+        ]
+
+        options = {"columns": columns, "name": table}
 
-        options = {'columns': columns}
+        wks.add_table(startrow, startcol, startrow + n_rows, startcol + n_cols, options)
 
-        wks.add_table(startrow, startcol, startrow + n_rows,
-                      startcol + n_cols, options)

pandas/io/formats/excel.py

@@ -682,8 +682,12 @@ def _generate_body(self, coloffset):
                     xlstyle = self.style_converter(";".join(styles[i, colidx]))
                 yield ExcelCell(self.rowcounter + i, colidx + coloffset, val, xlstyle)
 
-    def get_formatted_cells(self):
-        for cell in itertools.chain(self._format_header(), self._format_body()):
+    def get_formatted_cells(self, include_header=True):
+        if include_header:
+            cells = itertools.chain(self._format_header(), self._format_body())
+        else:
+            cells = self._format_body()
+        for cell in cells:
             cell.val = self._format_value(cell.val)
             yield cell
 
@@ -695,6 +699,7 @@ def write(
         startcol=0,
         freeze_panes=None,
         engine=None,
+        table=None,
     ):
         """
         writer : string or ExcelWriter object
@@ -712,6 +717,9 @@ def write(
             write engine to use if writer is a path - you can also set this
             via the options ``io.excel.xlsx.writer``, ``io.excel.xls.writer``,
             and ``io.excel.xlsm.writer``.
+        table : string, default None
+            Write the dataframe to a named and formatted excel table object
+
         """
         from pandas.io.excel import ExcelWriter
         from pandas.io.common import _stringify_path
@@ -731,12 +739,23 @@ def write(
             need_save = True
 
         formatted_cells = self.get_formatted_cells()
-        writer.write_cells(
-            formatted_cells,
-            sheet_name,
-            startrow=startrow,
-            startcol=startcol,
-            freeze_panes=freeze_panes,
-        )
+        if table is not None:
+            writer.write_table(
+                formatted_cells,
+                sheet_name,
+                table,
+                startrow=startrow,
+                startcol=startcol,
+                freeze_panes=freeze_panes,
+                header=self.header,
+            )
+        else:
+            writer.write_cells(
+                formatted_cells,
+                sheet_name,
+                startrow=startrow,
+                startcol=startcol,
+                freeze_panes=freeze_panes,
+            )
         if need_save:
             writer.save()

pandas/tests/io/excel/test_writers.py

@@ -233,22 +233,23 @@ def test_read_excel_parse_dates(self, ext):
             )
             tm.assert_frame_equal(df, res)
 
-    def test_excel_as_table_roundtrip_indexname(self, engine, ext):
-        if ext == '.xls':
+    def test_excel_table_roundtrip_indexname(self, ext):
+        if ext == ".xls":
             pytest.skip()
         df = DataFrame(np.random.randn(10, 4))
 
         df.columns = df.columns.map(str)
-        df.index.name = 'foo'
+        df.index.name = "foo"
 
-        df.to_excel(self.path, header=True, as_table=True)
+        with ensure_clean(ext) as pth:
+            df.to_excel(pth, header=True, table='Table1')
 
-        xf = ExcelFile(self.path)
-        result = pd.read_excel(xf, xf.sheet_names[0],
-                            index_col=0)
+            xf = ExcelFile(pth)
+            result = pd.read_excel(xf, xf.sheet_names[0], index_col=0)
+
+            tm.assert_frame_equal(result, df)
+            assert result.index.name == "foo"
 
-        tm.assert_frame_equal(result, df)
-        assert result.index.name == 'foo'
 
 class _WriterBase:
     @pytest.fixture(autouse=True)
@@ -1227,22 +1228,6 @@ def test_raise_when_saving_timezones(self, engine, ext, dtype, tz_aware_fixture)
         with pytest.raises(ValueError, match="Excel does not support"):
             df.to_excel(self.path)
 
-    def test_excel_as_table_roundtrip_indexname(self, engine, ext):
-        if ext == '.xls':
-            pytest.skip()
-        df = DataFrame(np.random.randn(10, 4))
-
-        df.columns = df.columns.map(str)
-        df.index.name = 'foo'
-
-        df.to_excel(self.path, header=True, as_table=True)
-
-        xf = ExcelFile(self.path)
-        result = read_excel(xf, xf.sheet_names[0],
-                            index_col=0)
-
-        tm.assert_frame_equal(result, df)
-        assert result.index.name == 'foo'
 
 class TestExcelWriterEngineTests:
     @pytest.mark.parametrize(