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

autodoc: Support type_comment styled type annotation for variables

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-02-01 13:38:34 +09:00
parent 20126433d6
commit 92cb828f14
6 changed files with 52 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
sphinx/ext/autodoc/__init__.py
View File

@ -1239,6 +1239,11 @@ class DataDocumenter(ModuleLevelDocumenter):
if self.objpath[-1] in annotations:
objrepr = stringify_typehint(annotations.get(self.objpath[-1]))
self.add_line(' :type: ' + objrepr, sourcename)
else:
key = ('.'.join(self.objpath[:-1]), self.objpath[-1])
if self.analyzer and key in self.analyzer.annotations:
self.add_line(' :type: ' + self.analyzer.annotations[key],
sourcename)
try:
objrepr = object_description(self.object)

2
sphinx/pycode/ast.py
View File

@ -38,6 +38,8 @@ def unparse(node: ast.AST) -> str:
"""Unparse an AST to string."""
if node is None:
return None
elif isinstance(node, str):
return node
elif isinstance(node, ast.Attribute):
return "%s.%s" % (unparse(node.value), node.attr)
elif isinstance(node, ast.Bytes):

8
sphinx/pycode/parser.py
View File

@ -311,10 +311,12 @@ class VariableCommentPicker(ast.NodeVisitor):
return # this assignment is not new definition!
# record annotation
annotation = getattr(node, 'annotation', None)
if annotation:
if hasattr(node, 'annotation') and node.annotation: # type: ignore
for varname in varnames:
self.add_variable_annotation(varname, annotation)
self.add_variable_annotation(varname, node.annotation) # type: ignore
elif hasattr(node, 'type_comment') and node.type_comment:
for varname in varnames:
self.add_variable_annotation(varname, node.type_comment) # type: ignore
# check comments after assignment
parser = AfterCommentParser([current_line[node.col_offset:]] +

9
tests/roots/test-ext-autodoc/target/typed_vars.py
View File

@ -2,12 +2,17 @@
attr1: str = ''
#: attr2
attr2: str
#: attr3
attr3 = '' # type: str
class Class:
attr1: int = 0
attr2: int
attr3 = 0 # type: int
def __init__(self):
self.attr3: int = 0 #: attr3
self.attr4: int #: attr4
self.attr4: int = 0 #: attr4
self.attr5: int #: attr5
self.attr6 = 0 # type: int
"""attr6"""

30
tests/test_autodoc.py
View File

@ -1418,9 +1418,7 @@ def test_autodoc_typed_instance_variables(app):
' .. py:attribute:: Class.attr3',
' :module: target.typed_vars',
' :type: int',
' :value: None',
' ',
' attr3',
' :value: 0',
' ',
' ',
' .. py:attribute:: Class.attr4',
@ -1431,6 +1429,22 @@ def test_autodoc_typed_instance_variables(app):
' attr4',
' ',
' ',
' .. py:attribute:: Class.attr5',
' :module: target.typed_vars',
' :type: int',
' :value: None',
' ',
' attr5',
' ',
' ',
' .. py:attribute:: Class.attr6',
' :module: target.typed_vars',
' :type: int',
' :value: None',
' ',
' attr6',
' ',
'',
'.. py:data:: attr1',
' :module: target.typed_vars',
' :type: str',
@ -1442,9 +1456,17 @@ def test_autodoc_typed_instance_variables(app):
'.. py:data:: attr2',
' :module: target.typed_vars',
' :type: str',
" :value: None",
' :value: None',
'',
' attr2',
' ',
'',
'.. py:data:: attr3',
' :module: target.typed_vars',
' :type: str',
" :value: ''",
'',
' attr3',
' '
]

10
tests/test_pycode_parser.py
View File

@ -99,15 +99,19 @@ def test_annotated_assignment_py36():
source = ('a: str = "Sphinx" #: comment\n'
'b: int = 1\n'
'"""string on next line"""\n'
'c: int #: comment')
'c: int #: comment\n'
'd = 1 # type: int\n'
'"""string on next line"""\n')
parser = Parser(source)
parser.parse()
assert parser.comments == {('', 'a'): 'comment',
('', 'b'): 'string on next line',
('', 'c'): 'comment'}
('', 'c'): 'comment',
('', 'd'): 'string on next line'}
assert parser.annotations == {('', 'a'): 'str',
('', 'b'): 'int',
('', 'c'): 'int'}
('', 'c'): 'int',
('', 'd'): 'int'}
assert parser.definitions == {}