write_sheets_arrow

jet.write_sheets_arrow(arrow_sheets, filename, num_threads) -> None

Parameters

list[dict]

required

One dictionary per sheet. Requires data and name, and every other key is a write_sheet_arrow option.

str

required

Output path.

int

required

Threads for XML generation. Required and positional, with no default. Omitting it raises a TypeError.

The sheet dictionary

Arrow table

required

Sheet contents.

str

required

Tab label.

Then any option from write_sheet_arrow as a key: styled_headers, freeze_rows, column_formats, tables, charts, images, conditional_formats, data_validations, tab_color, and the rest.

jet.write_sheets_arrow(
    [
        {"data": df1.to_arrow(), "name": "Sales",
         "styled_headers": True, "tab_color": "00B050"},
        {"data": df2.to_arrow(), "name": "Costs",
         "auto_width": True, "hidden_columns": [2]},
    ],
    "report.xlsx",
    num_threads=2,
)

Returns

None.

Notes

Thread count

Parallelism is per sheet, so more threads than sheets gains nothing. min(os.cpu_count(), len(sheets)) is the sensible ceiling.

Shared style registry

Jetxl deduplicates styles across sheets, so repeating identical formatting is cheap.

Sheet order

Tabs appear in list order, and Excel opens on the first.

Get started

Guides

Recipes

Reference

About

write_sheets_arrow

Parameters

The sheet dictionary

Returns

Notes

​Parameters

​The sheet dictionary

​Returns

​Notes

Parameters

The sheet dictionary

Returns

Notes