8000 GitHub - numpy/numpy-stubs at 56b8c60b6a4bc72b82da835da65cc31ef5b8aa09
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Jun 10, 2020. It is now read-only.

numpy/numpy-stubs

Repository files navigation

numpy-stubs: experimental typing stubs for NumPy

Build Status

We are currently focused on moving these type stubs into the NumPy main repo. We look forward to your contributions once the migration is complete!

This repository exists for developing PEP 484 compatible typing annotations for NumPy.

The plan:

  1. Write basic type stubs for numpy.ndarray without dtypes or shapes.
  2. Add support for dtypes in ndarray type-annotations.
    • This might be as simple as writing np.ndarray[np.float64], but will need a decision about appropriate syntax for shape typing to ensure that this is forwards compatible with typing shapes.
    • This will likely require minor changes to NumPy itself, e.g., to add ndarray.__class_getitem__ per PEP 560.
  3. Add support for shapes in ndarray type-annotations.
    • This will first require defining a broader (Python wide) standard for typing array shapes, and likely entail writing a PEP.

About

Experimental typing stubs for NumPy

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 14

Languages

0