Python3編碼規範：PEP8 中文版

代碼佈局

1. 縮進

每級縮進用4個空格。括號中使用垂直隱式縮進或使用懸掛縮進。
正確示範：

# (垂直隱式縮進)對準左括號 foo = long_function_name(var_one, var_two,                          var_three, var_four) # (懸掛縮進) 通常狀況只需多一層縮進 foo = long_function_name(     var_one, var_two,     var_three, var_four) # (懸掛縮進) 但下面狀況, 需再加多一層縮進， 和後續的語句塊區分開來 def long_function_name(         var_one, var_two, var_three,         var_four):     print(var_one) # 右括號回退 my_list = [     1, 2, 3,     4, 5, 6, ] result = some_function_that_takes_arguments(     'a', 'b', 'c',     'd', 'e', 'f', ) 

2.最大行寬

每行最大行寬不超過 79 個字符，通常續行可以使用反斜槓，括號內續行不須要使用反斜槓
正確示範：

# 無括號續行， 利用反斜槓 with open('/path/to/some/file/you/want/to/read') as file_1, \      open('/path/to/some/file/being/written', 'w') as file_2:     file_2.write(file_1.read()) # 括號內續行， 儘可能在運算符後再續行 class Rectangle(Blob):     def __init__(self, width, height,                  color='black', emphasis=None, highlight=0):         if (width == 0 and height == 0 and                 color == 'red' and emphasis == 'strong' or                 highlight > 100):             raise ValueError("sorry, you lose")         if width == 0 and height == 0 and (color == 'red' or                                            emphasis is None):             raise ValueError("I don't think so -- values are %s, %s" %                              (width, height)) 

3. 空行

兩行空行用於分割頂層函數和類的定義
單個空行用於分割類定義中的方法
正確示範：

# 類的方法定義用單個空行分割，兩行空行分割頂層函數和類的定義。 class A(object):     def method1():         pass     def method2():         pass def method3():     pass 

5. 模塊導入

導入的每一個模塊應該單獨成行，導入順序以下: (各模塊類型導入之間要有空行分割，各組裏面的模塊的順序按模塊首字母自上而下升序排列) 
1.標準庫
2.相關的第三方庫
3.本地庫
正確示範：

# 按模塊首字母排序導入, 依此遞推 import active import adidas import create

6. 字符串

單引號和雙引號做用是同樣的，但必須保證成對存在，不能夾雜使用. (建議句子使用雙引號, 單詞使用單引號, 但不強制.)

# 單引號和雙引號效果同樣 name = 'JmilkFan' name = "Hey Guys!"

7.表達式和語句中的空格

括號裏邊避免空格
正確示範：

spam(ham[1], {eggs: 2})

逗號，冒號，分號以前避免空格 
正確示範：

if x == 4: print x, y; x, y = y, x

函數調用的左括號以前不能有空格
正確示範：

spam(1) dct['key'] = lst[index]

賦值等操做符先後不能由於對齊而添加多個空格
正確示範：

x = 1
y = 2
long_variable = 3

二元運算符兩邊放置一個空格，涉及 = 的複合操做符 ( += , -=等)，比較操做符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not )，邏輯操做符( and , or , not )
正確示範：

a = b
a or b # 括號內的操做符不須要空格 name = get_name(age, sex=None, city=Beijing)

8. 註釋

註釋塊 
註釋塊一般應用在代碼前，並和代碼有一樣的縮進。每行以 ‘# ’ 開頭, 並且#後面有單個空格。
正常示範：

# Have to define the param `args(List)`,  # otherwise will be capture the CLI option when execute `python manage.py server`. # oslo_config: (args if args is not None else sys.argv[1:]) CONF(args=[], default_config_files=[CONFIG_FILE])

單行註釋(應避免無謂的註釋)

文檔字符串
多行文檔, 首行首字母大寫，結尾的 """ 應該單獨成行，單行的文檔， 結尾的 """ 在同一行。

9. 命名規則

包和模塊名: 
包和模塊名應該簡短，所有用小寫字母, 多字母之間可使用單下劃線鏈接。

類名: 
遵循駝峯命名

class MyClass(object):     pass

全局變量名: 
全局變量名應儘可能只在模塊內部使用, 對可能使用語句 from moduleName import variableName 而被導入的模塊，應採用 __all__ 機制來防止全局變量被別的模塊導入, 或者在全局變量名開頭加一個前置下劃線.

正確示範：

_name = 'name'

函數名 
函數名應該爲所有小寫的凹駝峯規則。
正確示範：

vcenter_connection

常量名 
常量所有使用大寫字母的凹駝峯規則來表示, 一般在模塊頂格定義

正確示範：

MAX_OVERFLOW = '' TOTAL = 1

方法名和實例變量 
非公開方法和實例變量開頭使用前置下劃線，有時候可能會爲了不與子類命名衝突，採用兩個前置下劃線，須要注意的是: 若 class Foo 的屬性名爲 __a， 該屬性是不能以 Foo.__a 的方式訪問的(執著的用戶仍是能夠經過Foo._Foo__a 來訪問), 因此一般雙前置下劃線僅被用來避免與基類的屬性發生命名衝突。

10. 編程建議

None 的比較用 is 或 is not，而不要用 ==，用 is not 代替 not … is, 前者的可讀性更好

正確示範

if foo is not None

使用函數定義關鍵字 def 代替 lambda 賦值給標識符, 這樣更適合於回調和字符串表示

正確示範：

def f(x):      return 2*x

異常類應該繼承自Exception，而不是 BaseException，捕獲異常時儘可能指明具體異常, 儘可能不用 except Exception, 應該捕獲 出了什麼問題，而不是 問題發生

正確示範

#捕獲具體異常 try:     import platform_specific_module except ImportError:     platform_specific_module = None

try/except 子句中的代碼要儘量的少, 以避免屏蔽掉其餘的錯誤
正確示範：

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

函數或者方法在沒有返回值時要明確返回 None
正確示範：

def foo():     return None

使用字符串方法而不是 string 模塊 ，使用 .startswith() 和 .endswith() 代替字符串切片來檢查前綴和後綴 ，startswith() 和 endswith 更簡潔，利於減小錯誤

正確示範：

if foo.startswith('bar'):

使用 isinstance() 代替對象類型的比較

正確示範：

if isinstance(obj, int):

空序列類型對象的 bool 爲 False:
正確示範：

if not seq:
   pass
if seq:
   pass

不要用 == 進行 bool 比較
正確示範

if greeting:    pass