我正在使用 Python 的dir()
函数来确定类具有哪些属性和方法。
例如,要确定 中的方法wx.Frame
,我使用dir(wx.Frame)
是否有任何命令可以确定每种方法的参数列表?例如,如果我想知道哪些参数属于wx.Frame.CreateToolBar()
.
我正在使用 Python 的dir()
函数来确定类具有哪些属性和方法。
例如,要确定 中的方法wx.Frame
,我使用dir(wx.Frame)
是否有任何命令可以确定每种方法的参数列表?例如,如果我想知道哪些参数属于wx.Frame.CreateToolBar()
.
正如评论中提到的,您可以使用help(fun)
函数的签名和文档字符串进入帮助编辑器。您也可以简单地使用print fun.__doc__
,对于大多数成熟的库,您应该获得有关参数和函数签名的合理文档。
如果您正在谈论交互式帮助,请考虑使用具有一些有用附加功能的IPython 。例如,您可以键入%psource fun
以获取函数源代码的打印输出fun
,并且使用制表符完成,您只需键入wx.Frame.
然后按 TAB 即可查看其中可用的所有方法和属性的列表wx.Frame
。
尽管 GP89 似乎已经回答了这个问题,但我想我会更详细一点。
首先,GP89 的建议是使用 Python 的内置help()
方法。这是您可以在交互式控制台中使用的方法。对于方法,它将打印方法的声明行以及类的文档字符串(如果已定义)。您也可以通过以下方式访问它<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 文档库。那是我找到该help()
函数的文档的地方。你正在使用 wxPython,它的 API 可以在这里找到,所以快速搜索“wx.Frame api”,你可以找到描述所有wx.Frame
方法和变量的这个页面。不幸的是,CreatteToolBar()
没有特别好的文档记录,但您仍然可以看到它的论点:
CreateToolBar(self, style, winid, name)
快乐编码!