如何寫出清晰又優(yōu)雅的Python代碼?我們給你這26條建議

來源:大數(shù)據(jù)DT 本文約1900字,建議閱讀5分鐘
PEP 8非常詳細地描述了如何編寫清晰的Python代碼。

https://www.python.org/dev/peps/pep-0008
(9條 / 26條)
用空格(space)表示縮進,而不要用制表符(tab)。 和語法相關的每一層縮進都用4個空格表示。 每行不超過79個字符。 對于占據(jù)多行的長表達式來說,除了首行之外的其余各行都應該在通常的縮進級別之上再加4個空格。 在同一份文件中,函數(shù)與類之間用兩個空行隔開。 在同一個類中,方法與方法之間用一個空行隔開。 使用字典時,鍵與冒號之間不加空格,寫在同一行的冒號和值之間應該加一個空格。 給變量賦值時,賦值符號的左邊和右邊各加一個空格,并且只加一個空格就好。 給變量的類型做注解(annotation)時,不要把變量名和冒號隔開,但在類型信息前應該有一個空格。

(7條 / 26條)
函數(shù)、變量及屬性用小寫字母來拼寫,各單詞之間用下劃線相連,例如:lowercase_underscore。
受保護的實例屬性,用一個下劃線開頭,例如:_leading_underscore。 私有的實例屬性,用兩個下劃線開頭,例如:__double_leading_underscore。 類(包括異常)命名時,每個單詞的首字母均大寫,例如:CapitalizedWord。 模塊級別的常量,所有字母都大寫,各單詞之間用下劃線相連,例如:ALL_CAPS。 類中的實例方法,應該把第一個參數(shù)命名為self,用來表示該對象本身。 類方法的第一個參數(shù),應該命名為cls,用來表示這個類本身。
(6條 / 26條)
采用行內否定,即把否定詞直接寫在要否定的內容前面,而不要放在整個表達式的前面,例如應該寫if a is not b,而不是if not a is b。 不要通過長度判斷容器或序列是不是空的,例如不要通過if len(somelist) == 0判斷somelist是否為[]或''等空值,而是應該采用if not somelist這樣的寫法來判斷,因為Python會把空值自動評估為False。 如果要判斷容器或序列里面有沒有內容(比如要判斷somelist是否為[1]或'hi'這樣非空的值),也不應該通過長度來判斷,而是應該采用if somelist語句,因為Python會把非空的值自動判定為True。 不要把if語句、for循環(huán)、while循環(huán)及except復合語句擠在一行。應該把這些語句分成多行來寫,這樣更加清晰。 如果表達式一行寫不下,可以用括號將其括起來,而且要適當?shù)靥砑訐Q行與縮進以便于閱讀。 多行的表達式,應該用括號括起來,而不要用\符號續(xù)行。

(4條 / 26條)
import語句(含from x import y)總是應該放在文件開頭。 引入模塊時,總是應該使用絕對名稱,而不應該根據(jù)當前模塊路徑來使用相對名稱。例如,要引入bar包中的foo模塊,應該完整地寫出from bar import foo,即便當前路徑為bar包里,也不應該簡寫為import foo。 如果一定要用相對名稱來編寫import語句,那就應該明確地寫成:from . import foo。 文件中的import語句應該按順序劃分成三個部分:首先引入標準庫里的模塊,然后引入第三方模塊,最后引入自己的模塊。屬于同一個部分的import語句按字母順序排列。
提示:Pylint是一款流行的Python源碼靜態(tài)分析工具。它可以自動檢查受測代碼是否符合PEP 8風格指南,而且還能找出Python程序里的許多種常見錯誤。很多IDE(集合成開發(fā)環(huán)境)與編輯器,都包含這樣的linting工具或者支持類似的插件。 https://www.pylint.org/
編寫Python代碼時,總是應該遵循PEP 8風格指南。 與廣大Python開發(fā)者采用同一套代碼風格,可以使項目更利于多人協(xié)作。 采用一致的風格編寫代碼,代碼的后續(xù)修改更容易。
評論
圖片
表情
