types-xlrd

What it is and what it does

types-xlrd is a type stub package that adds static type annotations for the xlrd library, a tool for reading data from Excel spreadsheets. It is part of the typeshed project and allows type checkers like mypy and pyright to understand and validate code that uses xlrd, catching type errors before runtime.

The package contains no runtime code—it is purely metadata and type definitions. It targets xlrd version 2.0.* and has been tested against mypy 2.1.0 and pyright 1.1.409. To use it, you install both types-xlrd and xlrd itself; the type checker will then consult the stub definitions when analyzing your code. It requires Python 3.10 or later.

Use it for:

• Enable mypy or pyright to type-check code that reads Excel files with xlrd, catching column-access or method-call errors early.
• Provide IDE autocomplete and hover documentation for xlrd APIs in editors that support type stubs.
• Validate data extraction pipelines that parse .xls files, ensuring correct handling of workbook and sheet objects.
• Enforce type safety in data processing workflows that depend on xlrd without runtime overhead.

Worth the install?

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

Provides type hints for the xlrd library, enabling type checkers like mypy and pyright to validate code that reads Excel files with xlrd.

Yes, if you use xlrd and run a type checker. It is a lightweight, actively maintained stub package with no dependencies and permissive licensing. Install it alongside xlrd to gain type safety with no runtime cost. Not needed if you do not use type checking or do not use xlrd.

Install

types-xlrd on PyPI

pip install types-xlrd

uv add types-xlrd

poetry add types-xlrd

Installing types-xlrd

Before you install

Low friction: a pure stub package with no runtime dependencies. Actively maintained as part of typeshed, with recent updates and no known vulnerabilities.

License in practice

Apache-2.0 permissive license allows free use, modification, and distribution with minimal restrictions.

Quickstart

pip install types-xlrd

# In your code, use xlrd normally; type checkers will now validate it:
import xlrd
workbook = xlrd.open_workbook('file.xls')

Requires Python 3.10 or later. Only provides type information; xlrd itself must be installed separately to actually read Excel files.

Verify before relying

• Whether this stub package is automatically discovered by type checkers or requires explicit configuration in pyproject.toml or similar.
• Coverage completeness: whether all xlrd 2.0.* APIs are fully annotated or if gaps remain.

Package facts

Evidence: types_xlrd-2.0.0.20260518-py3-none-any.whl

Tags

More Software Development packages