nptyping

💡 Type hints for NumPy
💡 Extends numpy.typing
💡 Extensive dynamic type checks for dtypes and shapes of arrays

Example of a hinted function with nptyping:

>>> from nptyping import NDArray, Int, Shape

>>> def func(arr: NDArray[Shape["2, 2"], Int]) -> None:
...     pass

Installation

pip install nptyping

Instance checking

Example of instance checking:

>>> import numpy as np

>>> isinstance(np.array([[1, 2], [3, 4]]), NDArray[Shape["2, 2"], Int])
True

>>> isinstance(np.array([[1., 2.], [3., 4.]]), NDArray[Shape["2, 2"], Int])
False

>>> isinstance(np.array([1, 2, 3, 4]), NDArray[Shape["2, 2"], Int])
False

nptyping also provides assert_isinstance. In contrast to assert isinstance(...), this won't cause IDEs or MyPy complaints. Here is an example:

>>> from nptyping import assert_isinstance

>>> assert_isinstance(np.array([1]), NDArray[Shape["1"], Int])
True

Structured arrays

You can also express structured arrays using nptyping.Structure:

>>> from nptyping import Structure

>>> Structure["name: Str, age: Int"]
Structure['age: Int, name: Str']

Here is an example to see it in action:

>>> from typing import Any
>>> import numpy as np
>>> from nptyping import NDArray, Structure

>>> arr = np.array([("Peter", 34)], dtype=[("name", "U10"), ("age", "i4")])
>>> isinstance(arr, NDArray[Any, Structure["name: Str, age: Int"]])
True

Record arrays

The recarray is a specialization of a structured array. You can use RecArray to express them.

>>> from nptyping import RecArray

>>> arr = np.array([("Peter", 34)], dtype=[("name", "U10"), ("age", "i4")])
>>> rec_arr = arr.view(np.recarray)
>>> isinstance(rec_arr, RecArray[Any, Structure["name: Str, age: Int"]])
True

More examples

Here is an example of a rich expression that can be done with nptyping:

def plan_route(
        locations: NDArray[Shape["[from, to], [x, y]"], Float]
) -> NDArray[Shape["* stops, [x, y]"], Float]:
    ...

More examples can be found in the documentation.

Documentation

User documentation
The place to go if you are using this library.
Release notes
To see what's new, check out the release notes.
Contributing
If you're interested in developing along, find the guidelines here.
Licence
If you want to check out how open source this library is.

Metadata

Release files for nptyping 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for nptyping 2.1.1
File	Interpreter	ABI	Platform	Reset
nptyping-2.1.1-py3-none-any.whl 30.1 kB Jun 1, 2022	Python 3	none	any	Details

Release files / nptyping-2.1.1-py3-none-any.whl

Download URL	nptyping-2.1.1-py3-none-any.whl
Size	30.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0eab214b5b960b755caa2344a1b2a7ee5e24eee9bfeee955809e413f30cfd593`
BLAKE2b-256 checksum How to use checksums	`d7a04073a26abb151485985eb4ff5cb1c5ab095ca1f3e5861d6f52e7832cf389`
Upload date	Jun 1, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.0`