一 代碼編排

• 縮進 4個空格的縮進（編輯器都可以完成此功能）戳玫，不使用Tap，更不能混合使用Tap和空格未斑。
• 每行最大長度79咕宿，換行可以使用反斜杠，最好使用圓括號。換行點要在操作符的后邊敲回車府阀。
• 類和top-level函數定義之間空兩行缆镣；類中的方法定義之間空一行；函數內邏輯無關段落之間空一行试浙；其他地方盡量不要再空行董瞻。

二 文檔編排

• 模塊內容的順序：模塊說明和docstring—import—globals&constants—其他定義。其中import部分田巴，又按標準钠糊、三方和自己編寫順序依次排放，之間空一行壹哺。
• 不要在一句import中多個庫抄伍，比如import os, sys不推薦。
• 如果采用from XX import XX引用庫管宵，可以省略‘module.’截珍，都是可能出現命名沖突，這時就要采用import XX啄糙。

三 空格的使用

總體原則笛臣，避免不必要的空格。
1 各種右括號前不要加空格隧饼。
2 逗號沈堡、冒號、分號前不要加空格燕雁。
3 函數的左括號前不要加空格诞丽。如Func(1)。
4 序列的左括號前不要加空格拐格。如list[2]僧免。
5 操作符左右各加一個空格，不要為了對齊增加空格捏浊。
6 函數默認參數使用的賦值符左右省略空格懂衩。
7 不要將多句語句寫在同一行，盡管使用‘金踪；’允許浊洞。
8 if/for/while語句中，即使執(zhí)行語句只有一句胡岔，也必須另起一行法希。

四 注釋

總體原則，錯誤的注釋不如沒有注釋靶瘸。所以當一段代碼發(fā)生變化時苫亦，第一件事就是要修改注釋毛肋！
注釋必須使用英文，最好是完整的句子屋剑，首字母大寫润匙，句后要有結束符，結束符后跟兩個空格饼丘，開始下一句趁桃。如果是短語，可以省略結束符肄鸽。
1 塊注釋卫病，在一段代碼前增加的注釋。在‘#’后加一空格典徘。段落之間以只有‘#’的行間隔蟀苛。比如：

# Description : Module config.
# 
# Input : None
#
# Output : None

2 行注釋，在一句代碼后加注釋逮诲。比如：x = x + 1 # Increment x
但是這種方式盡量少使用帜平。
3 避免無謂的注釋。

五 文檔描述

1 為所有的共有模塊梅鹦、函數裆甩、類、方法寫docstrings齐唆；非共有的沒有必要嗤栓，但是可以寫注釋（在def的下一行）。
2 如果docstring要換行箍邮，參考如下例子,詳見PEP 257

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名規(guī)范

總體原則茉帅，新編代碼必須按下面命名風格進行，現有庫的編碼盡量保持風格锭弊。
1 盡量單獨使用小寫字母‘l’堪澎，大寫字母‘O’等容易混淆的字母。
2 模塊命名盡量短小味滞，使用全部小寫的方式樱蛤，可以使用下劃線。
3 包命名盡量短小剑鞍，使用全部小寫的方式刹悴，不可以使用下劃線。
4 類的命名使用CapWords的方式攒暇，模塊內部使用的類采用_CapWords的方式。
5 異常命名使用CapWords+Error后綴的方式子房。
6 全局變量盡量只在模塊內有效形用，類似C語言中的static就轧。實現方法有兩種，一是all機制;二是前綴一個下劃線田度。
7 函數命名使用全部小寫的方式妒御，可以使用下劃線。
8 常量命名使用全部大寫的方式镇饺，可以使用下劃線乎莉。
9 類的屬性（方法和變量）命名使用全部小寫的方式，可以使用下劃線奸笤。
9 類的屬性有3種作用域public惋啃、non-public和subclass API，可以理解成C++中的public监右、private边灭、protected，non-public屬性前健盒，前綴一條下劃線绒瘦。
11 類的屬性若與關鍵字名字沖突，后綴一下劃線扣癣，盡量不要使用縮略等其他方式惰帽。
12 為避免與子類屬性命名沖突，在類的一些屬性前父虑，前綴兩條下劃線该酗。比如：類Foo中聲明__a,訪問時，只能通過Foo._Foo__a频轿，避免歧義垂涯。如果子類也叫Foo，那就無能為力了航邢。
13 類的方法第一個參數必須是self耕赘，而靜態(tài)方法第一個參數必須是cls。

七 編碼建議

1 編碼中考慮到其他python實現的效率等問題膳殷，比如運算符‘+’在CPython（Python）中效率很高操骡，都是Jython中卻非常低，所以應該采用.join()的方式赚窃。
2 盡可能使用‘is’‘is not’取代‘==’册招，比如if x is not None 要優(yōu)于if x。
3 使用基于類的異常勒极，每個模塊或包都有自己的異常類是掰，此異常類繼承自Exception。
4 異常中不要使用裸露的except辱匿，except后跟具體的exceptions键痛。
5 異常中try的代碼盡可能少炫彩。比如：

try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)

要優(yōu)于

try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)

6 使用startswith() and endswith()代替切片進行序列前綴或后綴的檢查。比如

Yes: if foo.startswith(‘bar’):優(yōu)于
No: if foo[:3] == ‘bar’:
7 使用isinstance()比較對象的類型絮短。比如
Yes: if isinstance(obj, int): 優(yōu)于
No: if type(obj) is type(1):
8 判斷序列空或不空江兢，有如下規(guī)則
Yes: if not seq:
if seq:
優(yōu)于
No: if len(seq)
if not len(seq)
9 字符串不要以空格收尾。
10 二進制數據判斷使用 if boolvalue的方式丁频。