Question

我正在尝试构建一个帮助系统，我想从一个包含某个单词的Python模块中依次打印所有方法文档。这适用于具有大量方法或属性的模块。现在这就是我正在做的事情，例如，对于像Tkinter.Entry这样的模块，寻找具有例如'set'的方法：

q = []
for i in dir(Tkinter.Entry):
    if 'set' in i:
       q.append(i)
for item in q:
    help(item)

这显示了每个方法的七个pydoc项，名称中的'set'一个接一个地出现，并在解释器上干净地退出。但是，我似乎无法在赋值中获取pydoc，例如：

x = help(item)   # doesn't work.
# handle display code here.

我在这里缺少什么？

以下内容适用于上下文，因为不一定是问题的一部分（例如）：

是否有解决方法可以获得与此相同的效果，例如，每次用户点击时会显示下一个帮助项目的简单html，当前元素上的“关闭”？

<html>
  <head> 
    Help page 
  </head>
  <script type="text/javascript">
    $ function closediv(){
      <!-- code to close the div goes here-->
      }
  </script>
  <body>
    <!--maybe a list of divs here-->
    <div id="help text">{% block content %} {{x}} {% endblock %}</div>
  </body>
 </html>

只要我能找到一种方法来找到一种方法来获取可以传递给块内容{{X}}的方式的帮助文本，我将尝试找出其余部分。感谢。

Answer 1

您可以尝试.__doc__以便对某些关键术语有一个很好的理解：

>>> print pow.__doc__
pow(x, y[, z]) -> number

With two arguments, equivalent to x**y.  With three arguments,
equivalent to (x**y) % z, but may be more efficient (e.g. for longs).
>>> print list.__doc__
list() -> new empty list
list(iterable) -> new list initialized from iterable's items
>>>

只有help(item)不能与simple statements一起使用。这与.__doc__：

相同

>>> help(if)
  File "<stdin>", line 1
    help(if)
          ^
SyntaxError: invalid syntax
>>> if.__doc__
  File "<stdin>", line 1
    if.__doc__
      ^
SyntaxError: invalid syntax
>>>

我建议查看pydoc.py：

>>> import pydoc
>>> pydoc
<module 'pydoc' from '/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/pydoc.pyc'>
>>>

其中包含所有内容的所有文档，包括简单的陈述。

使用模块中的某个单词显示所有方法和属性的python文档

1 个答案: