大數據DT 提供大數據、AI等領域干貨學習資源的「寶藏號」,跟50萬技術人共同成長,一起玩轉大數據、Python、數據分析、數據科學、人工智能!還會有各種好玩又奇葩的數據解讀,邊學習邊吃瓜!
538篇原創內容
公眾號
導讀:Python Enhancement Proposal #8叫作PEP 8,它是一份針對Python代碼格式而編訂的風格指南。盡管只要語法正確,代碼隨便怎么寫都行,但采用一致的風格可以使代碼更易讀、更易懂。如果你的代碼風格和其他Python程序員的相同,那么就能夠更加順利地與大家一起做項目。
即便你的代碼只給自己看,也應該按照這套風格來寫,以便以后修改更加容易一些,而且能夠避開很多常見的錯誤。作者:布雷特·斯拉特金(Brett Slatkin)PEP 8非常詳細地描述了如何編寫清晰的Python代碼,而且會隨著Python語言的發展持續更新。大家應該把完整指南閱讀一遍:https://www.python.org/dev/peps/pep-0008在Python中,空白(whitespace)在語法上相當重要。Python程序員對空白字符的用法尤其在意,因為它們會影響代碼的清晰程度。在這方面,大家應該遵循以下幾條建議。- 用空格(space)表示縮進,而不要用制表符(tab)。
- 對于占據多行的長表達式來說,除了首行之外的其余各行都應該在通常的縮進級別之上再加4個空格。
- 使用字典時,鍵與冒號之間不加空格,寫在同一行的冒號和值之間應該加一個空格。
- 給變量賦值時,賦值符號的左邊和右邊各加一個空格,并且只加一個空格就好。
- 給變量的類型做注解(annotation)時,不要把變量名和冒號隔開,但在類型信息前應該有一個空格。
PEP 8建議采用不同的方式來給Python代碼中的各個部分命名,這樣在閱讀代碼時,就可以根據這些名稱看出它們在Python語言中的角色。遵循以下與命名相關的建議。- 函數、變量及屬性用小寫字母來拼寫,各單詞之間用下劃線相連,例如:lowercase_underscore。
- 受保護的實例屬性,用一個下劃線開頭,例如:_leading_underscore。
- 私有的實例屬性,用兩個下劃線開頭,例如:__double_leading_underscore。
- 類(包括異常)命名時,每個單詞的首字母均大寫,例如:CapitalizedWord。
- 模塊級別的常量,所有字母都大寫,各單詞之間用下劃線相連,例如:ALL_CAPS。
- 類中的實例方法,應該把第一個參數命名為self,用來表示該對象本身。
- 類方法的第一個參數,應該命名為cls,用來表示這個類本身。
The Zen of Python中提到:“每件事都應該有簡單的做法,而且最好只有一種。”PEP 8就試著運用這個理念,來規范表達式和語句的寫法。- 采用行內否定,即把否定詞直接寫在要否定的內容前面,而不要放在整個表達式的前面,例如應該寫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循環、while循環及except復合語句擠在一行。應該把這些語句分成多行來寫,這樣更加清晰。
- 如果表達式一行寫不下,可以用括號將其括起來,而且要適當地添加換行與縮進以便于閱讀。
- 多行的表達式,應該用括號括起來,而不要用\符號續行。
PEP 8對于怎樣在代碼中引入并使用模塊,給出了下面幾條建議。- import語句(含from x import y)總是應該放在文件開頭。
- 引入模塊時,總是應該使用絕對名稱,而不應該根據當前模塊路徑來使用相對名稱。例如,要引入bar包中的foo模塊,應該完整地寫出from bar import foo,即便當前路徑為bar包里,也不應該簡寫為import foo。
- 如果一定要用相對名稱來編寫import語句,那就應該明確地寫成:from . import foo。
- 文件中的import語句應該按順序劃分成三個部分:首先引入標準庫里的模塊,然后引入第三方模塊,最后引入自己的模塊。屬于同一個部分的import語句按字母順序排列。
- 提示:Pylint是一款流行的Python源碼靜態分析工具。它可以自動檢查受測代碼是否符合PEP 8風格指南,而且還能找出Python程序里的許多種常見錯誤。很多IDE(集合成開發環境)與編輯器,都包含這樣的linting工具或者支持類似的插件。
- 編寫Python代碼時,總是應該遵循PEP 8風格指南。
- 與廣大Python開發者采用同一套代碼風格,可以使項目更利于多人協作。
關于作者:布雷特·斯拉特金(Brett Slatkin),Google首席軟件工程師,他是Google Surveys的聯合技術創始人,也是PubSubHubbub協議的共同創造者之一。此外,Slatkin還發布了Google的第一個云計算產品——App Engine。早在15年前,Slatkin就開始在工作中使用Python管理Google大量的服務器群。他擁有紐約哥倫比亞大學計算機工程專業學士學位。
本文摘編自《Effective Python:編寫高質量Python代碼的90個有效方法》(原書第2版),
本文摘編自《Effective Python:編寫高質量Python代碼的90個有效方法》(原書第2版),經出版方授權發布。
本站僅提供存儲服務,所有內容均由用戶發布,如發現有害或侵權內容,請
點擊舉報。