当前位置: 首页 > POX > 正文

Python的文档生成工具pydoc用法

Python的文档生成工具pydoc用法

1. 介绍

下面是直接在命令行中输入pydoc显示的使用说明:

pydoc - the Python documentation tool

pydoc  ...
    Show text documentation on something.   may be the name of a
    Python keyword, topic, function, module, or package, or a dotted
    reference to a class or function within a module or module in a
    package.  If  contains a '/', it is used as the path to a
    Python source file to document. If name is 'keywords', 'topics',
    or 'modules', a listing of these things is displayed.

pydoc -k 
    Search for a keyword in the synopsis lines of all available modules.

pydoc -p 
    Start an HTTP server on the given port on the local machine.

pydoc -g
    Pop up a graphical interface for finding and serving documentation.

pydoc -w  ...
    Write out the HTML documentation for a module to a file in the current
    directory.  If  contains a '/', it is treated as a filename; if
    it names a directory, documentation is written for all the contents.

2. 用法

最简单的用法是在命令行中输入

$ pydoc name

name可以是关键字、主题、函数、模块或包名(见上面的使用说明)。如果name中含有/则表示要显示的文档是一个特定的python文件的文档信息。

下面看几个示例

  • 查阅dir的帮助:
$ pydoc dir

Help on built-in function dir in module __builtin__:
 
dir(...)
    dir([object]) -> list of strings
    
    If called without an argument, return the names in the current scope.
    Else, return an alphabetized list of names comprising (some of) the attributes
    of the given object, and of attributes reachable from it.
    If the object supplies a method named __dir__, it will be used; otherwise
    the default dir() logic is used and returns:
      for a module object: the module's attributes.
      for a class object:  its attributes, and recursively the attributes
        of its bases.
      for any other object: its attributes, its class's attributes, and
        recursively the attributes of its class's base classes.
(END)
  • 查阅指定python源文件的文档

$ pydoc test/test.py
$ pydoc test.test

上面的两条命令作用相同。

  • 使用浏览器查阅帮助

上面的帮助信息都在命令行显示,也可以在浏览器更方便的查阅。

$ pydoc -p 8888

8888是指定启动webserver的端口号,可以随便指定未被占用的端口号

在浏览器中输入http://localhost:8888即可查阅

  • 启动图形界面查找文档

$ pydoc -g

  • 将文档保存为html文档

$ pydoc -w test/test.py

本文固定链接: http://sdnhub.cn/index.php/python-pydoc/ | 软件定义网络SDN

该日志由 sdnhub 于2014年06月15日发表在 POX 分类下, 你可以发表评论,并在保留原文地址及作者的情况下引用到你的网站或博客。
原创文章转载请注明: Python的文档生成工具pydoc用法 | 软件定义网络SDN
关键字:

Python的文档生成工具pydoc用法:等您坐沙发呢!

发表评论

*

快捷键:Ctrl+Enter