怎樣閱讀Python官方文檔
對于初學者來講吕世,由于沒有相關(guān)的經(jīng)驗翻翩,學習語言的時候檐盟,往往耗時耗力而且效果不太好褂萧,這里簡單講下如何閱讀官方文檔,一旦學會快速查詢官方文檔葵萎,學習的效率會提升很多
文檔傳送門
homepage.png
如何閱讀API文檔
API這里特指Python標準庫文檔导犹,所謂標準庫就是Python本身自帶的庫,區(qū)別于第三方庫羡忘,不需要額外的下載其他東西就能直接使用谎痢,提供最基本最核心的功能,離開了這些庫可以說是寸步難行卷雕。
標準庫里面內(nèi)容那么多节猿,如何快速找到自己想要的東西。
第一種方式概覽
index.png
先查找索引漫雕,采用從整體到局部的瀏覽方法滨嘱,而不是從上到下的瀏覽方式:例如我想讀取一個txt文件,比較好的查詢方式是
瀏覽目錄 --------> File and Directory Access -----> pathlib — Object-oriented filesystem paths
而不是從上至下逐一瀏覽,采用分類查詢的方法快速查詢, 讀取txt浸间,你首先想到的是這是一種文件訪問太雨,那么對應(yīng)應(yīng)該在該分類去找,當然仍然需要一定的經(jīng)驗去定位你的需求處于哪個分類魁蒜。
第一種方式精確查找
前一種方式適用于躺彬,你只知道大概的范圍的情況下查找想要的API,這種方式則是你已經(jīng)知道具體要使用哪個module的情況梅惯。
-
search 關(guān)鍵字
search.png -
找到最符合的查詢結(jié)果
search_result.png
如何閱讀API 細節(jié)
以 Built-in Functions 為例
build_functions_index.png
最前面仍然是索引宪拥,絕大部分的API都是這樣,最開始的部分永遠是介紹這個module是用來干嘛铣减,具備哪些功能她君,接著配上索引.
以abs為例
點解我畫紅線的部分即可跳轉(zhuǎn)至指定函數(shù)的詳細講解
abs_and_all.png
- abs 函數(shù)沒有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
當然有的時候我們看了函數(shù)的介紹還是不太懂葫哗,那么寫個小demo試一下也是可以的
>>> all([1,2,3,None])
False
>>> all([1,2,3])
True
當然看完文檔還是不懂的這種情況也是常有缔刹,這個時候可能就需要求助于搜索引擎了球涛。