Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jorenham/scipy-stubs
Typing Stubs for SciPy
https://github.com/jorenham/scipy-stubs
basedmypy basedpyright data-science mypy pep484 pep561 pyright python python-stubs python-typing python3 scipy stubs type-stubs
Last synced: 1 day ago
JSON representation
Typing Stubs for SciPy
- Host: GitHub
- URL: https://github.com/jorenham/scipy-stubs
- Owner: jorenham
- License: bsd-3-clause
- Created: 2024-08-22T01:00:45.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-03T09:14:00.000Z (5 days ago)
- Last Synced: 2024-11-03T10:17:48.631Z (5 days ago)
- Topics: basedmypy, basedpyright, data-science, mypy, pep484, pep561, pyright, python, python-stubs, python-typing, python3, scipy, stubs, type-stubs
- Language: Python
- Homepage: https://pypi.org/project/scipy-stubs/
- Size: 1.44 MB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-python-typing - scipy-stubs - Stubs for [SciPy](https://github.com/scipy/scipy). (Stub packages)
- trackawesomelist - scipy-stubs (⭐2) - Stubs for [SciPy (⭐13k)](https://github.com/scipy/scipy). (Recently Updated / [Sep 15, 2024](/content/2024/09/15/README.md))
README
scipy-stubs
Typing stubs for SciPy.
______________________________________________________________________
## Installation
```shell
pip install scipy-stubs
```
## Development Status
| `scipy._` | `ruff` & `flake8-pyi` | `stubtest` | `basedmypy` | `basedpyright` | phase |
| :------------ | :-------------------: | :--------: | :---------: | :------------: | :---: |
| `_lib` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `cluster` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `constants` | ✔️ | ✔️ | ✔️ | ✔️ | 🌝 |
| `datasets` | ✔️ | ✔️ | ✔️ | ✔️ | 🌝 |
| `fft` | ✔️ | ✔️ | ✔️ | ✔️ | 🌔 |
| `fftpack` | ✔️ | ✔️ | ✔️ | ✔️ | 🌔 |
| `integrate` | ✔️ | ✔️ | ✔️ | ✔️ | 🌔 |
| `interpolate` | ✔️ | ✔️ | ✔️ | ✔️ | 🌓 |
| `io` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `linalg` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| ~`misc`~ | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `ndimage` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `odr` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `optimize` | ✔️ | ✔️ | ✔️ | ✔️ | 🌓 |
| `signal` | ✔️ | ✔️ | ✔️ | ✔️ | 🌒 |
| `sparse` | ✔️ | ✔️ | ✔️ | ✔️ | 🌒 |
| `spatial` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
| `special` | ✔️ | ✔️ | ✔️ | ✔️ | 🌓 |
| `stats` | ✔️ | ✔️ | ✔️ | ✔️ | 🌕 |
## Version Compatibility
### Type-checkers
For validation and testing, `scipy-stubs` primarily uses [`basedmypy`](https://github.com/KotlinIsland/basedmypy) (a `mypy` fork)
and [`basedpyright`](https://github.com/DetachHead/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`](https://github.com/jorenham/optype), which itself only depends on `typing_extensions`.
The exact version requirements are specified in the [`pyproject.toml`](pyproject.toml).