python - 如何在 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 文件。