How to save XLSM file with Macro, using openpyxl
I have .xlsm file with a Macro function. I'm loading it using openpyxl and write some data to the file and finally want to save as a different .xlsm file.
To save the file as XLSM file I have used below code in my Python script.
wb.save('testsave.xlsm');
But I cannot open that file if I saved as above. But if I saved it as .xlsx then I can open the file without the Macro function that original file had.
I want to open a Excel sheet that has Macro function, edit the file and save it as new .xlsm file using openpyxl. How can I do that?
For me this worked, together with version openpyxl==2.3.0-b2
wb = load_workbook(filename='original.xlsm', read_only=False, keep_vba=True)
..
wb.save('outfile.xlsm')
It is also mentioend in the documentation here: http://openpyxl.readthedocs.org/en/latest/usage.html?highlight=keep_vba#write-a-workbook-from-xltm-as-xlsm
I don't know if this is still relevant for the person that asked the question, but I am dealing with the same problem and found a possible solution.
- open the original file (say:
1.xlsm
) and do magic with openpyxl; - save as
2.xlsx
; - both files are actually zipped files: extract them to a temporary directory;
- copy files from the directory of the original file to the directory of the
xlsx
files: one of the files is the macro (vbaProject.bin
) and 2 of the files are necessary because they describe the type of the file among other things; - put all of the files that belong to the
xlsx
directory back into a zip file and rename this fromzip
toxlsm
. This file contains the original macro and has been edited withopenpyxl
; - (Optional) delete the two temporary directories and the
2.xlsx
file.
Example code:
import openpyxl
import zipfile
from shutil import copyfile
from shutil import rmtree
import os
PAD = os.getcwd()
wb = openpyxl.load_workbook('1.xlsm')
#####
# do magic with openpyxl here and save
ws = wb.worksheets[0]
ws.cell(row=2, column=3).value = 'Edited' # example
#####
wb.save('2.xlsx')
with zipfile.ZipFile('1.xlsm', 'r') as z:
z.extractall('./xlsm/')
with zipfile.ZipFile('2.xlsx', 'r') as z:
z.extractall('./xlsx/')
copyfile('./xlsm/[Content_Types].xml','./xlsx/[Content_Types].xml')
copyfile('./xlsm/xl/_rels/workbook.xml.rels','./xlsx/xl/_rels/workbook.xml.rels')
copyfile('./xlsm/xl/vbaProject.bin','./xlsx/xl/vbaProject.bin')
z = zipfile.ZipFile('2.zip', 'w')
os.chdir('./xlsx')
for root, dirs, files in os.walk('./'):
for file in files:
z.write(os.path.join(root, file))
z.close()
#clean
os.chdir(PAD)
rmtree('./xlsm/')
rmtree('./xlsx/')
os.remove('./2.xlsx')
os.rename('2.zip', '2.xlsm')
I had the same issue when editing xlsm files using openpyxl. I tried most of the solutions/workarounds available in stackoverflow and in other forums. But none of them worked. Then I found xlwings, this python library handles xlsm document, it preserve all the macros.
import xlwings as xw
wb = xw.Book('macro_xl.xlsm')
sheet = wb.sheets['Sheet1']
sheet.range('A1').value = 'From Script'
wb.save('result_file_name.xlsm')
That's right, openpyxl cannot read and write VBA code.
According to this thread:
I think you should not give the xlsM extension, because the file will contain no VBA code. openpyxl is used to build xlsX files only.
Give a try to this fork instead: if you pass keep_vba=True
parameter to load_workbook
it should do the job.
Hope that helps.