1.變量
常量:大寫加下劃線 USER_CONSTANT。
私有變量:小寫和一個前導下劃線 _private_value。
Python 中不存在私有變量一說,若是遇到需要保護的變量,使用小寫和一個前導下劃線。但這只是程 序員之間的一個約定,用于警告說明這是一個私有變量,外部類不要去訪問它。但實際上,外部類還是可以訪問到這個變量。
P>
內置變量:小寫,兩個前導下劃線和兩個后置下劃線 class 兩個前導下劃線會導致變量在解釋期 間被更名。這是為了避免內置變量和其他變量產生沖突。用戶定義的變量要嚴格避免這種風格。以免導致混亂。
2.函數和方法
總體而言應該使用,小寫和下劃線。但有些比較老的庫使用的是混合大小寫,即首單詞小寫,之后每個 單詞第一個字母大寫,其余小寫。但現在,小寫和下劃線已成為規范。
私有方法 :小寫和一個前導下劃線 這里和私有變量一樣,并不是真正的私有訪問權限。同時也應該注意一般函數不要使用兩個前導下劃線(當遇到兩個前導下劃線時,Python 的名稱改編特性將發揮作用)。特殊方法 :小寫和兩個前導下劃線,兩個后置下劃線這種風格只應用于特殊函數,比如操作符重載等。 函數參數 : 小寫和下劃線,缺省值等號兩邊無空格。
3.類
類總是使用駝峰格式命名,即所有單詞首字母大寫其余字母小寫。類 名應該簡明,精確,并足以從中理 解類所完成的工作。常見的一個方法是使用表示其類型或者特性的后綴,例如:SQLEngine,MimeTypes 對于基類而言,可以使用一個 Base 或者Abstract 前綴 BaseCookie,AbstractGroup。
4.模塊和包
除特殊模塊init之外,模塊名稱都使用不帶下劃線的小寫字母。 若是它們實現一個協議,那么通常使用 lib 為后綴,例如: import smtplib import os import sys。
5.關于參數
不要用斷言來實現靜態類型檢測。斷言可以用于檢查參數,但不應僅僅是進行靜態類型檢測。Python 是動態類型語言,靜態類型檢測違背了其設計思想。斷言應該用于避免函數不被毫無意義的調 用。不要濫用 *args 和 **kwargs。*args 和 **kwargs 參數可能會破壞函數的健壯性。它們使簽名變得模 糊,而且代碼常常開始在不應該的地方構建小的參數解析器。
6.其他
使用 has 或 is 前綴命名布爾元素 is_connect =True has_member = False 用 復 數 形 式 命 名 序 列 members = [‘user_1’,‘user_2’] 用顯式名稱命名字典
person_address = {‘user_1’:‘10 road WD’, ‘user_2’ : ‘20 street huafu’} 避免通用名稱
諸如 list, dict, sequence 或者 element 這樣的名稱應該避免。 避免現有名稱諸如 os, sys 這種系統已經存在的名稱應該避免。
7.一些數字一行列數
PEP 8 規定為 79 列。根據自己的情況,比如不要超過滿屏時編輯器的顯示列數。
一個函數:不要超過 30 行代碼, 即可顯示在一個屏幕類,可以不使用垂直游標即可看到整個函數。
一個類:不要超過 200 行代碼,不要有超過 10 個方法。
一個模塊 :不要超過 500 行。
8.驗證腳本可以安裝一個 pep8腳本用于驗證你的代碼風格是否符合 PEP8。