pyexcel-xlsx: XLSX/XLSM Handler for pyexcel

Warnings

• breaking Version 0.6.0 dropped support for Python versions lower than 3.6. Additionally, it introduced 'new style plugins' aligned with pyexcel-io v0.6.2+, which means older `pyexcel-io` plugins are incompatible with this version.
  Fix: Ensure your project uses Python 3.6 or newer. If upgrading from pre-0.6.0, review `pyexcel-io` documentation for changes to the plugin interface or upgrade all `pyexcel` related packages to their latest versions.
• gotcha When using `pyexcel` as the main interface (e.g., `pyexcel.get_sheet()` or `pyexcel.save_as()`), `pyexcel-xlsx` is auto-loaded. Explicitly importing `pyexcel_xlsx` is generally not needed and can lead to confusion if standalone functions are used alongside the unified API.
  Fix: Rely on `import pyexcel as pe` and use `pe.get_sheet()` or `pe.save_as()`. Only use `from pyexcel_xlsx import get_data, save_data` if you intend to use `pyexcel-xlsx` as a standalone library without `pyexcel`'s unified workflow.
• gotcha The library primarily focuses on data processing. Features like fonts, colors, charts, or other styling elements within XLSX/XLSM files are not supported.
  Fix: If advanced formatting or chart manipulation is required, consider using `openpyxl` directly or other specialized libraries.
• gotcha pyexcel-xlsx does not support reading or writing password-protected XLSX/XLSM files.
  Fix: Ensure that any XLSX/XLSM files you intend to process with `pyexcel-xlsx` are not password-protected.
• gotcha The `auto_detect_int` flag, commonly found in other Excel libraries, has no effect when using `pyexcel-xlsx`. This is because `openpyxl`, its underlying dependency, detects integers by default in Python 3.
  Fix: No action required, as integer detection is handled automatically. If you encounter issues with integer detection, it's likely an `openpyxl` behavior rather than `pyexcel-xlsx`.

Install

• pip install pyexcel-xlsx Install pyexcel-xlsx

Imports

• get_data

  from pyexcel_xlsx import get_data

  For standalone usage of pyexcel-xlsx without the pyexcel unified API.
• save_data

  from pyexcel_xlsx import save_data

  For standalone usage of pyexcel-xlsx without the pyexcel unified API.
• pyexcel

  import pyexcel as pe

  Since pyexcel version 0.2.2, pyexcel-xlsx is auto-loaded when pyexcel is installed. Explicit import of pyexcel_xlsx is not needed when using pyexcel's unified API (e.g., pe.get_sheet(), pe.save_as()).

Quickstart

This quickstart demonstrates how to write an `OrderedDict` to an XLSX file and then read it back using `pyexcel`'s unified API, which automatically utilizes `pyexcel-xlsx` for the XLSX format. It covers both saving and retrieving data from multi-sheet Excel files.

import pyexcel as pe
from collections import OrderedDict
import os

# Create some data for an Excel sheet
data = OrderedDict()
data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
data.update({"Sheet 2": [["A", "B", "C"], [7, 8, 9]]})

file_name = "my_excel_file.xlsx"

# Save data to an XLSX file using pyexcel's unified API
pe.save_as(adict=data, dest_file_name=file_name)
print(f"Data successfully saved to {file_name}")

# Read data from the XLSX file
book = pe.get_book(file_name=file_name)

print(f"\nData read from {file_name}:")
for sheet_name in book.sheet_names():
    sheet = book.sheet_by_name(sheet_name)
    print(f"Sheet Name: {sheet_name}")
    for row in sheet:
        print(row)

# Clean up the created file
os.remove(file_name)
print(f"\nCleaned up {file_name}")