时间戳

首页 > 解决方案 > 如何使用 pydoc 仅查看文档文本

python - 如何使用 pydoc 仅查看文档文本

问题描述

作为一名 perl 开发人员，我知道perldoc实用程序。我是 python 新手，我一直在寻找相同的东西并找到了pydoc。但是 pydoc 的问题是它也在执行我的脚本，而我只想看到写在三引号内的文档。任何帮助，将不胜感激。

标签： pythonperlpydocperldoc

解决方案

可能最好的方法是在 Python 中工作（而不是命令行）。我们以模块sys为例。首先导入你的模块，然后使用help()，像这样：

import sys
help(sys)

如果您想查看文档字符串：

print(sys.__doc__)

对于您自己开发的模块，您可以构建一个守卫，以便不执行该模块，如文档中所述：

注意：为了查找对象及其文档，pydoc 会导入要记录的模块。因此，模块级别的任何代码都将在这种情况下执行。if __name__ == '__main__':仅当文件作为脚本调用而不仅仅是导入时，才使用警卫执行代码。

推荐阅读