使用pydoc访问Python“主题”文档字符串

时间:2017-07-25 05:24:13

标签: python pydoc

我理解Python docstrings是如何工作的,我经常使用pydoc.render_doc来访问函数docstrings。但是,我不知道如何使用render_doc来访问帮助主题,例如help("UNARY")。我甚至不知道这样的文档字符串存在于何处。有没有办法 a)使用pydoc访问帮助主题或 b)是另一种捕获变量中帮助文本的方法吗?

help("UNARY")                         # prints help to console
import pydoc
pydoc.help("UNARY")                   # prints help to console
test = pydoc.render_doc("str")        # writes help to variable

test = pydoc.render_doc("UNARY")      # ERROR
pydoc.help("UNARY")                   # prints help to console
test = pydoc.help("UNARY")            # prints help to console, 'test' is empty

1 个答案:

答案 0 :(得分:1)

pydoc将在命令行中运行。使用以下命令为当前位置的python模块生成html文档。

C:> python -m pydoc -w sys 写了sys.html

但是pydoc命令不能用于关键字和主题

请参阅https://svn.python.org/projects/sandbox/trunk/setuptools/pydoc.py以了解主题和关键字列表。