scipy-stubs

Type stubs for SciPy.

[!NOTE] This project is in the alpha stage, so some annotations are missing, and some might be (slightly) incorrect. But either way, it's no problem to scipy-stubs at the moment: Type-checkers will (already) understand scipy a lot better with scipy-stubs, than without it.

Installation

The scipy-stubs package is available as on PyPI:

pip install scipy-stubs

Version Compatibility

Type-checkers

For validation and testing, scipy-stubs primarily uses basedmypy (a mypy fork) and basedpyright (a pyright fork). Because they are in generally stricter than mypy and pyright, they should be compatible as well. If you find that this is not the case, then don't hesitate to open an issue.

Required dependencies

The versioning scheme of scipy-stubs includes the compatible scipy version. Later versions might work too, but in case of API-changes, the stubs could be outdated.

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

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

Development Progress

Status labels:

• 0: missing (failed stubgen)
• 1: skeleton (mostly succesful stubgen)
• 2: partial (incomplete/broad annotations)
• 3: ready (complete & valid annotations, untested)
• 4: done (complete, valid, tested, and production-ready)