首页 / PYTHON / 解析Python模块文档字符串

解析Python模块文档字符串

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了解析Python模块文档字符串，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1118字，纯文字阅读大概需要2分钟。

内容图文

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

我正在使用python documenter here并访问模块令牌,而抓取文档不会产生模块级docstring.到目前为止,我不得不求助于导入模块并获取其__doc__或使用inspect来获取文档.

我查看了pydoc module来源,以了解其他文档编制者如何解析docstrings的线索,并发现pydoc最终必须要做与我的文档编制者基本相同的事情才能获取模块级字符串.

我想念什么吗？是通过实际导入模块解析模块级文档字符串的唯一方法,还是可以直接从AST中解析文档字符串？

解决方法:

也许我错过了这个问题,但是您不能这样做吗(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,查找doc字符串所在的插槽.

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

内容总结

以上是互联网集市为您收集整理的解析Python模块文档字符串全部内容，希望文章能够帮你解决解析Python模块文档字符串所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/673616.html

来源：【匿名】