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

refactor: py domain: Add type_to_xref() utility

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-05-02 22:41:29 +09:00
parent c13ecd2437
commit 8f4c2fb08d
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sphinx/domains/python.py
View File

@ -77,9 +77,8 @@ ModuleEntry = NamedTuple('ModuleEntry', [('docname', str),
('deprecated', bool)]) ('deprecated', bool)])
def _parse_annotation(annotation: str) -> List[Node]: def type_to_xref(text: str) -> addnodes.pending_xref:
"""Parse type annotation.""" """Convert a type string to a cross reference node."""
def make_xref(text: str) -> addnodes.pending_xref:
if text == 'None': if text == 'None':
reftype = 'obj' reftype = 'obj'
else: else:
@ -88,6 +87,9 @@ def _parse_annotation(annotation: str) -> List[Node]:
return pending_xref('', nodes.Text(text), return pending_xref('', nodes.Text(text),
refdomain='py', reftype=reftype, reftarget=text) refdomain='py', reftype=reftype, reftarget=text)
def _parse_annotation(annotation: str) -> List[Node]:
"""Parse type annotation."""
def unparse(node: ast.AST) -> List[Node]: def unparse(node: ast.AST) -> List[Node]:
if isinstance(node, ast.Attribute): if isinstance(node, ast.Attribute):
return [nodes.Text("%s.%s" % (unparse(node.value)[0], node.attr))] return [nodes.Text("%s.%s" % (unparse(node.value)[0], node.attr))]
@ -133,10 +135,10 @@ def _parse_annotation(annotation: str) -> List[Node]:
result = unparse(tree) result = unparse(tree)
for i, node in enumerate(result): for i, node in enumerate(result):
if isinstance(node, nodes.Text): if isinstance(node, nodes.Text):
result[i] = make_xref(str(node)) result[i] = type_to_xref(str(node))
return result return result
except SyntaxError: except SyntaxError:
return [make_xref(annotation)] return [type_to_xref(annotation)]
def _parse_arglist(arglist: str) -> addnodes.desc_parameterlist: def _parse_arglist(arglist: str) -> addnodes.desc_parameterlist: