IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

autodoc: an imported TypeVar is not resolved (refs: #8415)

Browse Source 
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: #7119)
This commit is contained in:
Takeshi KOMIYA 2020-11-15 13:58:12 +09:00
parent 6ca7c1c579
commit 7d3cc382fa
4 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -72,6 +72,8 @@ Bugs fixed
---------- ----------
* #8917: autodoc: Raises a warning if function has wrong __globals__ value * #8917: autodoc: Raises a warning if function has wrong __globals__ value
* #8415: autodoc: a TypeVar imported from other module is not resolved (in
Python 3.7 or above)
* #8380: html search: Paragraphs in search results are not identified as ``<p>`` * #8380: html search: Paragraphs in search results are not identified as ``<p>``
* #8915: html theme: The translation of sphinx_rtd_theme does not work * #8915: html theme: The translation of sphinx_rtd_theme does not work
* #8342: Emit a warning if a unknown domain is given for directive or role (ex. * #8342: Emit a warning if a unknown domain is given for directive or role (ex.

5
sphinx/util/typing.py
View File

@ -263,7 +263,10 @@ def stringify(annotation: Any) -> str:
else: else:
return annotation return annotation
elif isinstance(annotation, TypeVar): elif isinstance(annotation, TypeVar):
return annotation.__name__ if annotation.__module__ == 'typing':
return annotation.__name__
else:
return '.'.join([annotation.__module__, annotation.__name__])
elif inspect.isNewType(annotation): elif inspect.isNewType(annotation):
# Could not get the module where it defiend # Could not get the module where it defiend
return annotation.__name__ return annotation.__name__

8
tests/test_util_inspect.py
View File

@ -142,7 +142,13 @@ def test_signature_annotations():
# TypeVars and generic types with TypeVars # TypeVars and generic types with TypeVars
sig = inspect.signature(f2) 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[tests.typing_test_data.T],'
' y: List[tests.typing_test_data.T_co],'
' z: tests.typing_test_data.T'
') -> List[tests.typing_test_data.T_contra]')
# Union types # Union types
sig = inspect.signature(f3) sig = inspect.signature(f3)

15
tests/test_util_typing.py
View File

@ -194,10 +194,17 @@ def test_stringify_type_hints_typevars():
T_co = TypeVar('T_co', covariant=True) T_co = TypeVar('T_co', covariant=True)
T_contra = TypeVar('T_contra', contravariant=True) T_contra = TypeVar('T_contra', contravariant=True)
assert stringify(T) == "T" if sys.version_info < (3, 7):
assert stringify(T_co) == "T_co" assert stringify(T) == "T"
assert stringify(T_contra) == "T_contra" assert stringify(T_co) == "T_co"
assert stringify(List[T]) == "List[T]" assert stringify(T_contra) == "T_contra"
assert stringify(List[T]) == "List[T]"
else:
assert stringify(T) == "tests.test_util_typing.T"
assert stringify(T_co) == "tests.test_util_typing.T_co"
assert stringify(T_contra) == "tests.test_util_typing.T_contra"
assert stringify(List[T]) == "List[tests.test_util_typing.T]"
assert stringify(MyInt) == "MyInt" assert stringify(MyInt) == "MyInt"