将 pandas 数据框写入 xlsm 文件（启用宏的 Excel）

Question

以.xlsx 格式将pandas.DataFrame 写入Excel 工作簿非常简​​单：

import pandas as pd
df = pd.DataFrame({'firstColumn' : [5, 2, 0, 10, 4], 'secondColumn' : [9, 8, 21, 3, 8]})
print(df)
df.to_excel('test.xlsx')

给出：

   firstColumn  secondColumn
0            5             9
1            2             8
2            0            21
3           10             3
4            4             8

以及相应的 Excel 文件。

是否也可以将DataFrame 写入.xlsm Excel 文件？这实际上或多或少与.xlsx 相同，但可以在文件中存储 VBA 宏。我需要这个，因为我想在创建文件后插入并运行 VBA 宏。

但是，在常规 xlsx 文件上尝试此操作时，我会在弹出窗口中收到以下错误消息：

The following features cannot be saved in macro-free workbooks: VB project.
To save a file with these features, click No, and then choose a macro-enabled file type in the File Type list.
To continue saving as macro-free workbook, click Yes.

然后我可以手动选择将文件保存为.xlsm，其中将包含我的宏。但是，我更愿意自动执行此操作而无需额外步骤。

documentation for the to_excel method 表明这应该是可能的（参见engine 参数）。但是，我不明白如何启用它。

当我简单地将输出文件名更改为*.xlsm 时，会创建一个.xlsx 文件，命名 .xlsm。当我尝试打开它时，我得到了

Excel cannot open the file 'myFilename.xlsm' because the file format or file extension is not valid. Verify that the file has not been corrupted and that the file extension matches the format of the file.

如果我手动将扩展名更改为.xlsx，我可以再次打开它。

关于this part of the pandas documentation：

openpyxl：这包括对 OpenPyxl 1.6.1 直至但不包括 2.0.0 的稳定支持，以及对 OpenPyxl 2.0.0 及更高版本的实验性支持。`

我的Openpyxl 版本是1.8.6。更新到 2.1.4 并没有解决问题。也没有将 XlsxWriter 从 0.63 更新到 0.6.6。

按照建议使用df.to_excel('test.xlsx', engine='openpyxl')也没有解决问题。

Answer 1

Pandas 要求工作簿名称以 .xls 或 .xlsx 结尾。它使用扩展来选择使用哪个 Excel 引擎。

您可以传递一个临时名称，然后用以下内容覆盖它：

import pandas as pd

df = pd.DataFrame({'First' : [5, 2, 0, 10, 4], 
                   'Second' : [9, 8, 21, 3, 8]})

writer = pd.ExcelWriter('test.xlsx', engine='xlsxwriter')

df.to_excel(writer, sheet_name='Sheet1')

workbook  = writer.book
workbook.filename = 'test.xlsm'
# !! Won't load in Excel !!

writer.save()

这将创建一个扩展名为 .xlsm 的 Excel 文件。

但是，由于名为“扩展强化”的功能，Excel 不会打开此文件，因为它知道它不包含宏并且实际上不是xlsm 文件。 （就是您上面报告的 Excel 错误。）

您可以使用最新版本的 XlsxWriter 解决此问题，方法是从真正的 xlsm 文件中提取 VbaProject.bin 宏文件并将其插入到新文件中：

import pandas as pd

df = pd.DataFrame({'First' : [5, 2, 0, 10, 4], 
                   'Second' : [9, 8, 21, 3, 8]})

writer = pd.ExcelWriter('test.xlsx', engine='xlsxwriter')

df.to_excel(writer, sheet_name='Sheet1')

workbook  = writer.book
workbook.filename = 'test.xlsm'
workbook.add_vba_project('./vbaProject.bin')

writer.save()

有关详细信息，请参阅 XlsxWriter 文档的 Working with VBA Macros 部分。