学会使用Python的帮助

常用的几种方式：

写在前面，个人最喜欢的一个功能是pycharm中的documentation内置显示（默认快捷键为Ctrl+Q），选中函数，Ctrl+Q如下：

也有External documetation，快捷键为Shift+F1

1. dir()主要用来浏览对象的属性。

>>> a = [1,2,3]
>>> b = (1,2,3)
>>> print dir(a)
[..... 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']
>>> print dir(b)
[.... 'count', 'index']

2. __doc__看属性文档

>>> a = [1,2,3]
>>> a.reverse.__doc__
'L.reverse() -- reverse *IN PLACE*'

3. help()信息比较详细

>>> a = [1,2,3]
>>> help(a)
Help on list object:
class list(object)
 "|  list() -> new empty list
 |  list(iterable) -> new list initialized from iterable's items
 |  
 |  Methods defined here:.....

 |  append(...)
 |      L.append(object) -- append object to end
 |  
 |  count(...)
 |      L.count(value) -> integer -- return number of occurrences of value
...

requests模块为例:

1.dir可以浏览下requests模块中有哪些API, help会显示requests的详细帮助信息

2.发起GET请求，得到res对象，通过type可以看到对象名，同样，dir(res)可以浏览res的可用api或属性，help显示Response对象的详细帮助信息，右边栏pycharm变量区也有res的属性信息

3. 嵌套对象可以继续查看帮助

附pydoc使用：

如果觉得help返回太多，不易读，则可以使用pydoc模块，可以浏览器浏览html帮助

1. 开启pydoc HTTP server, 首先要保证C:\Python27\Lib加入环境变量，然后CMD执行：

2. 根据对象名查找

找到我们需要的requests模块，res为<class ‘requests.models.Response’>，所以继续找models里的Response