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

Fix #5322: autodoc: `Any` typehint causes formatting error

Browse Source
This commit is contained in:
Takeshi KOMIYA
2018-08-21 20:05:17 +09:00
parent 2371614227
commit 59a766d7d6
4 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@@ -16,6 +16,8 @@ Features added
Bugs fixed Bugs fixed
---------- ----------
* #5322: autodoc: ``Any`` typehint causes formatting error
Testing Testing
-------- --------

4
sphinx/util/inspect.py
View File

@@ -531,8 +531,10 @@ class Signature(object):
qualname = annotation.__qualname__ qualname = annotation.__qualname__
elif getattr(annotation, '__forward_arg__', None): elif getattr(annotation, '__forward_arg__', None):
qualname = annotation.__forward_arg__ qualname = annotation.__forward_arg__
else: elif getattr(annotation, '__origin__', None):
qualname = self.format_annotation(annotation.__origin__) # ex. Union qualname = self.format_annotation(annotation.__origin__) # ex. Union
else:
qualname = repr(annotation).replace('typing.', '')
elif hasattr(annotation, '__qualname__'): elif hasattr(annotation, '__qualname__'):
qualname = '%s.%s' % (module, annotation.__qualname__) qualname = '%s.%s' % (module, annotation.__qualname__)
else: else:

6
tests/test_util_inspect.py
View File

@@ -232,7 +232,7 @@ def test_Signature_partialmethod():
reason='type annotation test is available on py34 or above') reason='type annotation test is available on py34 or above')
def test_Signature_annotations(): def test_Signature_annotations():
from typing_test_data import ( from typing_test_data import (
f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, Node) f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, Node)
# Class annotations # Class annotations
sig = inspect.Signature(f0).format_args() sig = inspect.Signature(f0).format_args()
@@ -293,6 +293,10 @@ def test_Signature_annotations():
sig = inspect.Signature(f13).format_args() sig = inspect.Signature(f13).format_args()
assert sig == '() -> Optional[str]' assert sig == '() -> Optional[str]'
# Any
sig = inspect.Signature(f14).format_args()
assert sig == '() -> Any'
# type hints by string # type hints by string
sig = inspect.Signature(Node.children).format_args() sig = inspect.Signature(Node.children).format_args()
assert sig == '(self) -> List[typing_test_data.Node]' assert sig == '(self) -> List[typing_test_data.Node]'

6
tests/typing_test_data.py
View File

@@ -1,5 +1,5 @@
from numbers import Integral from numbers import Integral
from typing import List, TypeVar, Union, Callable, Tuple, Optional from typing import Any, List, TypeVar, Union, Callable, Tuple, Optional
def f0(x: int, y: Integral) -> None: def f0(x: int, y: Integral) -> None:
@@ -72,6 +72,10 @@ def f13() -> Optional[str]:
pass pass
def f14() -> Any:
pass
class Node: class Node:
def __init__(self, parent: Optional['Node']) -> None: def __init__(self, parent: Optional['Node']) -> None:
pass pass