怎样阅读Python官方文档
对于初学者来讲,由于没有相关的经验,学习语言的时候,往往耗时耗力而且效果不太好,这里简单讲下如何阅读官方文档,一旦学会快速查询官方文档,学习的效率会提升很多
文档传送门
如何阅读API文档
API这里特指Python标准库文档,所谓标准库就是Python本身自带的库,区别于第三方库,不需要额外的下载其他东西就能直接使用,提供最基本最核心的功能,离开了这些库可以说是寸步难行。
标准库里面内容那么多,如何快速找到自己想要的东西。
第一种方式概览
先查找索引,采用从整体到局部的浏览方法,而不是从上到下的浏览方式:例如我想读取一个txt文件,比较好的查询方式是
浏览目录 --------> File and Directory Access -----> pathlib — Object-oriented filesystem paths
而不是从上至下逐一浏览,采用分类查询的方法快速查询, 读取txt,你首先想到的是这是一种文件访问,那么对应应该在该分类去找,当然仍然需要一定的经验去定位你的需求处于哪个分类。
第一种方式精确查找
前一种方式适用于,你只知道大概的范围的情况下查找想要的API,这种方式则是你已经知道具体要使用哪个module的情况。
-
search 关键字
-
找到最符合的查询结果
如何阅读API 细节
以 Built-in Functions 为例
最前面仍然是索引,绝大部分的API都是这样,最开始的部分永远是介绍这个module是用来干嘛,具备哪些功能,接着配上索引.
以abs为例
点解我画红线的部分即可跳转至指定函数的详细讲解
- abs 函数没有demo,我补一个
litengfangdeMacBook-Pro:~ litengfang$ python3
Python 3.7.2 (v3.7.2:9a3ffc0492, Dec 24 2018, 02:44:43)
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> abs(-5)
5
当然有的时候我们看了函数的介绍还是不太懂,那么写个小demo试一下也是可以的
>>> all([1,2,3,None])
False
>>> all([1,2,3])
True
当然看完文档还是不懂的这种情况也是常有,这个时候可能就需要求助于搜索引擎了。