如何更加有效地查看(学习)Python第三方库文档(APIs)

Question

描述: 有时候需要了解Python第三方库的API接口,如果盲目地看,乱看,则会导致效率不高(浪费时间)

环境: Windows8+Python2.7

措施:

 1 看源代码-->pass,只需要了解API,不需要了解细节,看源码头脑发胀,无法窥得全貌
 2 看官网文档-->可以,但是由于第三方库文档良莠不齐,而且文档有时候有堆砌的感觉,没有层次感,逻辑感. (有时候需要反复查阅)
3 直接在shell中输入help(),然后查看--> 还可以,但是仅仅看这些有时候不足以全面了解某一个API接口(信息过少)

不知道菊苣们是如何做的?

Answer 1

1， 来readthedocs 搜索，风格比较清晰，文档一般组织都还不错。
2， Google 搜索： “API名称” + 其他关键词，往往能找到不错的文章（博客）、问答（stackoverflow）以及别人组织的文档等（如 Python Modules Index: http://pymotw.com/2/genindex.html）

Answer 2

没有固定的好方法，我自己的经验是，dir加上help,如果还不足以解决问题的话，可以看对应API的源码。Python的代码可读性比较强，很优雅，但是前提是多写多看。

Answer 3

好的第三方库文档都会很好，特别是国外的，原生的英文文档都写得很好，而api这种个人感觉应该从实践中学，不知道的地方先help，在源码，help的话，个人喜欢bpython去看