- Notifications
You must be signed in to change notification settings - Fork62
Accelerated Excel XLSX Writing Library for Python 2/3
License
kz26/PyExcelerate
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Accelerated Excel XLSX writing library for Python
- Authors:Kevin Wang andKevin Zhang
- Copyright 2015 Kevin Wang, Kevin Zhang. Portions copyright Google, Inc.
- License: Simplified BSD License
- Source repository
- PyPI page
PyExcelerate is a Python for writing Excel-compatible XLSX spreadsheet files, with an emphasison speed.
Benchmark code located in pyexcelerate/tests/benchmark.py
Ubuntu 12.04 LTS, Core i5-3450, 8GB DDR3, Python 2.7.3
| TEST_NAME | NUM_ROWS | NUM_COLS | TIME_IN_SECONDS ||-----------------------------|----------|----------|-----------------|| pyexcelerate value fastest | 1000 | 100 | 0.47 || pyexcelerate value faster | 1000 | 100 | 0.51 || pyexcelerate value fast | 1000 | 100 | 1.53 || xlsxwriter value | 1000 | 100 | 0.84 || openpyxl | 1000 | 100 | 2.74 || pyexcelerate style cheating | 1000 | 100 | 1.23 || pyexcelerate style fastest | 1000 | 100 | 2.40 || pyexcelerate style faster | 1000 | 100 | 2.75 || pyexcelerate style fast | 1000 | 100 | 6.15 || xlsxwriter style cheating | 1000 | 100 | 1.21 || xlsxwriter style | 1000 | 100 | 4.85 || openpyxl | 1000 | 100 | 6.32 |* cheating refers to pregeneration of stylesPyExcelerate is supported on Python 2.7, 3.4, 3.5, 3.6, 3.7, and 3.8.
pip install pyexceleratefrompyexcelerateimportWorkbookdata= [[1,2,3], [4,5,6], [7,8,9]]# data is a 2D arraywb=Workbook()wb.new_sheet("sheet name",data=data)wb.save("output.xlsx")
PyExcelerate also permits you to write data to ranges directly, which is faster than writing cell-by-cell. If writing a Pandas DataFrame, see thenote on compatibility.
frompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("test",data=[[1,2], [3,4]])wb.save("output.xlsx")
frompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("test")ws.range("B2","C3").value= [[1,2], [3,4]]wb.save("output.xlsx")
fromdatetimeimportdatetimefrompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("sheet name")ws.set_cell_value(1,1,15)# a numberws.set_cell_value(1,2,20)ws.set_cell_value(1,3,"=SUM(A1,B1)")# a formulaws.set_cell_value(1,4,datetime.now())# a datewb.save("output.xlsx")
fromdatetimeimportdatetimefrompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("sheet name")ws[1][1].value=15# a numberws[1][2].value=20ws[1][3].value="=SUM(A1,B1)"# a formulaws[1][4].value=datetime.now()# a datewb.save("output.xlsx")
frompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("sheet name")ws.cell("A1").value=12wb.save("output.xlsx")
frompyexcelerateimportWorkbookwb=Workbook()ws=wb.new_sheet("sheet name")ws[1][1].value=15ws.range("A1","B1").merge()wb.save("output.xlsx")
Styling cells causesnon-negligible overhead. Itwill increase your execution time (up to 10x longer if done improperly!). Only style cells if absolutely necessary.
frompyexcelerateimportWorkbook,Color,Style,Font,Fill,Formatfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.set_cell_value(1,1,1)ws.set_cell_style(1,1,Style(font=Font(bold=True)))ws.set_cell_style(1,1,Style(font=Font(italic=True)))ws.set_cell_style(1,1,Style(font=Font(underline=True)))ws.set_cell_style(1,1,Style(font=Font(strikethrough=True)))ws.set_cell_style(1,1,Style(fill=Fill(background=Color(255,0,0,0))))ws.set_cell_value(1,2,datetime.now())ws.set_cell_style(1,1,Style(format=Format('mm/dd/yy')))wb.save("output.xlsx")
Note that in this example, subsequent calls toset_cell_style() override the previous styles and they are not merged in. To have a combined style, create a singleStyle object with multiple properties, for example
ws.set_cell_style(1, 1, Style(font=Font(bold=True), format=Format('mm/dd/yy')))frompyexcelerateimportWorkbook,Colorfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.set_cell_value(1,1,1)ws.get_cell_style(1,1).font.bold=Truews.get_cell_style(1,1).font.italic=Truews.get_cell_style(1,1).font.underline=Truews.get_cell_style(1,1).font.strikethrough=Truews.get_cell_style(1,1).fill.background=Color(0,255,0,0)ws.set_cell_value(1,2,datetime.now())ws.get_cell_style(1,1).format.format='mm/dd/yy'wb.save("output.xlsx")
frompyexcelerateimportWorkbook,Colorfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws[1][1].value=1ws[1][1].style.font.bold=Truews[1][1].style.font.italic=Truews[1][1].style.font.underline=Truews[1][1].style.font.strikethrough=Truews[1][1].style.fill.background=Color(0,255,0,0)ws[1][2].value=datetime.now()ws[1][2].style.format.format='mm/dd/yy'wb.save("output.xlsx")
Note that.style.format.format's repetition is due to planned support for conditional formatting and other related features. The formatting syntax may be improved in the future.
frompyexcelerateimportWorkbook,Colorfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("test")ws.range("A1","C3").value=1ws.range("A1","C1").style.font.bold=Truews.range("A2","C3").style.font.italic=Truews.range("A3","C3").style.fill.background=Color(255,0,0,0)ws.range("C1","C3").style.font.strikethrough=True
A simpler (and faster) way to style an entire row.
frompyexcelerateimportWorkbook,Color,Style,Fillfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.set_row_style(1,Style(fill=Fill(background=Color(255,0,0,0))))wb.save("output.xlsx")
frompyexcelerateimportWorkbook,Colorfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.get_row_style(1).fill.background=Color(255,0,0)wb.save("output.xlsx")
frompyexcelerateimportWorkbook,Colorfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws[1].style.fill.background=Color(255,0,0)wb.save("output.xlsx")
frompyexcelerateimportWorkbook,Color,Style,Fillfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.set_col_style(1,Style(fill=Fill(background=Color(255,0,0,0))))wb.save("output.xlsx")
Consistent with the implementation patterns above, the following style parameters are available:
ws[1][1].style.font.bold=Truews[1][1].style.font.italic=Truews[1][1].style.font.underline=Truews[1][1].style.font.strikethrough=Truews[1][1].style.font.color=Color(255,0,255)ws[1][1].style.fill.background=Color(0,255,0)ws[1][1].style.alignment.vertical='top'ws[1][1].style.alignment.horizontal='right'ws[1][1].style.alignment.rotation=90ws[1][1].style.alignment.wrap_text=Truews[1][1].style.borders.top.color=Color(255,0,0)ws[1][1].style.borders.right.style='-.'ws[1][1].style.data_type=DataTypes.INLINE_STRINGws[1][1].style.quote_prefix=True
Each attribute also has constructors for implementing viaset_cell_style().
The following border styles are available:.-,..-,--,..,=,.,medium -.,medium -..,medium --,/-.,_
Row heights and column widths are set using thesize attribute inStyle. Appropriate values are:
-1for auto-fit0for hidden- Any other value for the appropriate size.
For example, to hide column B:
frompyexcelerateimportWorkbook,Color,Style,Fillfromdatetimeimportdatetimewb=Workbook()ws=wb.new_sheet("sheet name")ws.set_col_style(2,Style(size=0))wb.save("output.xlsx")
PyExcelerate supports using style objects instead manually setting each attribute as well. This permits you to modify the style at a later time.
frompyexcelerateimportWorkbook,Fontwb=Workbook()ws=wb.new_sheet("sheet name")ws[1][1].value=1font=Font(bold=True,italic=True,underline=True,strikethrough=True)ws[1][1].style.font=fontwb.save("output.xlsx")
PyExcelerate does not support directly passing a Pandas DataFrame as the data argument to a new worksheet. If the sheet does not require having the headers rendered, the most efficient solution is:
ws=wb.new_sheet("sheet name",data=df.values.tolist())
Note that the conversion.tolist() is faster as PyExcelerate has some optimizations surrounding data that's provided in lists. If the sheet needs to have headers rendered, considerasking the Pandas maintainers to integrate PyExcelerate,use a transformation function, or convert your DataFrame to a list with the headers included.
PyInstaller is the only packager officially supported by PyExcelerate. Copy hook-pyexcelerate.Writer.py to your PyInstaller hooks directory.
Please use the GitHub Issue Tracker and pull request system to report bugs/issues and submit improvements/changes, respectively.Pull requestsmust be based against the dev branch - if not, we will reject the PR and ask you to rebase against the correct branch. All nontrivial changes to code should be accompanied by a test when appropriate. We use the Nose testing framework.
About
Accelerated Excel XLSX Writing Library for Python 2/3