检索'帮助' python中对象的docstrings

时间:2014-06-22 01:51:41

标签: python documentation

我尝试使用pydoc.render_doc(object)将对象的帮助文档作为字符串获取。但是由于某种原因,这样做会使给定对象的所有方法名称显得非常奇怪;其他每个角色都是' \ x08'和字母按两个分组。例如,__new__ ____nneeww____(' \ x08'由于某种原因不会在这里呈现)。关于什么可能导致问题的任何想法?

1 个答案:

答案 0 :(得分:1)

pydoc必须是相当古老的模块。

pydoc发出机械打印机噪音

\x08字符是退格的,我看到的东西让我微笑了一下:

>>> pydoc.render_doc(object)
'Python Library Documentation: class object in module __builtin__\n\nclass o\x08ob\x08bj\x08je\x08ec\x08ct\x08t\n |  The most base type\n'

看起来,就像这个模块的默认期望是将输出打印到真正的机械打印机。

退格会导致滑架向后移动一个角色,重复的角色会在后退位置再次打印出来。

这可能会导致它在机械打印机上以粗体显示。

如果您想摆脱这种特殊装饰,请使用pydoc.plain

>>> pydoc.plain(pydoc.render_doc(object))
'Python Library Documentation: class object in module __builtin__\n\nclass object\n |  The most base type\n'

一点历史(2001)

Python stdlib doc声明,pydocNew in version 2.1.

维基百科称,Python 2.1 was released April 17, 2001