python标准库: 开发工具

pydoc:模块的联机帮助

纯文本帮助 

  python提供了很好的帮助文档,如果想要获取一个模块的帮助文档,就可以使用一个叫做pydoc的模块,这个模块可以叫出你想要了解的模块的帮助文档。

  首先需要了解一个概念:python的命令行。

  这个叫做python的命令行,其实就是python的终端:

  或者这个也是:

  pydoc的命令需要在这里进行执行。命令的执行方式非常简单,只需要使用pydoc 模块名

   pydoc atexit

  终端(命令行)就会直接给出帮助文档,如果你觉得这样看起来并不方便,pydoc还提供了HTML帮助文档。

HTML帮助

  该命令会将生成的一个纯文本格式写进一个本地目录,或者直接在本地ipweb服务器上在线浏览文档。

   pydoc -w atexit

  这个代码将会在本地生成一个atexit.html。你可以直接在pycharm中找到,利用浏览器打开它。打开之后,你将会看到这个atexit模块的信息。

  除此之外,还有一个命令更加的强大,利用它,你可以查找任何一个你想要的模块:

   pydoc -p 5000

  这个命令将启动一个web服务器开始监听http://localhost:5000/,这个服务器会在你浏览时动态生成文档。使用b命令可以自动打开一个浏览器窗口,使用q会停止服务器。

 

 

  

  

 

  

 

 

 

 

 

 

 

 

 

 

 

posted on 2021-04-25 11:20  天涯再见咫尺  阅读(70)  评论(0)    收藏  举报