python doc_pydoc：python的文档工具

pydoc是一个python的文档工具，下面介绍一下它的基本用法。这里是用的python2.7。

my.py是来自http://woodpecker.org.cn/abyteofpython_cn/chinese/ch11s07.html的一段代码。内容如下：

#!/usr/bin/python

#-*-encoding:utf-8-*-

"""

这是一个测试

"""

class SchoolMember:

'''Represents any school member.'''

def __init__(self, name, age):

self.name = name

self.age = age

print '(Initialized SchoolMember: %s)' % self.name

def tell(self):

'''Tell my details.'''

print 'Name:"%s" Age:"%s"' % (self.name, self.age),

class Teacher(SchoolMember):

'''Represents a teacher.'''

def __init__(self, name, age, salary):

SchoolMember.__init__(self, name, age)

self.salary = salary

print '(Initialized Teacher: %s)' % self.name

def tell(self):

SchoolMember.tell(self)

print 'Salary: "%d"' % self.salary

class Student(SchoolMember):

'''Represents a student.'''

def __init__(self, name, age, marks):

SchoolMember.__init__(self, name, age)

self.marks = marks

print '(Initialized Student: %s)' % self.name

def tell(self):

SchoolMember.tell(self)

print 'Marks: "%d"' % self.marks

t = Teacher('Mrs. Shrividya', 40, 30000)

s = Student('Swaroop', 22, 75)

print # prints a blank line

members = [t, s]

for member in members:

member.tell() # works for both Teachers and Students

进入my.py所在目录，运行命令：

bash >> pydoc my | cat

(Initialized SchoolMember: Mrs. Shrividya)

(Initialized Teacher: Mrs. Shrividya)

(Initialized SchoolMember: Swaroop)

(Initialized Student: Swaroop)

Name:"Mrs. Shrividya" Age:"40" Salary: "30000"

Name:"Swaroop" Age:"22" Marks: "75"

Help on module my:

NAME

my - 这是一个测试

FILE

/home/letian/Desktop/my.py

CLASSES

SchoolMember

Student

Teacher

class SchoolMember

| Represents any school member.

| Methods defined here:

| __init__(self, name, age)

| tell(self)

| Tell my details.

class Student(SchoolMember)

| Represents a student.

| Methods defined here:

| __init__(self, name, age, marks)

| tell(self)

class Teacher(SchoolMember)

| Represents a teacher.

| Methods defined here:

| __init__(self, name, age, salary)

| tell(self)

DATA

member =

members = [, ]

s =

t = 运行命令：

bash >> pydoc my.SchoolMember | cat

(Initialized SchoolMember: Mrs. Shrividya)

(Initialized Teacher: Mrs. Shrividya)

(Initialized SchoolMember: Swaroop)

(Initialized Student: Swaroop)

Name:"Mrs. Shrividya" Age:"40" Salary: "30000"

Name:"Swaroop" Age:"22" Marks: "75"

Help on class SchoolMember in my:

my.SchoolMember = class SchoolMember

| Represents any school member.

| Methods defined here:

| __init__(self, name, age)

| tell(self)

| Tell my details. 运行命令：

bash >> pydoc my.t | cat

(Initialized SchoolMember: Mrs. Shrividya)

(Initialized Teacher: Mrs. Shrividya)

(Initialized SchoolMember: Swaroop)

(Initialized Student: Swaroop)

Name:"Mrs. Shrividya" Age:"40" Salary: "30000"

Name:"Swaroop" Age:"22" Marks: "75"

Help on instance of Teacher in my:

my.t = class Teacher(SchoolMember)

| Represents a teacher.

| Methods defined here:

| __init__(self, name, age, salary)

| tell(self) -k参数用来查找关键字。例如：

bash >> pydoc -k pyQt4

PyQt4

PyQt4.Qt

PyQt4.QtAssistant

PyQt4.QtCore

PyQt4.QtDBus

PyQt4.QtDeclarative

PyQt4.QtDesigner

PyQt4.QtGui

PyQt4.QtHelp

PyQt4.QtNetwork

PyQt4.QtScript

PyQt4.QtScriptTools

......

我们也可以利用-p参数指定端口，以在本机上查看所有模块的文档，例如：

bash >> pydoc -p 8088 在浏览器中访问http://127.0.0.1:8088/即可，界面简洁大方。

下面的命令执行后会有图形化界面(Tk)出现：

bash >> pydoc -g 下面的命令会为urllib2的文档生成urllib2.html文件：

bash >> pydoc -w urllib2 pydoc也是一个python类库，下面是在ipython下的一个示例：

bash >> ipython

Python 2.7.4 (default, Sep 26 2013, 03:20:26)

Type "copyright", "credits" or "license" for more information.

IPython 0.13.2 -- An enhanced Interactive Python.

? -> Introduction and overview of IPython's features.

%quickref -> Quick reference.

help -> Python's own help system.

object? -> Details about 'object', use 'object??' for extra details.

In [1]: pwd

Out[1]: u'/home/letian/Desktop'

In [2]: import my

(Initialized SchoolMember: Mrs. Shrividya)

(Initialized Teacher: Mrs. Shrividya)

(Initialized SchoolMember: Swaroop)

(Initialized Student: Swaroop)

Name:"Mrs. Shrividya" Age:"40" Salary: "30000"

Name:"Swaroop" Age:"22" Marks: "75"

In [3]: import pydoc

In [4]: pydoc.

pydoc.Doc pydoc.locate

pydoc.ErrorDuringImport pydoc.lower

pydoc.HTMLDoc pydoc.md

pydoc.HTMLRepr pydoc.os

pydoc.Helper pydoc.pager

pydoc.ModuleScanner pydoc.pathdirs

pydoc.Repr pydoc.pipepager

pydoc.Scanner pydoc.pkgutil

pydoc.TextDoc pydoc.plain

pydoc.TextRepr pydoc.plainpager

pydoc.allmethods pydoc.re

pydoc.apropos pydoc.render_doc

pydoc.classify_class_attrs pydoc.replace

pydoc.classname pydoc.resolve

pydoc.cli pydoc.rfind

pydoc.cram pydoc.rstrip

pydoc.deque pydoc.safeimport

pydoc.describe pydoc.serve

pydoc.doc pydoc.source_synopsis

pydoc.expandtabs pydoc.split

pydoc.extract_tb pydoc.splitdoc

pydoc.find pydoc.strip

pydoc.getdoc pydoc.stripid

pydoc.getpager pydoc.synopsis

pydoc.gui pydoc.sys

pydoc.help pydoc.tempfilepager

pydoc.html pydoc.text

pydoc.imp pydoc.ttypager

pydoc.importfile pydoc.types

pydoc.inspect pydoc.visiblename

pydoc.isdata pydoc.warnings

pydoc.ispackage pydoc.writedoc

pydoc.ispath pydoc.writedocs

pydoc.join

In [4]: pydoc.describe.__doc__

Out[4]: 'Produce a short description of the given thing.'

In [5]: pydoc.describe(my.t)

Out[5]: 'instance of Teacher'

In [6]: pydoc.describe(my)

Out[6]: 'module my'

In [7]: pydoc.describe(my.SchoolMember)

Out[7]: 'class SchoolMember'

In [8]: pydoc.doc(my.SchoolMember)

Python Library Documentation: class SchoolMember in module my

class SchoolMember

| Represents any school member.

| Methods defined here:

| __init__(self, name, age)

| tell(self)

| Tell my details. ipython和pydoc对学习python的其他类库会有较大的帮助。

python doc_pydoc：python的文档工具相关推荐

使用sphinx为python注释生成docAPI文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成 ...
使用sphinx快速为你python注释生成API文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...
python共享文件协同编辑_那些可多人协作编辑的在线文档工具
最近使用了下石墨文档,简直就是在线版的Word,Excel,PPT,而且可以多人实时编辑预览,真的太好用了,搜索了下发现这种在线文档工具还挺多的,这里做个整理推荐. 石墨文档这个很多人应该都用过,石 ...
Python+pymupdf处理PDF文档案例6则
推荐图书: <Python程序设计(第3版)>,(ISBN:978-7-302-55083-9),清华大学出版社,2020年6月第1次印刷,7月第2次印刷京东购买链接:https://i ...
Python 实现将 Markdown 文档转换为 EPUB 电子书文件
Python 实现将 Markdown 文档转换为 EPUB 电子书文件 Markdown Markdown 是一种轻量级的标记语言,用于以简单且易于阅读的方式格式化文本.它由 John Gruber ...
Python批量调整PPT文档样式
Python批量调整PPT文档样式在日常工作中,我们经常需要制作PPT文档来展示我们的工作成果或者进行汇报.但是,如果我们需要同时更改多张PPT的样式,手动修改会非常耗时且繁琐.此时,我们可以利用P ...
使用 Python 翻译 CHM 帮助文档
此方法绝对切实可行翻译成品项目: GitHub - foyoux/InstallShield2020-Documents: InstallShield2020 中文文档效果预览安装 doct ...
python批量提取word指定内容_使用python批量读取word文档并整理关键信息到excel表格的实例...
目标最近实验室里成立了一个计算机兴趣小组倡议大家多把自己解决问题的经验记录并分享就像在CSDN写博客一样虽然刚刚起步但考虑到后面此类经验记录的资料会越来越多所以一开始就要做好模板设计(如下 ...
用Python提取解析pdf文档中内容
用Python提取解析pdf文档中内容文章目录: 参考: 1.https://blog.csdn.net/tmaczt/article/details/82876018 # Tika库 2.http ...

python doc_pydoc：python的文档工具

python doc_pydoc：python的文档工具相关推荐

最新文章

热门文章