python編碼規範整理
阿新 • • 發佈:2020-12-28
一.為什麼要進行Python編碼規範
- 統一美
- 方便自己與他人閱讀
- 方便後續管理
二.有哪些需要注意的地方
1. 名稱
建立資料夾/檔案/變數等,編寫程式碼要遵循pep8規範(一些潛規則)
- 資料夾, 小寫 & 小寫下劃線 例如:data_utils、commands等
- 檔案,小寫 & 小寫加下劃線 例如: page.py、db_convert.py等
- 變數,
全域性變數, 大寫 & 大寫加下劃線 例如: NAME = "wanglisha"、BASE_NAME = 18等
區域性變數, 小寫 & 小寫加下劃線 例如: data = [11, 12, 13]、user_parent_id = 9等
2. 註釋
- 檔案夾註釋
例如:在模組的__init__.py檔案中描述整個模組(資料夾,這裡是模組)的作用:
"""
資料夾xxx的作用是xxxx,或起到了xxxx的作用,詳細為:
xxxxx
"""
- 檔案註釋
可直接在檔案頭部進行註釋,備註說明這個檔案起到的作用,舉例說明:
- 程式碼註釋
使用行註釋與塊註釋對必要的程式碼步驟進行說明即可
3. TODO
基於註釋可以實現TODO效果,舉例說明:
在Pycharm中註釋後的文字顯示的灰色,一旦加上TODO之後,顯示黃色,如上所示,提示性更強
4. 條件的巢狀條件語句一定要想辦法減少巢狀的層級(最好不要超過3層) 萬一超過 那是沒有辦法的事情 最好不要
過多的條件巢狀會導致不必要的程式碼冗餘,產生過多時間複雜度等
5. 簡單邏輯先處理
6. 迴圈(*)
儘量少迴圈多幹事,提高程式碼效率
舉例:使用字典key value分別複製來進行說明,方法一中使用for迴圈進行復制相對比方法二中迴圈的次數要少,相對效率高
key_list = [] value_list = [] info = {'k1': 'v1', 'k2': 'v2', 'k3': 'v3'} # 方法一:使用for迴圈進行賦值 相對效率高 for key, value in info.items(): key_list.append(key) value_list.append(value) # 方法二:直接迴圈賦值 相對效率低 key_list = list(info.keys()) value_list = list(info.values())
7. 變數和值
等號左右間
Pycharm的選單欄/快捷鍵:Code->Reformat Code/ctrl+alt+L