用于确定方法的Python dir命令

时间:2012-09-22 18:08:58

标签: python api documentation wxpython

我正在使用Python的dir()函数来确定类具有哪些属性和方法。

例如,为了确定wx.Frame中的方法,我使用dir(wx.Frame)

是否有任何命令来确定每个方法的参数列表?例如,如果我想知道哪些参数属于wx.Frame.CreateToolBar()

1 个答案:

答案 0 :(得分:1)

尽管GP89似乎已​​经回答了这个问题,但我还是认为我会更详细地介绍一下。

首先,GP89的建议是使用Python的内置help() method。这是您可以在交互式控制台中使用的方法。对于方法,如果已定义,它将打印方法的声明行以及类“docstring”。您也可以使用<object>.__doc__访问此内容,例如:

>>> def testHelp(arg1, arg2=0):
...    """This is the docstring that will print when you
...    call help(testHelp). testHelp.__doc__ will also
...    return this string. Here is where you should
...    describe your method and all its arguments."""
...
>>> help(testHelp)
Help on function testHelp in module __main__:

testHelp(arg1, arg2=0)
    This is the docstring that will print when you
    call help(testHelp). testHelp.__doc__ will also
    return this string. Here is where you should
    describe your method and all its arguments.
>>>

然而,用于理解方法,类和函数的另一个非常重要的工具是工具包的API。对于内置Python函数,您应该检查Python Doc Library。这就是我找到help()函数的文档的地方。您正在使用wxPython,其API可以找到here,因此快速搜索“wx.Frame api”,您可以找到this page describing all of wx.Frame's methods and variables.遗憾的是,CreatteToolBar()并未特别详细记录但你仍然可以看到它的论点:

  

CreateToolBar(self,style,winid,name)

快乐的编码!