python - 是否可以选择打印 help() 的输出？

Question

是否有打印帮助（'myfun'）输出的选项。我看到的行为是输出被打印到 std.out 并且脚本等待用户输入（即输入“q”继续）。

必须有一个设置将其设置为仅转储文档字符串。

或者，如果我可以只转储文档字符串加上“def f(args):”行，那也可以。

搜索“python 帮助功能”很可笑。:) 也许我在某个地方错过了一些很好的 pydoc 页面来解释这一切？

Answer 1

要准确获得打印help(str)到变量中的帮助strhelp：

import pydoc
strhelp = pydoc.render_doc(str, "Help on %s")

当然，您可以轻松打印它而无需分页等。

Answer 2

如果您想从代码中访问原始文档字符串：

   myvar = obj.__doc__
   print(obj.__doc__)

帮助函数做了一些额外的处理，接受的答案显示了如何用 pydoc.render_doc() 复制它。

Answer 3

您已经看到了对 docstring 的引用，__doc__它是保存帮助正文的魔法变量：

def foo(a,b,c): 
   ''' DOES NOTHING!!!! '''
   pass

print foo.__doc__ # DOES NOTHING!!!!

要获取函数的名称，您只需使用__name__：

def foo(a,b,c): pass

print foo.__name__ # foo

获取非内置函数签名的方法可以使用 func_code 属性，从中可以读取它的 co_varnames：

def foo(a,b,c): pass
print foo.func_code.co_varnames # ('a', 'b', 'c')

我还没有发现如何对内置函数做同样的事情。

Answer 4

>>> x = 2
>>> x.__doc__
'int(x[, base]) -> integer\n\nConvert a string or number to an integer, if possi
ble.  A floating point\nargument will be truncated towards zero (this does not i
nclude a string\nrepresentation of a floating point number!)  When converting a
string, use\nthe optional base.  It is an error to supply a base when converting
 a\nnon-string. If the argument is outside the integer range a long object\nwill
 be returned instead.'

那是你需要的吗？

编辑 - 您可以print(x.__doc__)并且关于函数签名，您可以使用inspect模块构建它。

>>> inspect.formatargspec(inspect.getargspec(os.path.join))
'((a,), p, None, None)'
>>> help(os.path.join)
Help on function join in module ntpath:

join(a, *p)
    Join two or more pathname components, inserting "\" as needed