如何在Python模块中获取方法名称和文档字符串的完整列表？

Question

如何在Python模块中获取方法名称/文档字符串，以便我可以搜索是否存在任何我想要的内容？我应该得到所有的方法名称和文档字符串。 我想在我们的项目中实现DRY方法，所以如果我们可以有可浏览的API列表，那么我们可以很容易地搜索现有函数是否存在或至少有一些功能可以执行类似的工作。

Answer 1

如果模块/类/方法用文档字符串记录，则可以通过__doc__属性检索此类文档。

如果您想知道给定对象（模块，类）可用的属性，可以使用dir()内置函数。

举例gnupg模块（未内建，但开源）：

>>> import gnupg 
>>> dir(gnupg) 
['Crypt', 'DeleteResult', 'GPG', 'GenKey', ... 
>>> gnupg.Crypt.__doc__ 
'Handle status messages for --encrypt and --decrypt' 
>>> 

使用dir()和__doc__您可以导出这些信息可以通过Excel中使用CSV文件。