Skip to content

Commit

Permalink
Fix #8157: autodoc: TypeError is raised when annotation has invalid _…
Browse files Browse the repository at this point in the history
…_args__

Typically, the __args__ attribute of type annotations is a tuple
containing arguments for the types (ex. The __args__ of `List[int]` is
`(int,)`).  But some kind of types has non tuple __args__ attribute.
For example, `nptyping.NDArray` is one of them.

This fixes the TypeError when the invalid __args__ attribute found.
  • Loading branch information
tk0miya committed Oct 4, 2020
1 parent d1f8ddd commit 9a0a0f9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES
Expand Up @@ -34,6 +34,7 @@ Bugs fixed
by string not ending with blank lines
* #8142: autodoc: Wrong constructor signature for the class derived from
typing.Generic
* #8157: autodoc: TypeError is raised when annotation has invalid __args__
* #8192: napoleon: description is disappeared when it contains inline literals
* #8142: napoleon: Potential of regex denial of service in google style docs
* #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
Expand Down
5 changes: 4 additions & 1 deletion sphinx/util/typing.py
Expand Up @@ -109,7 +109,10 @@ def _stringify_py37(annotation: Any) -> str:
return repr(annotation)

if getattr(annotation, '__args__', None):
if qualname == 'Union':
if not isinstance(annotation.__args__, (list, tuple)):
# broken __args__ found
pass
elif qualname == 'Union':
if len(annotation.__args__) > 1 and annotation.__args__[-1] is NoneType:
if len(annotation.__args__) > 2:
args = ', '.join(stringify(a) for a in annotation.__args__[:-1])
Expand Down
8 changes: 8 additions & 0 deletions tests/test_util_typing.py
Expand Up @@ -32,6 +32,10 @@ class MyList(List[T]):
pass


class BrokenType:
__args__ = int


def test_stringify():
assert stringify(int) == "int"
assert stringify(str) == "str"
Expand Down Expand Up @@ -113,3 +117,7 @@ def test_stringify_type_hints_alias():
MyTuple = Tuple[str, str]
assert stringify(MyStr) == "str"
assert stringify(MyTuple) == "Tuple[str, str]" # type: ignore


def test_stringify_broken_type_hints():
assert stringify(BrokenType) == 'test_util_typing.BrokenType'

0 comments on commit 9a0a0f9

Please sign in to comment.