PyExcelerate

0.13.0 · active · verified Wed Apr 15

PyExcelerate is an accelerated Python library designed for quickly writing Excel XLSX files, with an emphasis on performance and efficient memory usage. It is currently at version 0.13.0 and supports both Python 2.7 and various Python 3 versions, though a strict release cadence is not always observed.

Warnings

gotcha PyExcelerate can consume a significant amount of memory when writing extremely large datasets, as it does not inherently offer a constant-memory mode like some other libraries. Users dealing with datasets of millions of rows might encounter memory exhaustion.
Fix: For very large files and strict memory constraints, consider alternative libraries like XlsxWriter which offer a `constant_memory` option. Optimize data structures to reduce memory footprint before passing to PyExcelerate.
gotcha Applying styles cell-by-cell can introduce substantial performance overhead, potentially slowing down execution by up to 10 times. PyExcelerate is optimized for speed when writing raw data.
Fix: Minimize individual cell styling. Apply styles to entire rows, columns, or ranges where possible using `ws.set_row_style()`, `ws.set_col_style()`, or range styling to improve performance.
gotcha Writing large dataframes primarily containing strings can occasionally result in corrupted or invalid XLSX files that Excel cannot open correctly. This issue seems to be more prevalent with specific data characteristics and large file sizes.
Fix: If encountering this issue, try to preprocess or segment string data, or consider using alternative libraries for string-heavy large datasets. Check GitHub issues for potential workarounds or updates.
gotcha When writing multiple sheets to a single workbook, ensure that the `Workbook()` object is instantiated only once. Repeatedly calling `wb = Workbook()` will create a new, empty workbook each time, overwriting any previously added sheets when `save()` is called.
Fix: Instantiate the `Workbook()` object once, then add all sheets using `wb.new_sheet()` before a single `wb.save()` call.

Install

pip install pyexcelerate Install PyExcelerate

Imports

Workbook
```
from pyexcelerate import Workbook
```

Quickstart

This quickstart demonstrates how to create a new Excel workbook, add a sheet with a 2D array of data, apply some basic styling, and save the workbook to a file. It highlights the primary use case of bulk data writing.

from pyexcelerate import Workbook
import os

data = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9]
] # data is a 2D array

wb = Workbook()
ws = wb.new_sheet("MySheet", data=data)

# Optional: Set column widths or row heights
ws.set_col_style(1, ws.style.font.bold)
ws.set_row_style(1, ws.style.font.italic)
ws.cell(1,1).value = "Bold Italic"

file_path = "output.xlsx"
wb.save(file_path)
print(f"Workbook saved to {os.path.abspath(file_path)}")

view raw JSON →