Parsing Python Module Docstrings

Question

Возможно ли разобрать докстроны уровня модуля с AST?

Я работаю над документатором python here и, посещая модульные маркеры и захватывая документацию, не уступает docstring модуля. До сих пор мне приходилось прибегать к импорту модуля и захвату его __doc__ или с использованием inspect, чтобы получить документацию.

Я заглянул в источник информации о том, как другие документалисты разбирают докстры, и обнаружил, что pydoc заканчивается тем, что должен делать в основном то же самое, что и мой документатор, чтобы захватить строки уровня модуля.

Я что-то упустил? Единственный способ разобрать docstrings на уровне модуля, фактически импортируя модуль, или можно ли напрямую разбирать docstrings из AST?

Answer 1

Возможно, я пропустил понимание вопроса, но разве вы не можете это сделать (python 2.7.1)?

тестовый файл:

""" 
DOC STRING!! 
""" 

def hello(): 
    'doc string' 
    print 'hello' 

hello() 

Интерактивная сессия:.

>>> M = ast.parse(''.join(open('test.py'))) 
>>> ast.get_docstring(M) 
'DOC STRING!!' 

Вы также можете пройти через аст, ищет слот струна док будет в

>>> M._fields 
('body',) 
>>> M.body 
[<_ast.Expr object at 0x10e5ac710>, <_ast.FunctionDef object at 0x10e5ac790>, <_ast.Expr object at 0x10e5ac910>] 
>>> # doc would be in the first slot 
>>> M.body[0]._fields 
('value',) 
>>> M.body[0].value 
<_ast.Str object at 0x10e5ac750> 
>>> # it contains a string object, so maybe it's the doc string 
>>> M.body[0].value._fields 
('s',) 
>>> M.body[0].value.s 
'\nDOC STRING!!\n'