python pydoc是什么

  • 更新时间:2021-08-03 09:24:35
  • 编辑:须嘉祯
给大家整理一篇相关的编程文章,网友廖莎莉根据主题投稿了本篇教程内容,涉及到Python相关内容,已被771网友关注,如果对知识点想更进一步了解可以在下方电子资料中获取。

参考资料

正文内容

码农之家最近发表了一篇名为《python pydoc是什么》的py文章,实例讲的很实用,把程序员重写的代码发布到这里,希望对网友有用。

python pydoc是什么

1、说明

Python自带的pydoc模块,可以非常方便地查看、生成帮助文档,该文档是HTML格式的,因此查看、使用起来非常方便。

2、作用

(1)生成文本格式的注释文档

import pydoc
import sys
with open('aa.txt', 'w') as f:
pydoc.doc('bin.socketServer', output=f)

(2)使用help()函数, 生成的是文本格式的文档

import pydoc
import sys
# help() == pydoc.help() == pydoc.doc()  
sys.stdout = open('aa.txt', 'w')
help('bin.socketServer')
sys.stdout.close()
#  sys.stdout的作用是将输出到控制台的内容写
# 入文件(来自 https://blog.csdn.net/fengda2870/article/details/44925645 )
# 问题1:help函数会生成每一个类所有父类的注释文档, 所有公共父类会重复生成很多次注释,

3、启动方法

pydoc启动服务器和浏览器的方法为,在console中输入命令:

python -m pydoc -b

上述命令的m参数表示:查看module在当前的可见的搜索路径上;b表示启动的是浏览器。

在我的Anoconda中python3.4环境下使用上述命令。

以上就是python pydoc的基本介绍,在查看和生成文档方面,我们很多时候都是需要依赖pydoc模块的使用。

(推荐操作系统:windows7系统、Python 3.9.1,DELL G3电脑。)

相关教程

  • python可以实现什么

    Python主要有以下三大主要应用:Web开发,数据科学:包括机器学习、数据分析和数据可视化,脚本。其他用途包括嵌入式应用,网络爬虫,游戏开发,桌面应用,人工智能等。

    发布时间:2019-06-26

  • 浅谈python下含中文字符串正则表达式的编码问题

    今天小编就为大家分享一篇浅谈python下含中文字符串正则表达式的编码问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

    发布时间:2019-06-03

用户留言