Fix the CI and 3.10 regressions (#188)

Author: gaborbernat

setup.cfg

@@ -35,6 +35,6 @@ test =
     typing_extensions >= 3.5
     dataclasses; python_version == "3.6"
     sphobjinv >= 2.0
-    Sphinx >= 3.2.0
+    Sphinx >= 4.3
 type_comments =
     typed_ast >= 1.4.0; python_version < "3.8"

sphinx_autodoc_typehints.py

@@ -2,7 +2,7 @@
 import sys
 import textwrap
 import typing
-from typing import Any, AnyStr, Tuple, TypeVar, get_type_hints
+from typing import Any, AnyStr, NewType, Tuple, TypeVar, get_type_hints
 
 from sphinx.util import logging
 from sphinx.util.inspect import signature as Signature
@@ -18,6 +18,9 @@ def get_annotation_module(annotation) -> str:
     if annotation is None:
         return 'builtins'
 
+    if sys.version_info >= (3, 10) and isinstance(annotation, NewType):
+        return 'typing'
+
     if hasattr(annotation, '__module__'):
         return annotation.__module__
 
@@ -35,7 +38,9 @@ def get_annotation_class_name(annotation, module: str) -> str:
         return 'Any'
     elif annotation is AnyStr:
         return 'AnyStr'
-    elif inspect.isfunction(annotation) and hasattr(annotation, '__supertype__'):
+    elif (sys.version_info < (3, 10) and inspect.isfunction(annotation)
+          and hasattr(annotation, '__supertype__')) or \
+         (sys.version_info >= (3, 10) and isinstance(annotation, NewType)):
         return 'NewType'
 
     if getattr(annotation, '__qualname__', None):
@@ -120,7 +125,9 @@ def format_annotation(annotation,
     # Some types require special handling
     if full_name == 'typing.NewType':
         args_format = '\\(:py:data:`~{name}`, {{}})'.format(name=annotation.__name__)
-        role = 'func'
+        role = 'class' if sys.version_info >= (3, 10) else 'func'
+    elif full_name == 'typing.Optional':
+        args = tuple(x for x in args if x is not type(None))  # noqa: E721
     elif full_name == 'typing.Union' and type(None) in args:
         if len(args) == 2:
             full_name = 'typing.Optional'

tests/test_sphinx_autodoc_typehints.py

@@ -53,6 +53,9 @@ class Metaclass(type):
     pass
 
 
+PY310_PLUS = sys.version_info >= (3, 10)
+
+
 @pytest.mark.parametrize('annotation, module, class_name, args', [
     pytest.param(str, 'builtins', 'str', (), id='str'),
     pytest.param(None, 'builtins', 'None', (), id='None'),
@@ -151,7 +154,8 @@ def test_parse_annotation(annotation, module, class_name, args):
     (D,                             ':py:class:`~%s.D`' % __name__),
     (E,                             ':py:class:`~%s.E`' % __name__),
     (E[int],                        ':py:class:`~%s.E`\\[:py:class:`int`]' % __name__),
-    (W,                             ':py:func:`~typing.NewType`\\(:py:data:`~W`, :py:class:`str`)')
+    (W,                             f':py:{"class" if PY310_PLUS else "func"}:'
+                                    f'`~typing.NewType`\\(:py:data:`~W`, :py:class:`str`)')
 ])
 def test_format_annotation(inv, annotation, expected_result):
     result = format_annotation(annotation)
@@ -352,7 +356,7 @@ class InnerClass
               Return type:
                  "str"
 
-           property a_property
+           property a_property: str
 
               Property docstring
 
@@ -506,9 +510,7 @@ class dummy_module.DataClass(x)
 
            Class docstring.{undoc_params_0}
 
-           __init__(x)
-
-              Initialize self.  See help(type(self)) for accurate signature.{undoc_params_1}
+           __init__(x){undoc_params_1}
 
         @dummy_module.Decorator(func)