Support and require nptyping 2

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.18.0
+
+- Support and require `nptyping>=2`
+
 ## 1.17.1
 
 - Mark it as requiring `nptyping<2`

setup.cfg

@@ -30,7 +30,7 @@ project_urls =
 [options]
 packages = find:
 install_requires =
-    Sphinx>=4
+    Sphinx>=4.5
 python_requires = >=3.7
 package_dir =
     =src
@@ -40,16 +40,16 @@ where = src
 
 [options.extras_require]
 testing =
-    covdefaults>=2
-    coverage>=6
+    covdefaults>=2.2
+    coverage>=6.3
     diff-cover>=6.4
-    nptyping>=1,<2
-    pytest>=6
+    nptyping>=2
+    pytest>=7.1
     pytest-cov>=3
     sphobjinv>=2
-    typing-extensions>=3.5
+    typing-extensions>=4.1
 type_comments =
-    typed-ast>=1.4.0;python_version < "3.8"
+    typed-ast>=1.5.2;python_version < "3.8"
 
 [options.package_data]
 sphinx_autodoc_typehints = py.typed

src/sphinx_autodoc_typehints/__init__.py

@@ -25,7 +25,7 @@
 def get_annotation_module(annotation: Any) -> str:
     if annotation is None:
         return "builtins"
-    is_new_type = sys.version_info >= (3, 10) and isinstance(annotation, NewType)  # type: ignore
+    is_new_type = sys.version_info >= (3, 10) and isinstance(annotation, NewType)
     if is_new_type or isinstance(annotation, TypeVar):
         return "typing"
     if hasattr(annotation, "__module__"):
@@ -44,7 +44,7 @@ def get_annotation_class_name(annotation: Any, module: str) -> str:
     elif annotation is AnyStr:
         return "AnyStr"
     elif (sys.version_info < (3, 10) and inspect.isfunction(annotation) and hasattr(annotation, "__supertype__")) or (
-        sys.version_info >= (3, 10) and isinstance(annotation, NewType)  # type: ignore # isinstance NewType is Callable
+        sys.version_info >= (3, 10) and isinstance(annotation, NewType)
     ):
         return "NewType"
 

tests/test_sphinx_autodoc_typehints.py

@@ -27,7 +27,7 @@
 )
 from unittest.mock import create_autospec, patch
 
-import nptyping  # type: ignore
+import nptyping
 import pytest
 import typing_extensions
 from sphinx.application import Sphinx
@@ -241,45 +241,42 @@ def test_parse_annotation(annotation: Any, module: str, class_name: str, args: t
         # Internal tuple with following additional type cannot be flattened (specific to nptyping?)
         # These cases will fail if nptyping restructures its internal module hierarchy
         (
-            nptyping.NDArray[(Any,), nptyping.Float],
+            nptyping.NDArray[nptyping.Shape["*"], nptyping.Float],
             (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(:py:data:`~typing.Any`, ), "
-                ":py:class:`~nptyping.types._number.Float`]"
+                ":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Literal`\\['*'], "
+                ":py:class:`~numpy.float64`]"
             ),
         ),
         (
-            nptyping.NDArray[(Any,), nptyping.Float[64]],
+            nptyping.NDArray[nptyping.Shape["64"], nptyping.Float],
             (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(:py:data:`~typing.Any`, ), "
-                ":py:class:`~nptyping.types._number.Float`\\[64]]"
+                ":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Literal`\\['64'], "
+                ":py:class:`~numpy.float64`]"
             ),
         ),
         (
-            nptyping.NDArray[(Any, Any), nptyping.Float],
+            nptyping.NDArray[nptyping.Shape["*, *"], nptyping.Float],
             (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(:py:data:`~typing.Any`, "
-                ":py:data:`~typing.Any`), :py:class:`~nptyping.types._number.Float`]"
+                ":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Literal`\\['*, "
+                "*'], :py:class:`~numpy.float64`]"
             ),
         ),
         (
-            nptyping.NDArray[(Any, ...), nptyping.Float],
-            (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(:py:data:`~typing.Any`, :py:data:`...<Ellipsis>`), "
-                ":py:class:`~nptyping.types._number.Float`]"
-            ),
+            nptyping.NDArray[nptyping.Shape["*, ..."], nptyping.Float],
+            (":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Any`, :py:class:`~numpy.float64`]"),
         ),
         (
-            nptyping.NDArray[(Any, 3), nptyping.Float],
+            nptyping.NDArray[nptyping.Shape["*, 3"], nptyping.Float],
             (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(:py:data:`~typing.Any`, 3), "
-                ":py:class:`~nptyping.types._number.Float`]"
+                ":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Literal`\\['*, 3'], "
+                ":py:class:`~numpy.float64`]"
             ),
         ),
         (
-            nptyping.NDArray[(3, ...), nptyping.Float],
+            nptyping.NDArray[nptyping.Shape["3, ..."], nptyping.Float],
             (
-                ":py:class:`~nptyping.types._ndarray.NDArray`\\[(3, :py:data:`...<Ellipsis>`),"
-                " :py:class:`~nptyping.types._number.Float`]"
+                ":py:class:`~nptyping.ndarray.NDArray`\\[:py:data:`~typing.Literal`\\['3, ...'], "
+                ":py:class:`~numpy.float64`]"
             ),
         ),
     ],
@@ -312,6 +309,7 @@ def test_format_annotation(inv: Inventory, annotation: Any, expected_result: str
     if "typing" in expected_result or "nptyping" in expected_result or __name__ in expected_result:
         expected_result = expected_result.replace("~typing", "typing")
         expected_result = expected_result.replace("~nptyping", "nptyping")
+        expected_result = expected_result.replace("~numpy", "numpy")
         expected_result = expected_result.replace("~" + __name__, __name__)
         conf = create_autospec(Config, typehints_fully_qualified=True, _annotation_globals=globals())
         assert format_annotation(annotation, conf) == expected_result

tox.ini

@@ -45,7 +45,7 @@ description = run type check on code base
 setenv =
     {tty:MYPY_FORCE_COLOR = 1}
 deps =
-    mypy==0.931
+    mypy==0.942
     types-docutils
 commands =
     mypy --python-version 3.10 src
@@ -59,8 +59,8 @@ setenv =
     COVERAGE_FILE = {toxworkdir}/.coverage
 skip_install = true
 deps =
-    covdefaults>=2.1
-    coverage>=6.2
+    covdefaults>=2.2
+    coverage>=6.3
     diff-cover>=6.4
 extras =
 parallel_show_output = true
@@ -80,8 +80,8 @@ depends =
 description = check that the long description is valid (need for PyPI)
 skip_install = true
 deps =
-    build>=0.6
-    twine>=3
+    build>=0.7
+    twine>=4
 extras =
 commands =
     pyproject-build -o {envtmpdir} --wheel --sdist .