API reference¶
Curated index of the public ezxl API exported from the top-level package.
📦 COM automation¶
| Symbol | Description |
|---|---|
ExcelApp |
Entry point for a live Excel COM session. |
WorkbookProxy |
Workbook-level operations such as open, save, and sheet lookup. |
SheetProxy |
Worksheet navigation plus cell and range access. |
CellProxy |
Single-cell read and write access. |
RangeProxy |
Rectangular range access for bulk values. |
📦 GUI layer¶
| Symbol | Description |
|---|---|
GUIProxy |
Unified facade for ribbon, menu, dialog, keys, and Backstage surfaces. |
RibbonProxy |
COM-backed MSO ribbon command execution and state queries. |
MenuProxy |
COM-backed legacy CommandBar traversal. |
DialogProxy |
COM-backed file open, file save, and alert dialogs. |
COMBackstageBackend |
COM-backed file operations in Excel Backstage. |
PywinautoKeysBackend |
Optional pywinauto keystroke backend. |
PywinautoBackstageBackend |
Optional pywinauto Backstage navigator. |
📦 GUI contracts¶
| Symbol | Description |
|---|---|
AbstractRibbonBackend |
Contract for ribbon execution and state queries. |
AbstractMenuBackend |
Contract for legacy menu traversal. |
AbstractDialogBackend |
Contract for file-picker and alert dialogs. |
AbstractKeysBackend |
Contract for key injection. |
AbstractBackstageFileOps |
Contract for COM-style Backstage file operations. |
AbstractBackstageNavigator |
Contract for UIA-style Backstage navigation. |
| AbstractBackstageBackend | Compatibility alias kept for existing imports. |
📦 File I/O and formatting¶
| Symbol | Description |
|---|---|
read_excel |
Read a workbook sheet into a polars DataFrame. |
read_csv |
Read a CSV file into a polars DataFrame. |
xlsx_to_csv |
Convert a workbook sheet to CSV. |
csv_to_xlsx |
Convert a CSV file to XLSX. |
read_sheet |
Read a sheet into a legacy row-major list of lists. |
ExcelFormatter |
Apply formatting to a closed workbook through openpyxl. |
📦 Exceptions¶
| Symbol | Description |
|---|---|
EzXlError |
Base exception for all library-originated failures. |
ExcelNotAvailableError |
Excel could not be dispatched or attached. |
ExcelSessionLostError |
A previously attached COM session was lost. |
ExcelThreadViolationError |
A COM call was made from the wrong thread. |
WorkbookNotFoundError |
The requested workbook is not open. |
SheetNotFoundError |
The requested sheet does not exist. |
COMOperationError |
A COM call failed without a more specific mapping. |
GUIOperationError |
A GUI surface call failed. |
FormatterError |
A closed-file formatting operation failed. |
🔍 Full reference¶
For the complete mkdocstrings dump of the public API, see Full reference.
📦 Backend modules¶
| Module page | Description |
|---|---|
| Win32com backends | Module-level reference for COM GUI backends (RibbonProxy, MenuProxy, DialogProxy, COMBackstageBackend). |
| Pywinauto backends | Module-level reference for optional UI Automation backends (PywinautoKeysBackend, PywinautoBackstageBackend). |