解析 Python 模块文档字符串

Question

是否可以使用 AST 解析模块级文档字符串？

我在这里使用 python 文档，访问模块令牌并获取文档不会产生模块级文档字符串。到目前为止，我不得不求助于导入模块并抓取它__doc__或使用inspect抓取文档。

我查看了pydoc 模块源以获取有关其他文档编写者如何解析文档字符串的线索，并发现 pydoc 最终必须与我的文档编写者做基本相同的事情才能获取模块级字符串。

我错过了什么吗？是通过实际导入模块来解析模块级文档字符串的唯一方法，还是可以直接从 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!!'

您还可以遍历 ast，寻找文档字符串所在的插槽。

>>> 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'