python命名規範-google-styleguid__python

google-styleguid 命名

Tip
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name. 應該避免的名稱

1. 單字元名稱, 除了計數器和迭代器.2. 包/模組名中的連字號(-)3. 雙底線開頭並結尾的名稱(Python保留, 例如__init__)

命名規範

1. 所謂”內部(Internal)”表示僅模組內可用, 或者, 在類內是保護或私人的.2. 用單底線(_)開頭表示模組變數或函數是protected的(使用import * from時不會包含).3. 用雙底線(__)開頭的執行個體變數或方法表示類內私人.4. 將相關的類和頂級函數放在同一個模組裡. 不像Java, 沒必要限制一個類一個模組.5. 對類名使用大寫字母開頭的單詞(如CapWords, 即Pascal風格), 但是模組名應該用小寫加底線的方式(如lower_with_under.py). 儘管已經有很多現存的模組使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模組名碰巧和類名一致, 這會讓人困擾.

Python之父Guido推薦的規範

Main

Tip
即使是一個打算被用作指令碼的檔案, 也應該是可匯入的. 並且簡單的匯入不應該導致這個指令碼的主功能(main functionality)被執行, 這是一種副作用. 主功能應該放在一個main()函數中.
在Python中, pydoc以及單元測試要求模組必須是可匯入的. 你的代碼應該在執行主程式前總是檢查 if name == ‘main’ , 這樣當模組被匯入時主程式就

def main():      ...if __name__ == '__main__':    main()

頂級代塊匯入時都會被執行. 要小心不要去調用函數, 建立對象, 或者執行那些不應該在使用pydoc時執行的操作.

https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/ python命名規範

1、包名、模組名，小寫；多個單詞時，底線分割

login.pyuser_login.py

2、類名，首字母大寫，多個單詞時，用駝峰

class Login:class UserLogin:

3、方法名，小寫，多個單詞時，底線分割

def login:def user_login:

4、變數名，小寫，多個單詞時，底線分割

user = user

5、常量名，大寫，多個單詞時，底線分割

MAX_OVERFLOW

6、參數名，全小寫

def login(self, user, password):