nptyping
Type hints for Numpy!
Installation
pip install nptyping
Usage
Use the nptyping type hints like the regular type hints from typing:
from nptyping import Array
def func1(arr: Array[int]): # A numpy.ndarray that contains numbers
...You can also define the shape of an array:
Array[str, 3, 2] # 3 rows and 2 columns
Array[str, 3] # 3 rows and an undefined number of columns
Array[str, 3, ...] # 3 rows and an undefined number of columns
Array[str, ..., 2] # an undefined number of rows and 2 columnsHeterogeneous arrays are supported as well:
Array[int, float, str] # int, float and str on columns 1, 2 and 3 resp.
Array[int, float, str, ...] # int, float and str on columns 1, 2 and 3 resp.
Array[int, float, str, 3] # 3 rows and int, float and str on columns 1, 2 and 3 resp.nptyping also supports instance checks:
import numpy
from nptyping import Array
arr = numpy.array([[1, 2],
[3, 4],
[5, 6]])
isinstance(arr, Array[int, 3, 2]) # True
isinstance(arr, Array[str, 3, 2]) # False
isinstance(arr, Array[int, 3, ...]) # True
isinstance(arr, Array[int, 3, 6]) # FalseAlso for heterogeneous arrays:
import numpy
from nptyping import Array
arr = np.array([(1, 2.0, '3'),
(4, 5.0, '6')],
dtype=[('a', int), ('b', float), ('c', str)])
isinstance(arr, Array[int, float, str]) # True
isinstance(arr, Array[float, float, str]) # False
isinstance(arr, Array[int, float, str, 2]) # True1 maintainer
Metadata
1 maintainer
Release files for nptyping 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nptyping-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / nptyping-0.3.0-py3-none-any.whl
| Download URL | nptyping-0.3.0-py3-none-any.whl |
|---|---|
| Size | 1.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3ab1b840da7d2720e7cd76b8d478d66b43ef64b3d3a5e419ac112ec9bf1859e
|
|
BLAKE2b-256 checksum How to use checksums |
5df0d949ae7d837f29a561e802295baa097a61e67a063c27bdf823920c5fd9e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3
|
