Skip to content

Commit

Permalink
autodoc: an imported TypeVar is not resolved (refs: sphinx-doc#8415)
Browse files Browse the repository at this point in the history
So far, a TypeVar is rendered without module name. As a result, it
could not be resolved if it is imported from other modules.  This
prepends its module name and make it resolvable.  This is available
only in Python 3.7 or above.

As a side effect, all of TypeVars are displayed with module name. It
should be fixed in latter step (refs: sphinx-doc#7119)
  • Loading branch information
tk0miya committed Nov 15, 2020
1 parent 4c582b3 commit c16a71c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGES
Expand Up @@ -27,6 +27,8 @@ Features added
* autodoc: Add ``Documenter.config`` as a shortcut to access the config object
* autodoc: Add Optional[t] to annotation of function and method if a default
value equal to None is set.
* #8415: autodoc: a TypeVar imported from other module is not resolved (in
Python 3.7 or above)
* #6914: Add a new event :event:`warn-missing-reference` to custom warning
messages when failed to resolve a cross-reference
* #6914: Emit a detailed warning when failed to resolve a ``:ref:`` reference
Expand Down
5 changes: 4 additions & 1 deletion sphinx/util/typing.py
Expand Up @@ -261,7 +261,10 @@ def stringify(annotation: Any) -> str:
else:
return annotation
elif isinstance(annotation, TypeVar):
return annotation.__name__
if annotation.__module__ == 'typing':
return annotation.__name__
else:
return '.'.join([annotation.__module__, annotation.__name__])
elif not annotation:
return repr(annotation)
elif annotation is NoneType:
Expand Down
6 changes: 5 additions & 1 deletion tests/test_util_inspect.py
Expand Up @@ -142,7 +142,11 @@ def test_signature_annotations():

# TypeVars and generic types with TypeVars
sig = inspect.signature(f2)
assert stringify_signature(sig) == '(x: List[T], y: List[T_co], z: T) -> List[T_contra]'
if sys.version_info < (3, 7):
assert stringify_signature(sig) == '(x: List[T], y: List[T_co], z: T) -> List[T_contra]'
else:
assert stringify_signature(sig) == ('(x: List[typing_test_data.T], y: List[typing_test_data.T_co], '
'z: typing_test_data.T) -> List[typing_test_data.T_contra]')

# Union types
sig = inspect.signature(f3)
Expand Down
14 changes: 10 additions & 4 deletions tests/test_util_typing.py
Expand Up @@ -174,10 +174,16 @@ def test_stringify_type_hints_typevars():
T_co = TypeVar('T_co', covariant=True)
T_contra = TypeVar('T_contra', contravariant=True)

assert stringify(T) == "T"
assert stringify(T_co) == "T_co"
assert stringify(T_contra) == "T_contra"
assert stringify(List[T]) == "List[T]"
if sys.version_info < (3, 7):
assert stringify(T) == "T"
assert stringify(T_co) == "T_co"
assert stringify(T_contra) == "T_contra"
assert stringify(List[T]) == "List[T]"
else:
assert stringify(T) == "test_util_typing.T"
assert stringify(T_co) == "test_util_typing.T_co"
assert stringify(T_contra) == "test_util_typing.T_contra"
assert stringify(List[T]) == "List[test_util_typing.T]"


def test_stringify_type_hints_custom_class():
Expand Down

0 comments on commit c16a71c

Please sign in to comment.