2018最新Python編程規(guī)范

1、Python程規(guī)范簽署:日期:（管理者代表）修訂記錄內(nèi)部文檔嚴(yán)禁外傳日期版本作者批準(zhǔn)生效日期1. Purpose 目的 42. Scope適用范圍43. Roles and Responsibilities 角色和職責(zé) 44. Procedure 程序要求 44.1 General Requirements 總要求 44.2 總則 55. Reference Documents參考文檔 75.1 External Reference 外部參考文檔 75.2 Internal Reference 內(nèi)部參考文檔 75.3 Record 記錄模板86. Terms and Definitions縮略

2、語和定義 86.1 Definitions 定義 86.2 Acronym 縮略語 8嚴(yán)禁外傳1. Purpose 目的本程序文件指導(dǎo) Python代碼編寫，旨在通過程序文件規(guī)范編碼，通過編碼規(guī)范來提高 代碼質(zhì)量、代碼可讀性和可維護(hù)性。2. Scope適用范圍本程序文件適用于開發(fā)部項(xiàng)目開發(fā)過程中所有Python代碼。3. Roles and Responsibilities角色和職責(zé)角色職責(zé)描述Module 負(fù)責(zé)人（MO）Module Owner組織完成軟件模塊編碼規(guī)范的評(píng)審軟件開發(fā)工程師（SD）Software Developer按照編程規(guī)范完成編碼實(shí)現(xiàn)參與編碼規(guī)范的評(píng)審，并按照規(guī)范要求完成

3、不符合規(guī)范代碼的整改4. Procedure 程序要求4.1 General Requirements 總要求1、 對(duì)于命名的規(guī)則，各模塊負(fù)責(zé)人應(yīng)能給出各自明確的命名規(guī)則。2、 對(duì)于錯(cuò)誤的處理機(jī)制和要求，各模塊負(fù)責(zé)人應(yīng)能給出明確的要求。3、 對(duì)于各自的日志處理，各位模塊負(fù)責(zé)人最好能把日志消息分為高、中、低或其他形式不同的等級(jí)，同時(shí)對(duì)日志有明確的要求4、 項(xiàng)目組內(nèi)多人開發(fā)時(shí)，需要統(tǒng)一變量命名規(guī)則，保持風(fēng)格的一致性。5、 本規(guī)范分為強(qiáng)制規(guī)范和推薦規(guī)范，強(qiáng)制規(guī)范以黑色字體表示，推薦規(guī)范以藍(lán)色字體表示。4.2 總則1、標(biāo)識(shí)符的命名應(yīng)該使用具有實(shí)際含義的英文單詞作為標(biāo)識(shí)符的名稱。具體的標(biāo)識(shí)符包括：包名、

4、類名、方法名、屬性名、方法參數(shù)、局部變量名等；要求使用具有實(shí)際含義的英文單詞作為標(biāo)識(shí)符的名稱，不應(yīng)該使用漢語拼音、 數(shù)字序列等作為標(biāo)識(shí)符的名稱， 如： Class Yongh（u 用戶）、 int C_1001都不是符合規(guī)范的標(biāo)識(shí)符。標(biāo)識(shí)符應(yīng)該盡量使用完整的英文單詞的組合作為標(biāo)識(shí)符的名稱，當(dāng)需要使用縮寫時(shí)，只能使用計(jì)算機(jī)領(lǐng)域或業(yè)務(wù)領(lǐng)域內(nèi)公認(rèn)的縮寫，如： url 、html 等就是符合規(guī)范的縮寫；縮寫的大小寫要求同普通英文單詞，具體視標(biāo)識(shí)符的類型而定。2、模塊名稱應(yīng)該全部使用小寫字母和下劃線。如：core.cache_service就是一個(gè)符合規(guī)范的模塊路徑。3、包的命名盡量短小，使用全部小寫的

5、方式，不可以使用下劃線。如：mon.token_serviceH個(gè)符合規(guī)范的包名（其中core和common都表示不同層級(jí)的包名）mon_service.token不符合命名規(guī)范的包名， 其中 common_service應(yīng)該是一個(gè)包名，但是包含的下劃線4、類的名稱通常使用名詞，并且首字母大寫，如果類名由多個(gè)英文單詞組成時(shí)， 每個(gè)英文單詞的首字母也要大寫。 模塊內(nèi)部使用的類采用 _CapWord 的方式。不符合規(guī)范的類名如：class metadataclass Metadatafactory符合規(guī)范的如：class Metadataclass MetadataFactory類名的首字母大寫，

6、類名由多個(gè)英文單詞組成時(shí)，每個(gè)英文單詞的首字母大寫。5、函數(shù)命名使用全部小寫的方式，可以使用下劃線。6、類的屬性(方法和變量)命名使用全部小寫的方式，可以使用下劃線。7、類的屬性有三種作用域 public, non-public和 subclass API non-public 屬性的成員函數(shù)需要加上一個(gè)下劃線做前綴。8、類的屬性若與關(guān)鍵字名字沖突，使用后綴一個(gè)下劃線，盡量不要使用更加縮略或其他方式9、異常命名使用CapWords+Error后綴的方式10 、靜態(tài)常量要全部使用大寫字母；常量由多個(gè)單詞組成時(shí)，單詞之間使用 _隔開。符合規(guī)范的示例如下：SESSION_MAX_NUMBER = 2

7、0;DEFAULT_CLASS_NAME =“BaseBean”;常量全部使用大寫字母，如常量由多個(gè)單詞組成時(shí)，單詞之間使用_隔開。11、代碼縮進(jìn)使用4個(gè)空格的縮進(jìn)，不要使用 Tap,更不能yM合使用tab 和空格12 、每行最大長(zhǎng)度為100 個(gè)字符，換行可以使用反斜杠，最好使用圓括號(hào)，換行點(diǎn)要在操作符的后邊。13 、類和上一個(gè)函數(shù)定義之間空兩行，類中的方法定義之間空一行，函數(shù)內(nèi)邏輯無關(guān)段落之間空一行。14 、導(dǎo)入模塊的順序：按照標(biāo)準(zhǔn)，三方和自己編寫的順序依次排放，之間空一行。15、空格的使用各種右括號(hào)前不要加空格逗號(hào)、冒號(hào)、分號(hào)前不要加空格函數(shù)的左括號(hào)前不要加空格，如 func(1)序列的左

8、括號(hào)前不要加空格，如 list1操作符左右各加一個(gè)空格，不要為了對(duì)齊增加空格。函數(shù)默認(rèn)參數(shù)使用的賦值符左右省略空格16、注釋規(guī)范注釋必須跟當(dāng)前代碼保持一致。塊注釋，在一段代碼前增加的注釋。在#后面加一個(gè)空格。段落之間以只有 #的行間隔。行注釋，在一句代碼后面加注釋。17、函數(shù)體積函數(shù)的體積嚴(yán)重影響閱讀性，所以對(duì)于一個(gè)產(chǎn)品的全部代碼， 90%的函數(shù)體積需要保持在小于30行，其中不包括注釋和空行。其他編碼注意事項(xiàng)：盡可能使用is/is not取代'='比如if x is not None要優(yōu)于if x使用基于類的異常，每個(gè)模塊或者包都有自己的異常類，此異常類繼承自 Exception異常中不要使用裸露的except， except 后跟上具體的 exceptions異常中 try 的代碼盡可能的少。5. Reference Documents 參考文檔5.1 External Refer