python代碼的書(shū)寫(xiě)規(guī)范

1.一致性的建議

打破一條既定規(guī)則的兩個(gè)好理由

當(dāng)應(yīng)用這個(gè)規(guī)則將導(dǎo)致代碼可讀性下降,即使對(duì)于某人來(lái)說(shuō)他已經(jīng)習(xí)慣于按照這條規(guī)則來(lái)閱讀代碼了

為了和周圍的代碼保持一致而打破規(guī)則(也許是歷史原因)

2.代碼的布局

縮進(jìn)

4個(gè)空格

代碼行

行長(zhǎng)度:79字符

推薦長(zhǎng)度:72字符

分割方式:"","()","{}"

空行

兩行空行分割頂層函數(shù)和類的定義

一行空行分割方法或函數(shù)

額外空行分割相關(guān)函數(shù)群

類定義與第一個(gè)方法定義需要一行空行

編碼

萬(wàn)年"UTF-8"

導(dǎo)入

先import標(biāo)準(zhǔn)模塊,再from...import第三方模塊(絕對(duì)路徑),最后from...import自建模塊

每組導(dǎo)入空一行,一行導(dǎo)入一個(gè)包[模塊,類等]

空格

緊貼各類括號(hào)

緊貼逗號(hào),分號(hào),冒號(hào)前

緊貼函數(shù)調(diào)用參數(shù)列表前開(kāi)放式括號(hào)

緊貼再索引或切片括號(hào)

二元操作符或運(yùn)算符或邏輯等兩邊各留一個(gè)空格

默認(rèn)參數(shù)或關(guān)鍵參數(shù)"="不留空格

3.注釋

注釋塊

與相應(yīng)代碼有著相同縮進(jìn)

行內(nèi)注釋

與代碼被注釋代碼同行,以"#"+""開(kāi)頭

文檔注釋

結(jié)尾處"""單獨(dú)成行

版本注記

模塊文檔字符串之后,所有代碼之前,上下空行分割

4.命名

約定

模塊名:不含下劃線;小寫(xiě);剪短

類名,異常名:首字母大寫(xiě)單詞串

方法,函數(shù):第一個(gè)字母小寫(xiě)的首字母大寫(xiě)單詞串

屬性,實(shí)例,變量:小寫(xiě)字母串

繼承

私有:雙下劃線開(kāi)頭

非公有:單下劃線開(kāi)頭

命名沖突

不降低可讀性,能改就改,不能就在末尾加單個(gè)下劃線或者數(shù)字

5.設(shè)計(jì)建議

使用"is"或"isnot"進(jìn)行對(duì)"None"的單值比較

使用字符串方法代替字符串模塊

使用startswith()和endswith()檢查前后綴而不是使用切片

使用isinstance()判斷對(duì)象是否是字符串而不是使用type()

判斷空序列或字典不要使用len()

書(shū)寫(xiě)字符串文字不要依賴有意義的后置空格

不要用"=="比較布爾值

以上內(nèi)容為大家介紹了python培訓(xùn)之Python代碼的書(shū)寫(xiě)規(guī)范，希望對(duì)大家有所幫助，如果想要了解更多Python相關(guān)知識(shí)，請(qǐng)關(guān)注IT培訓(xùn)機(jī)構(gòu):千鋒教育。