使用 pydoc 访问 Python "topic" docstring



我了解Python文档字符串的工作原理,并且经常使用pydoc.render_doc来访问函数文档字符串。但是,我不知道如何使用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

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

C:>python -m pydoc -w sys 系统写道.html

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

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

最新更新