openpyxl-stubs

0.1.25 · active · verified Sat Apr 11

openpyxl-stubs provides type stubs for the openpyxl library, enabling static type checking with tools like MyPy. The current version is 0.1.25, released in January 2023, and it is currently in an alpha development status. It does not have a defined release cadence, as it is a stub package that augments the `openpyxl` library.

Warnings

deprecated The `openpyxl-stubs` project has not been updated since January 2023 and is marked as '3 - Alpha' development status. It may not provide complete or accurate type coverage for recent versions of `openpyxl`.
Fix: For up-to-date and more actively maintained type stubs for `openpyxl`, consider using `types-openpyxl` from the `typeshed` project, which is frequently updated and tracks newer `openpyxl` versions. Install with `pip install types-openpyxl`.
gotcha Due to its alpha status and infrequent updates, `openpyxl-stubs` might have missing modules, deprecated modules, or issues in annotations (e.g., missing parameter/return type annotations) compared to the actual `openpyxl` library.
Fix: If you encounter type checking errors that seem incorrect or missing types, you may need to add `# type: ignore` comments or consider contributing fixes to the `openpyxl-stubs` repository. Switching to `types-openpyxl` is also recommended for better coverage.
gotcha Installation of `openpyxl-stubs` alone does not provide the `openpyxl` functionality. It only provides type hints. You must install `openpyxl` separately.
Fix: Ensure both `openpyxl` and `openpyxl-stubs` are installed: `pip install openpyxl openpyxl-stubs`.

Install

pip install openpyxl-stubs openpyxl Install with openpyxl

Imports

Workbook
```
from openpyxl import Workbook
```
Type stubs are automatically picked up by type checkers when `openpyxl-stubs` is installed. You import directly from `openpyxl`.
Worksheet
```
from openpyxl.worksheet.worksheet import Worksheet
```
Type stubs are automatically picked up by type checkers when `openpyxl-stubs` is installed. You import directly from `openpyxl`.

Quickstart

This example demonstrates basic usage of openpyxl with type annotations. When `openpyxl-stubs` is installed, a type checker like MyPy will use its definitions to validate these operations. Note that `wb.active` might require a `# type: ignore` if the type checker has difficulty inferring `Worksheet` due to the dynamic nature of `active` property in some contexts without explicit stubs for that specific assignment, or if the stub is incomplete for that specific case. The actual save operation is commented out for quickstart runnability without file system interaction.

from openpyxl import Workbook
from openpyxl.worksheet.worksheet import Worksheet

# Create a new workbook with type hints
wb: Workbook = Workbook()

# Grab the active worksheet with type hints
ws: Worksheet = wb.active # type: ignore

# Data can be assigned directly to cells
ws['A1'] = 42

# Rows can also be appended
ws.append([1, 2, 3])

# Python types will automatically be converted (example with a datetime object)
import datetime
ws['A2'] = datetime.datetime.now()

# Save the file
# In a real scenario, you'd use a temporary file or a specific path.
# For this example, we'll just show the save operation.
# wb.save("sample.xlsx")
print("Workbook operations with type hints (stubs installed).")

view raw JSON →