python編碼規範
阿新 • • 發佈:2017-12-23
模塊 blog 現在 www. 其它 保護 spa https www
python編碼規範
參考
https://www.python.org/dev/peps/pep-0008/
http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/
https://google.github.io/styleguide/pyguide.html
用Python進行開發時的編碼風格約定(epes:PEP 008《Style Guide for Python Code》)
- 分號:不要在行尾加分號, 也不要用分號將兩條命令放在同一行.
- 行長度:每行不超過80個字符
- 縮進:使用4個空格來縮進代碼,不要使用tab,或者tab空格混用
- 空行:函數或者類定義之間空2行,方法定義之間空1行
- 空格:不要在逗號, 分號, 冒號前面加空格, 但應該在它們後面加(除了在行尾).
- 類:如果一個類不繼承自其它類, 就顯式的從object繼承. 嵌套類也一樣.
- 導入格式:每個導入應該獨占一行
- 語句:通常每個語句應該獨占一行
命名
module_name
package_name
method_name
instance_var_name
function_parameter_name
local_var_name
function_name
ClassName
ExceptionName
GLOBAL_VAR_NAME
1、所謂”內部(Internal)”表示僅模塊內可用, 或者, 在類內是保護或私有的
- 用單下劃線(_)開頭表示模塊變量或函數是protected的(使用from package import * 時不會包含)
- 用雙下劃線(__)開頭的實例變量或方法表示類內私有
2、將相關的類和頂級函數放在同一個模塊裏。 不像Java, 沒必要限制一個類一個模塊
3、對類名使用大寫字母開頭的單詞(駝峰命名), 但是模塊名應該用小寫加下劃線的方式(如lower_with_under.py)。盡管已經有很多現存的模塊使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模塊名碰巧和類名一致, 這會讓人困擾。
python編碼規範