Typing Stubs for openpyxl

3.1.5.20260408 · active · verified Thu Apr 09

This is a type stub package for the `openpyxl` library, providing type hints for static analysis by tools like MyPy and Pyright. It aims to offer accurate annotations for specific `openpyxl` versions (e.g., `openpyxl==3.1.5` for `types-openpyxl 3.1.5.20260408`). `types-openpyxl` is part of the larger Typeshed project, which maintains type stubs for numerous Python libraries. It is actively maintained with frequent releases to keep up with `openpyxl` development.

Warnings

gotcha This package provides *only* type stubs for `openpyxl`, not the `openpyxl` library itself. To use `openpyxl` with type hints, you must install both `openpyxl` and `types-openpyxl`.
Fix: Ensure both `pip install openpyxl` and `pip install types-openpyxl` are run.
gotcha Type stubs are often tied to specific versions of the underlying library. While typeshed aims for broad compatibility, using `types-openpyxl` with an `openpyxl` version significantly different from the one it was generated for (e.g., `openpyxl==3.1.5` for `types-openpyxl 3.1.5.20260408`) may lead to incorrect type checking results.
Fix: Refer to the `types-openpyxl` PyPI page or Typeshed documentation to find the `openpyxl` version the stubs are targeting. Ideally, keep `types-openpyxl` and `openpyxl` versions in sync, or at least close enough that their APIs don't diverge significantly.
breaking Changes or bug fixes to `openpyxl`'s API (even minor ones) can lead to mismatches with the type stubs, causing type checkers to report errors on valid `openpyxl` code or fail to catch actual type errors. This is particularly relevant if `openpyxl` introduces new features or alters method signatures that are not yet reflected in the stubs.
Fix: If experiencing type checking issues after an `openpyxl` update, check if a newer `types-openpyxl` version is available. If not, consider reporting the discrepancy to the Typeshed project. Temporarily, you might need to use `type: ignore` comments if the code is known to be correct at runtime.
gotcha All fixes and updates to the `openpyxl` type stubs should be contributed directly to the `python/typeshed` GitHub repository, not to the `types-openpyxl` PyPI package's maintainers directly. The PyPI package is automatically generated from Typeshed.
Fix: To contribute, submit pull requests to the `typeshed` repository's `stubs/openpyxl` directory.

Install

pip install types-openpyxl openpyxl Install stubs and the underlying library

Imports

Workbook
```
from openpyxl import Workbook
```
types-openpyxl provides type hints for this import from the actual openpyxl library.
load_workbook
```
from openpyxl import load_workbook
```
types-openpyxl provides type hints for this import from the actual openpyxl library.
Font
```
from openpyxl.styles import Font
```
types-openpyxl provides type hints for style-related imports from the actual openpyxl library.

Quickstart

This quickstart demonstrates basic usage of `openpyxl`. When `types-openpyxl` is installed alongside `openpyxl`, static type checkers like MyPy or Pyright can use the provided stubs to perform type verification on this code.

import datetime
from openpyxl import Workbook
from openpyxl.styles import Font

def create_excel_with_types():
    # This code uses openpyxl, and types-openpyxl provides type hints for it.
    wb: Workbook = Workbook()
    ws = wb.active
    ws.title = "Typed Sheet"

    # Type checking tools (like MyPy) will use types-openpyxl to validate these operations.
    ws['A1'] = "Date"
    ws['B1'] = "Value"
    ws['A1'].font = Font(bold=True)
    ws['B1'].font = Font(bold=True)

    ws['A2'] = datetime.date(2026, 4, 9)
    ws['B2'] = 123.45

    file_path = "typed_sample.xlsx"
    wb.save(file_path)
    print(f"Excel file '{file_path}' created with type hints verified.")

if __name__ == "__main__":
    create_excel_with_types()

view raw JSON →