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

时间:2018-08-20 06:07:01

标签: python perl pydoc perldoc

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

1 个答案:

答案 0 :(得分:2)

最好的方法可能是在Python中工作(而不是命令行)。让我们以模块sys为例。首先导入您的模块,然后使用help(),如下所示:

import sys
help(sys)

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

print(sys.__doc__)

对于您自己开发的模块,可以构建保护程序,以使模块不执行,如documentation中所述:

  

注意:为了找到对象及其文档,pydoc导入了要记录的模块。因此,此时将执行模块级别的任何代码。使用if __name__ == '__main__':保护只能在将文件作为脚本调用而不仅仅是导入时执行代码。