Python文档阅读——Pydoc

        " 需要大概3分钟阅读"

        大伙们在第一次接触Python的时候都会被它强大的包所吸引吧，常常在项目开发中引入，解决了我们日常的很多问题。但是在海量的包中，我们怎么熟悉它的类与函数的使用呢？

目录

01 发现问题

02 Pydoc介绍

03 总结

01 发现问题

当项目或脚本上要使用python工具包的时，你对工具包不太了解时，这时候该怎么办呢？

Python的工具包众多，那么多的类和方法，我怎么能都记得住呢？

02 Pydoc介绍

pydoc模块的以下几个参数

python -m pydoc
# 命令：
# -m (表示运行指定模块)
# -p 端口号 (服务开启的端口号)
# -w 包名称 (将包下载成单独的html文件, 没啥实际作用)
# -k (在所有可用模块的中搜索关键字)
# -b (任意开启一个端口号)

python -m pydoc -p 9527 
# 成功后可以直接在浏览器中输入以下地址：http://localhost:9527/

命令执行后，出现了一个本地可访问的网址。

访问该网址后：

工具包A、工具包B、.... 、工具包N

搜索你需要使用的工具包，例如常用的os

import os
help(os)
print(dir(os))

发现后台打印的内容和网页内容一模一样，执行help(os) 对应所有网页内容。

所有function方法查看

再慢慢对照文档开始摸索，编写测试代码吧!

03 总结

优点：

    1. 有实例代码可读。

    2. 相比官方文档更容易阅读和使用。

    3. 能快速在网页中查找工具包使用方法。

缺点：

    1. 缺少部分模块介绍。

    2. 不利于新手操作。

---

        菜鸟教程， 官方文档， 网上博客， github等，都有自己的技术文档。

        每个人都有自己喜欢的查阅文档的方式，综合起来去解决业务问题。

        不知道大伙第一次遇到python工具包的时候，是如何学习和使用的，欢迎大伙在分享自己的学习方式！

        大脑是用来思考问题的，不是用来记忆的。

        感兴趣的伙伴可以关注微信公众号：程序员9527