python自带的文档生成工具_Python文档生成工具pydoc使用介绍
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc.
pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!
【用法】
Windows下:
复制代码
代码如下:
D:\>python -m pydoc
# 比如说: python -m pydoc math
-m参数:Python以脚本的方法运行模块
Linux/Unix下:
复制代码
代码如下:
$ pydoc
# 比如说: pydoc
【帮助】
复制代码
代码如下:
$ pydoc -h
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 -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.
【参数 -p】在本地机器上,按照给定的端口启动HTTP,
复制代码
代码如下:
D:\>python -m pydoc -p 1234 #比如说: 端口为1234
pydoc server ready at http://localhost:1234/
pydoc server stopped
在IE中输入:http://localhost:1234/,效果如图:
【参数 -k】在所有可用的模块中按关键字搜索
复制代码
代码如下:
$ pydoc -k xml.sax
xml.sax (package) - Simple API for XML (SAX) implementation for Python.
xml.sax._exceptions - Different kinds of SAX Exceptions
xml.sax.expatreader - SAX driver for the pyexpat C module. This driver works with
xml.sax.handler - This module contains the core classes of version 2.0 of SAX for Python.
xml.sax.saxutils - A library of useful helper classes to the SAX classes, for the
xml.sax.xmlreader - An XML Reader is the SAX 2 name for an XML parser. XML Parsers
【参数 -w】将指定模块的文本字符串生成HTML格式
比如说,在Window下面,执行下面命令:
复制代码
代码如下:
D:\Learn\Python>python -m pydoc math -w math.html # math是模块名,-w:写
那么在D:\Learn\Python目录下会生成math.html文件,显示如下:
因为是自带的模块,所以右上角显示(built-in)字样
【例子】自写的模块my_doc.py
复制代码
代码如下:
'''''
Showoff features of Pydoc module
This is easy module to demonstrate docstrings
'''
__authors__ = 'Alice & Fred'
__version__ = 'version 1.10'
__license__ = 'Copyright...'
class MyClass:
'''''
Demonstrate Class Docstrings
'''
def __init__(self, spam=1, eggs=2):
'''''
Set the default attributevalues only
Keyword arguments:
spam - a processed meat product
eggs - a fine breakfast for lumberjacks
'''
self.spam = spam
self.eggs = eggs
def square(x):
'''''
Square of the param
'''
return x * x
执行命令:
复制代码
代码如下:
D:\Learn\Python> python -m pydoc my_doc
执行结果:
复制代码
代码如下:
Help on module my_doc:
NAME
my_doc
FILE
d:\learn\python\my_doc.py
DESCRIPTION
Showoff features of Pydoc module
This is easy module to demonstrate docstrings
CLASSES
MyClass
class MyClass
| Demonstrate Class Docstrings
|
| Methods defined here:
|
| __init__(self, spam=1, eggs=2)
| Set the default attributevalues only
| Keyword arguments:
| spam - a processed meat product
| eggs - a fine breakfast for lumberjacks
FUNCTIONS
square(x)
Square of the param
DATA
__authors__ = 'Alice & Fred'
__license__ = 'Copyright...'
__version__ = 'version 1.10'
VERSION
version 1.10
执行命令:
复制代码
代码如下:
d:\Learn\Python>python -m pydoc -w my_doc my_doc.html
wrote my_doc.html
no Python documentation found for 'my_doc.html'
执行结果:
python自带的文档生成工具_Python文档生成工具pydoc使用介绍相关推荐
- python自动翻译小工具_Python实现翻译小工具
一.背景 利用Requests模块获取有道词典web页面的post信息,BeautifulSoup来获取需要的内容,通过tkinter模块生成gui界面. 二.代码 git源码地址 Python实现翻 ...
- python自带intertool模块找不到_Python itertools模块:生成迭代器(示例分析)
1 itertools 模块中主要包含了一些用于生成迭代器的函数.在 Python 的交互式解释器中先导入 itertools 模块,然后输入 e for e in dir(itertools) if ...
- python帮助文档在哪_python文档在哪里
对于Python中一些不清楚的模块,可以通过文档学习如何使用,但是python文档在哪里呢?这个问题我们可以使用Python命令进行查看. 方法一 在python命令行输入以下内容help(time) ...
- python帮助文档在哪_python文档之查看帮助文档方法
准备 使用time模块,使用time模块的localtime函数,使用range类 在已经分清模块,函数,类的情况下开始测试 方法一 在python命令行输入以下内容help(time) # 很详细的 ...
- python自带intertool模块找不到_Python itertools模块详解
这货很强大, 必须掌握 基本是基于文档的翻译和补充,相当于翻译了 itertools用于高效循环的迭代函数集合 组成 总体,整体了解 无限迭代器 复制代码代码如下: 迭代器 参数 结果 例子 coun ...
- python生成验证码_python之验证码生成(gvcode与captcha)
今天向大家总结一下python在做项目时用到的验证码生成工具:gvcode与captcha gvcode 全称:graphic-verification-code 安装: pip install gv ...
- python随机生成车牌_Python实现随机生成任意数量车牌号
之前做课设的时候舍友遇到了需要生成500w量级车牌号的问题,于是我便写了一个随机生成车牌号的程序,希望各位采纳. 注:Python实现 import random def chepaihao(len= ...
- python批量生成图_python图像处理-批量生成纯色图片
上一篇文章,是基于现有的图片处理的,那要如何通过代码直接生成图片呢. 生成一张纯色的图片 先设置图片的颜色,接着利用Image模块的new方法新生成一张图片,png格式的图片需要设置成rgba,类似的 ...
- python随机生成列表_python 实现快速生成连续、随机字母列表
0.摘要 本文介绍了生成连续和随机字母表的方法,用于快速生成大量字母数据. 主要使用chr()函数,将数字通过ASCII表转换为相应字母. 1.chr() 函数 chr() 用一个范围在 range( ...
最新文章
- Centos5.5下安装LAMP完整版
- Nginx 出现504 Gateway Time-out的解决方法
- 图像处理(二十一)基于数据驱动的人脸卡通动画生成-Siggraph Asia 2014
- mysql开启查看慢查询日志[转]
- jfoenix jdk8 pom依赖
- 删除U盘作为启动盘的隐藏启动分区
- 如何开启SAP CRM基于WORD模板创建附件的功能
- cups 设置打印机纸张_惠普打印机打印模糊怎么办 惠普打印机打印模糊解决【方法】...
- Emacs中自动刷新dired缓冲区
- 阅读VDN:Value-Decomposition Networks For Cooperative Multi-Agent Learning Based On Team Reward
- 周鸿祎:做到这五点,才算是好用户体验
- 关于本博客博皮的几点改进与释疑
- 联想thinkpad bios密码破解,t440,450,460,x240,250,260,x1c,yoga,y70,y50。。。。软件解密
- Windows删除打开方式多余项
- 中文CTEX加下划线无法换行问题
- python修改电脑桌面壁纸_python设置windows桌面壁纸的方法
- Android MediaPlayer中的RTSP(一):RTSP简介
- Servlet 01
- 广电时评 | 中央主流媒体盛赞爱奇艺短剧新气象
- 大数据可视化陈为智慧树_大数据可视化智慧树答案
热门文章
- 详解Python中的封装
- sony相机数据恢复,相机内存卡数据如何恢复
- 计算机网络布线画图软件,一种计算机网络布线辅助工具的制作方法
- 学yolo需要什么基础?怎么学YOLO?
- 最小二乘法求解一元线性回归
- PHP副本保存用什么函数,PHP_收藏的PHP常用函数 推荐收藏保存,内容: 复制代码 代码如下: lt - phpStudy...
- c语言汇编call的参数,内嵌汇编—第7节:参数、局部变量、CALL原理
- 聊聊孩子阅读习惯的培养
- 中国手机热度排行榜,2018年12月(依线上热度排名,价格参考最高配)
- 如何强制更改root密码