summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-04-13 23:35:17 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2020-04-13 23:35:17 +0900
commit86ef8521df8d848c85f0df01943656aa78a10a62 (patch)
tree005d325543e87fd7e79d554d71563b6cecd4e91f
parente65fb93d2087d080bfa3a73d1f6b3097a41f077b (diff)
parentc8355234ebc63258004ad06da6bcf9dd7b98fac3 (diff)
downloadsphinx-git-86ef8521df8d848c85f0df01943656aa78a10a62.tar.gz
Merge branch '7461_empty_tuple' into 3.0.x
-rw-r--r--CHANGES3
-rw-r--r--sphinx/domains/python.py15
-rw-r--r--sphinx/pycode/ast.py5
-rw-r--r--tests/test_domain_py.py7
-rw-r--r--tests/test_pycode_ast.py1
5 files changed, 25 insertions, 6 deletions
diff --git a/CHANGES b/CHANGES
index 81674bef7..93c06e571 100644
--- a/CHANGES
+++ b/CHANGES
@@ -19,6 +19,9 @@ Features added
Bugs fixed
----------
+* #7461: py domain: fails with IndexError for empty tuple in type annotation
+* #7461: autodoc: empty tuple in type annotation is not shown correctly
+
Testing
--------
diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py
index 07a66fe22..19da49ac6 100644
--- a/sphinx/domains/python.py
+++ b/sphinx/domains/python.py
@@ -105,11 +105,16 @@ def _parse_annotation(annotation: str) -> List[Node]:
result.append(addnodes.desc_sig_punctuation('', ']'))
return result
elif isinstance(node, ast.Tuple):
- result = []
- for elem in node.elts:
- result.extend(unparse(elem))
- result.append(addnodes.desc_sig_punctuation('', ', '))
- result.pop()
+ if node.elts:
+ result = []
+ for elem in node.elts:
+ result.extend(unparse(elem))
+ result.append(addnodes.desc_sig_punctuation('', ', '))
+ result.pop()
+ else:
+ result = [addnodes.desc_sig_punctuation('', '('),
+ addnodes.desc_sig_punctuation('', ')')]
+
return result
else:
raise SyntaxError # unsupported syntax
diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py
index 4d8aa8955..fb2a7152d 100644
--- a/sphinx/pycode/ast.py
+++ b/sphinx/pycode/ast.py
@@ -114,7 +114,10 @@ def unparse(node: ast.AST) -> str:
elif isinstance(node, ast.UnaryOp):
return "%s %s" % (unparse(node.op), unparse(node.operand))
elif isinstance(node, ast.Tuple):
- return ", ".join(unparse(e) for e in node.elts)
+ if node.elts:
+ return ", ".join(unparse(e) for e in node.elts)
+ else:
+ return "()"
elif sys.version_info > (3, 6) and isinstance(node, ast.Constant):
# this branch should be placed at last
return repr(node.value)
diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py
index cc3d3cf53..e330ba634 100644
--- a/tests/test_domain_py.py
+++ b/tests/test_domain_py.py
@@ -255,6 +255,13 @@ def test_parse_annotation():
[pending_xref, "int"],
[desc_sig_punctuation, "]"]))
+ doctree = _parse_annotation("Tuple[()]")
+ assert_node(doctree, ([pending_xref, "Tuple"],
+ [desc_sig_punctuation, "["],
+ [desc_sig_punctuation, "("],
+ [desc_sig_punctuation, ")"],
+ [desc_sig_punctuation, "]"]))
+
doctree = _parse_annotation("Callable[[int, int], int]")
assert_node(doctree, ([pending_xref, "Callable"],
[desc_sig_punctuation, "["],
diff --git a/tests/test_pycode_ast.py b/tests/test_pycode_ast.py
index 117feb8f7..9b12d24d5 100644
--- a/tests/test_pycode_ast.py
+++ b/tests/test_pycode_ast.py
@@ -54,6 +54,7 @@ from sphinx.pycode import ast
("- 1", "- 1"), # UnaryOp
("- a", "- a"), # USub
("(1, 2, 3)", "1, 2, 3"), # Tuple
+ ("()", "()"), # Tuple (empty)
])
def test_unparse(source, expected):
module = ast.parse(source)