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 #8008: py domain: failed to parse a type annotation containing ellipsis

Browse Source 
Fix _parse_annotation() does not support a type annotation having ellipsis.
This commit is contained in:
Takeshi KOMIYA 2020-07-30 01:41:18 +09:00
parent bb65ea7930
commit a99675bf78
3 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -69,6 +69,7 @@ Bugs fixed
* #7691: linkcheck: HEAD requests are not used for checking * #7691: linkcheck: HEAD requests are not used for checking
* #4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation * #4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation
* #7928: py domain: failed to resolve a type annotation for the attribute * #7928: py domain: failed to resolve a type annotation for the attribute
* #8008: py domain: failed to parse a type annotation containing ellipsis
* #7994: std domain: option directive does not generate old node_id compatible * #7994: std domain: option directive does not generate old node_id compatible
with 2.x or older with 2.x or older
* #7968: i18n: The content of ``math`` directive is interpreted as reST on * #7968: i18n: The content of ``math`` directive is interpreted as reST on

14
sphinx/domains/python.py
View File

@ -11,6 +11,7 @@
import builtins import builtins
import inspect import inspect
import re import re
import sys
import typing import typing
import warnings import warnings
from inspect import Parameter from inspect import Parameter
@ -134,6 +135,19 @@ def _parse_annotation(annotation: str, env: BuildEnvironment = None) -> List[Nod
return result return result
else: else:
if sys.version_info >= (3, 6):
if isinstance(node, ast.Constant):
if node.value is Ellipsis:
return [addnodes.desc_sig_punctuation('', "...")]
else:
return [nodes.Text(node.value)]
if sys.version_info < (3, 8):
if isinstance(node, ast.Ellipsis):
return [addnodes.desc_sig_punctuation('', "...")]
elif isinstance(node, ast.NameConstant):
return [nodes.Text(node.value)]
raise SyntaxError # unsupported syntax raise SyntaxError # unsupported syntax
if env is None: if env is None:

14
tests/test_domain_py.py
View File

@ -262,6 +262,14 @@ def test_parse_annotation(app):
[desc_sig_punctuation, ")"], [desc_sig_punctuation, ")"],
[desc_sig_punctuation, "]"])) [desc_sig_punctuation, "]"]))
doctree = _parse_annotation("Tuple[int, ...]", app.env)
assert_node(doctree, ([pending_xref, "Tuple"],
[desc_sig_punctuation, "["],
[pending_xref, "int"],
[desc_sig_punctuation, ", "],
[desc_sig_punctuation, "..."],
[desc_sig_punctuation, "]"]))
doctree = _parse_annotation("Callable[[int, int], int]", app.env) doctree = _parse_annotation("Callable[[int, int], int]", app.env)
assert_node(doctree, ([pending_xref, "Callable"], assert_node(doctree, ([pending_xref, "Callable"],
[desc_sig_punctuation, "["], [desc_sig_punctuation, "["],
@ -274,6 +282,12 @@ def test_parse_annotation(app):
[pending_xref, "int"], [pending_xref, "int"],
[desc_sig_punctuation, "]"])) [desc_sig_punctuation, "]"]))
doctree = _parse_annotation("List[None]", app.env)
assert_node(doctree, ([pending_xref, "List"],
[desc_sig_punctuation, "["],
[pending_xref, "None"],
[desc_sig_punctuation, "]"]))
# None type makes an object-reference (not a class reference) # None type makes an object-reference (not a class reference)
doctree = _parse_annotation("None", app.env) doctree = _parse_annotation("None", app.env)
assert_node(doctree, ([pending_xref, "None"],)) assert_node(doctree, ([pending_xref, "None"],))