scipy-stubs

Typing stubs for SciPy.

<a href="https://github.com/pre-commit/pre-commit">
    <img src="https://img.shields.io/badge/pre--commit-enabled-teal?logo=pre-commit" alt="scipy-stubs - pre-commit">
</a>
<a href="https://github.com/KotlinIsland/basedmypy">
    <img src="https://img.shields.io/badge/basedmypy-checked-fd9002" alt="scipy-stubs - basedmypy">
</a>
<a href="https://detachhead.github.io/basedpyright">
    <img src="https://img.shields.io/badge/basedpyright-checked-42b983" alt="scipy-stubs - basedpyright">
</a>
<a href="https://github.com/astral-sh/ruff">
    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="scipy-stubs - ruff">
</a>

Installation

pip install scipy-stubs

Development Status

Version Compatibility

Type-checkers

For validation and testing, scipy-stubs primarily uses basedmypy (a mypy fork) and basedpyright (a pyright fork). They are in generally stricter than mypy and pyright, so you can assume compatibility with mypy and pyright as well. But if you find that this isn't the case, then don't hesitate to open an issue or submit a pull request.

Required dependencies

The versioning scheme of scipy-stubs includes the compatible scipy version as {scipy_version}.{stubs_version}. Even though scipy-stubs doesn't enforce an upper bound on the scipy version, later scipy versions aren't guaranteed to be fully compatible.

Apart from scipy's own dependencies, (e.g. numpy), the only other required dependency is optype, which itself only depends on typing_extensions.

The exact version requirements are specified in the pyproject.toml.