Skip to content

Commit

Permalink
Merge pull request #16 from jorenham/scipy.version
Browse files Browse the repository at this point in the history
`scipy.version`
  • Loading branch information
jorenham authored Sep 4, 2024
2 parents 649ed35 + 770fe5e commit a4c26de
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ pip install scipy-stubs
## Development Progress

According to [basedpyright](https://github.com/DetachHead/basedpyright) (stricter than
pyright), the "type completeness score" is **42.4%**.
pyright), the "type completeness score" is **42.6%**.

| Module | Stubs status |
| Package or module | Stubs status |
|---------------------------------- |---------------- |
| `scipy.__init__` | 3: ready |
| `scipy._lib` | 2: partial |
Expand Down Expand Up @@ -119,11 +119,12 @@ pyright), the "type completeness score" is **42.4%**.
| `scipy.stats.mstats` | 1: skeleton |
| `scipy.stats.qmc` | 2: partial |
| `scipy.stats.sampling` | 1: skeleton |
| `scipy.version` | 4: done |

Status labels:

1. missing (failed stubgen)
2. skeleton (mostly succesful stubgen)
3. partial (incomplete/broad annotations)
4. ready (complete & valid annotations, untested)
5. done (complete, valid, tested, and production-ready)
- 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)
3 changes: 2 additions & 1 deletion scipy-stubs/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ from collections.abc import Sequence
from typing import Final, Literal
from typing_extensions import LiteralString

from numpy import __version__ as __numpy_version__ # noqa: ICN003
from . import (
cluster,
constants,
Expand All @@ -25,6 +26,7 @@ from . import (
from .__config__ import show as show_config
from ._lib._ccallback import LowLevelCallable
from ._lib._testutils import PytestTester
from .version import version as __version__

__all__ = [
"LowLevelCallable",
Expand All @@ -50,7 +52,6 @@ __all__ = [
"stats",
"test",
]
__version__: Final[LiteralString]
np_minversion: Final[LiteralString]
np_maxversion: Final[LiteralString]

Expand Down
9 changes: 9 additions & 0 deletions scipy-stubs/version.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from typing import Final
from typing_extensions import LiteralString

short_version: Final[LiteralString] = ...
version: Final[LiteralString] = ...
full_version: Final[LiteralString] = ...
git_revision: Final[LiteralString] = ...
commit_count: Final[LiteralString] = ...
release: Final[bool] = ...

0 comments on commit a4c26de

Please sign in to comment.