openpyxl-stubs

What it is and what it does

openpyxl-stubs is a type stub package that adds type annotations for openpyxl, enabling mypy to understand and validate code that uses openpyxl for reading and writing Excel files. Once installed, mypy automatically recognizes the type information without requiring any additional configuration.

The package works by providing type definitions that mypy consults during static analysis. It depends on mypy, typing-extensions, and openpyxl itself. The package is classified as Alpha and has not been actively maintained since 2023-01-12, so its type coverage may lag behind newer openpyxl releases.

Use it for:

• Enable mypy type checking in projects that use openpyxl to read or write Excel spreadsheets
• Catch type errors at development time when passing openpyxl objects between functions
• Document expected types for openpyxl function parameters and return values in your codebase
• Integrate openpyxl into a strictly typed Python project without disabling type checking for Excel-related code

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides type stubs for openpyxl to enable static type checking with mypy when working with Excel files in Python.

Yes, if you are using openpyxl with a version released before or around January 2023 and want mypy type checking. No, if you rely on recent openpyxl features or expect ongoing maintenance—the package is abandoned and type stubs may be incomplete or outdated for current openpyxl versions.

Install

openpyxl-stubs on PyPI

pip install openpyxl-stubs

uv add openpyxl-stubs

poetry add openpyxl-stubs

Installing openpyxl-stubs

Before you install

Installation is straightforward with no complex dependencies beyond mypy, typing-extensions, and openpyxl itself. However, the package is marked as abandoned with no commits since 2023-01-12, meaning type stubs may not reflect recent openpyxl API changes.

License in practice

Licensed under MIT license, a permissive license allowing free use, modification, and distribution with minimal restrictions.

Quickstart

pip install openpyxl-stubs

from openpyxl import load_workbook
wb = load_workbook('file.xlsx')

Verify before relying

• Whether type stub coverage is complete for the version of openpyxl you are using
• Compatibility with recent openpyxl releases given the package's abandoned status since January 2023

Package facts

Evidence: openpyxl_stubs-0.1.25-py3-none-any.whl

Keywords: utility, mypy, stubs

Tags

More Quality Assurance packages