Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19330 from BvB93/runtime
MAINT: Replace `"dtype[Any]"` with `dtype` in the definiton of `npt.ArrayLike`
- Loading branch information
Showing
3 changed files
with
106 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
"""Test the runtime usage of `numpy.typing`.""" | ||
|
||
from __future__ import annotations | ||
|
||
import sys | ||
from typing import get_type_hints, Union, Tuple, NamedTuple | ||
|
||
import pytest | ||
import numpy as np | ||
import numpy.typing as npt | ||
|
||
try: | ||
from typing_extensions import get_args, get_origin | ||
SKIP = False | ||
except ImportError: | ||
SKIP = True | ||
|
||
|
||
class TypeTup(NamedTuple): | ||
typ: type | ||
args: Tuple[type, ...] | ||
origin: None | type | ||
|
||
|
||
if sys.version_info >= (3, 9): | ||
NDArrayTup = TypeTup(npt.NDArray, npt.NDArray.__args__, np.ndarray) | ||
else: | ||
NDArrayTup = TypeTup(npt.NDArray, (), None) | ||
|
||
TYPES = { | ||
"ArrayLike": TypeTup(npt.ArrayLike, npt.ArrayLike.__args__, Union), | ||
"DTypeLike": TypeTup(npt.DTypeLike, npt.DTypeLike.__args__, Union), | ||
"NBitBase": TypeTup(npt.NBitBase, (), None), | ||
"NDArray": NDArrayTup, | ||
} | ||
|
||
|
||
@pytest.mark.parametrize("name,tup", TYPES.items(), ids=TYPES.keys()) | ||
@pytest.mark.skipif(SKIP, reason="requires typing-extensions") | ||
def test_get_args(name: type, tup: TypeTup) -> None: | ||
"""Test `typing.get_args`.""" | ||
typ, ref = tup.typ, tup.args | ||
out = get_args(typ) | ||
assert out == ref | ||
|
||
|
||
@pytest.mark.parametrize("name,tup", TYPES.items(), ids=TYPES.keys()) | ||
@pytest.mark.skipif(SKIP, reason="requires typing-extensions") | ||
def test_get_origin(name: type, tup: TypeTup) -> None: | ||
"""Test `typing.get_origin`.""" | ||
typ, ref = tup.typ, tup.origin | ||
out = get_origin(typ) | ||
assert out == ref | ||
|
||
|
||
@pytest.mark.parametrize("name,tup", TYPES.items(), ids=TYPES.keys()) | ||
def test_get_type_hints(name: type, tup: TypeTup) -> None: | ||
"""Test `typing.get_type_hints`.""" | ||
typ = tup.typ | ||
|
||
# Explicitly set `__annotations__` in order to circumvent the | ||
# stringification performed by `from __future__ import annotations` | ||
def func(a): pass | ||
func.__annotations__ = {"a": typ, "return": None} | ||
|
||
out = get_type_hints(func) | ||
ref = {"a": typ, "return": type(None)} | ||
assert out == ref | ||
|
||
|
||
@pytest.mark.parametrize("name,tup", TYPES.items(), ids=TYPES.keys()) | ||
def test_get_type_hints_str(name: type, tup: TypeTup) -> None: | ||
"""Test `typing.get_type_hints` with string-representation of types.""" | ||
typ_str, typ = f"npt.{name}", tup.typ | ||
|
||
# Explicitly set `__annotations__` in order to circumvent the | ||
# stringification performed by `from __future__ import annotations` | ||
def func(a): pass | ||
func.__annotations__ = {"a": typ_str, "return": None} | ||
|
||
out = get_type_hints(func) | ||
ref = {"a": typ, "return": type(None)} | ||
assert out == ref | ||
|
||
|
||
def test_keys() -> None: | ||
"""Test that ``TYPES.keys()`` and ``numpy.typing.__all__`` are synced.""" | ||
keys = TYPES.keys() | ||
ref = set(npt.__all__) | ||
assert keys == ref |