編碼規范
縮進
- 統一使用4個空格進行縮進
行寬
每行代碼盡量不超過80個字符(在特殊情況下可以略微超過80，但最長不得超過120)
理由：
- 這在查看side-by-side的diff時很有幫助
- 方便在控制臺下查看代碼
- 太長可能是設計有缺陷
引號
簡單說，自然語言使用雙引號，機器標示使用單引號，因此代碼里多數應該使用單引號
-
自然語言 使用雙引號
"..."例如錯誤信息；很多情況還是unicode，使用
u"你好世界" 機器標識 使用單引號
'...'例如dict里的key正則表達式 使用原生的雙引號
r"..."文檔字符串(docstring) 使用三個雙引號
"""......"""
空行
- 模塊級函數和類定義之間空兩行；
- 類成員函數之間空一行；
class A:
def __init__(self):
pass
def hello(self):
pass
def main():
pass
- 可以使用多個空行分隔多組相關的函數
- 函數中可以使用空行分隔出邏輯相關的代碼
編碼
- 文件使用UTF-8編碼
- 文件頭部加入#--conding:utf-8--標識 (Python 3 以上版本不需要)
import語句
- import語句應該分行書寫
#正確的寫法
import os
import sys
#不推薦的寫法
import sys,os
#正確的寫法
from subprocess import Popen, PIPE
- import語句應該使用 absolute import
#正確的寫法
from foo.bar import Bar
#不推薦的寫法
from ..bar import Bar
- import語句應該放在文件頭部，置于模塊說明及docstring之后，于全局變量之前；
- import語句應該按照順序排列，每組之間用一個空行分隔
import os
import sys
import msgpack
import zmq
import foo
- 導入其他模塊的類定義時，可以使用相對導入
from myclass import MyClass
- 如果發生命名沖突，則可使用命名空間
import bar
import foo.bar
bar.Bar()
foo.bar.Bar()
空格
-
在二元運算符兩邊各空一格
[=,-,+=,==,>,in,is not, and]:# 正確的寫法 i = i + 1 submitted += 1 x = x * 2 - 1 hypot2 = x * x + y * y c = (a + b) * (a - b) # 不推薦的寫法 i=i+1 submitted +=1 x = x*2 - 1 hypot2 = x*x + y*y c = (a+b) * (a-b) -
函數的參數列表中，
,之后要有空格# 正確的寫法 def complex(real, imag): pass # 不推薦的寫法 def complex(real,imag): pass -
函數的參數列表中，默認值等號兩邊不要添加空格
# 正確的寫法 def complex(real, imag=0.0): pass # 不推薦的寫法 def complex(real, imag = 0.0): pass -
左括號之后，右括號之前不要加多余的空格
# 正確的寫法 spam(ham[1], {eggs: 2}) # 不推薦的寫法 spam( ham[1], { eggs : 2 } ) -
字典對象的左括號之前不要多余的空格
# 正確的寫法 dict['key'] = list[index] # 不推薦的寫法 dict ['key'] = list [index] -
不要為對齊賦值語句而使用的額外空格
# 正確的寫法 x = 1 y = 2 long_variable = 3 # 不推薦的寫法 x = 1 y = 2 long_variable = 3
換行
Python支持括號內的換行。這時有兩種情況。
-
第二行縮進到括號的起始處
foo = long_function_name(var_one, var_two, var_three, var_four) -
第二行縮進4個空格，適用于起始括號就換行的情形
def long_function_name( var_one, var_two, var_three, var_four): print(var_one)
-
使用反斜杠\換行，二元運算符
+.等應出現在行末；長字符串也可以用此法換行session.query(MyTable).\ filter_by(id=1).\ one() print 'Hello, '\ '%s %s!' %\ ('Harry', 'Potter') -
禁止復合語句，即一行中包含多個語句：
# 正確的寫法 do_first() do_second() do_third() # 不推薦的寫法 do_first();do_second();do_third(); -
if/for/while一定要換行：# 正確的寫法 if foo == 'blah': do_blah_thing() # 不推薦的寫法 if foo == 'blah': do_blash_thing()
注釋
塊注釋
-
“#”號后空一格，段落件用空行分開（同樣需要“#”號）# 塊注釋 # 塊注釋 # # 塊注釋 # 塊注釋
行注釋
-
至少使用兩個空格和語句分開，注意不要使用無意義的注釋
# 正確的寫法 x = x + 1 # 邊框加粗一個像素 # 不推薦的寫法(無意義的注釋) x = x + 1 # x加1
docstring
- docstring的規范在 PEP 257 中有詳細描述，其中最其本的兩點：
所有的公共模塊、函數、類、方法，都應該寫docstring。私有方法不一定需要，但應該在
def后提供一個塊注釋來說明。-
docstring的結束
"""應該獨占一行，除非此docstring只有一行。"""Return a foobar Optional plotz says to frobnicate the bizbaz first. """ """Oneline docstring"""
命名規范
- 應避免使用小寫字母
l(L)，大寫字母O(o)或I(i)單獨作為一個變量的名稱，以區分數字1和0; - 包和模塊使用全小寫命名，盡量不要使用下劃線
- 類名使用
CamelCase命名風格，內部類可用一個下劃線開頭 - 函數使用下劃線分隔的小寫命名
- 當參數名稱和Python保留字沖突，可在最后添加一個下劃線，而不是使用縮寫或自造的詞
- 常量使用以下劃線分隔的大寫命名
MAX_OVERFLOW = 100
Class FooBar:
def foo_bar(self, print_):
print(print_)