Python 常用PEP8規範

標籤：sel   子類   sorry   pat   type   函數調用   python3   機制   物件類型   

目錄

• 目錄
• 代碼布局
  • 縮排
  • 最大行寬
  • 空行
  • 模組匯入
  • 字串
  • 運算式和語句中的空格
  • 注釋
  • 命名規則
• 編程建議

代碼布局縮排

• 每級縮排用4個空格。
• 括弧中使用垂直隱式縮排或使用首行凸排。

EXAMPLE:

# (垂直隱式縮排)對準左括弧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‘,)

錯誤示範:

# 不使用垂直對齊時，第一行不能有參數。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‘,    )

最大行寬

• 每行最大行寬不超過 79 個字元
• 一般續行可使用反斜線
• 括弧內續行不需要使用反斜線

EXAMPLE:

# 無括弧續行， 利用反斜線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))

空行

• 兩行空行用於分割頂層函數和類的定義
• 單個空行用於分割類定義中的方法

EXAMPLE:

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

模組匯入

• 匯入的每個模組應該單獨成行
• 匯入順序如下: (各模組類型匯入之間要有空行分割，各組裡面的模組的順序按模組首字母自上而下升序排列)
  
  • 標準庫
  • 相關的第三方庫
  • 本地庫

EXAMPLE:

# 按模組首字母排序匯入, 依此遞推import activeimport adidasimport create

錯誤樣本:

# 一行匯入多模組import sys, os, knife# 不按首字母匯入import createimport activeimport beyond

字串

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

EXAMPLE:

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

運算式和語句中的空格

• 括弧裡邊避免空格

EXAMPLE:

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

錯誤樣本:

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

• 逗號，冒號，分號之前避免空格
  EXAMPLE:

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

錯誤樣本:

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

• 函數調用的左括弧之前不能有空格

EXAMPLE:

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

錯誤樣本:

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

• 賦值等操作符前後不能因為對齊而添加多個空格

EXAMPLE:

x = 1y = 2long_variable = 3

錯誤樣本:

x             = 1y             = 2long_variable = 3

• 二元運算子兩邊放置一個空格
  
  • 涉及 = 的複合操作符 ( += , -=等)
  • 比較操作符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not )
  • 邏輯操作符( and , or , not )

EXAMPLE:

a = ba or b# 括弧內的操作符不需要空格name = get_name(age, sex=None, city=Beijing)

注釋

• 註解區塊
  註解區塊通常應用在代碼前，並和代碼有同樣的縮排。每行以 ‘# ’ 開頭, 而且#後面有單個空格。

EXAMPLE:

# 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])

• 單行注釋(應避免無謂的注釋)

EXAMPLE:

x = x + 1 # Compensate for border

• 文檔字串

EXAMPLE:

# 多行文檔, 首行首字母大寫，結尾的 """ 應該單獨成行"""Return a foobangOptional plotz says to frobnicate the bizbaz first."""# 單行的文檔， 結尾的 """ 在同一行。"""Return a foobang"""

命名規則

• 包和模組名:
  包和模組名應該簡短，全部用小寫字母, 多字母之間可以使用單底線串連。

• 類名:
  遵循駝峰命名

class MyClass(object):    pass

• 全域變數名:
  全域變數名應盡量只在模組內部使用, 對可能使用語句 from moduleName import variableName 而被匯入的模組，應採用 __all__ 機制來防止全域變數被別的模組匯入, 或者在全域變數名開頭加一個前置底線.

EXAMPLE:

_name = ‘name‘

• 函數名
  函數名應該為全部小寫凹駝峰規則。

EXAMPLE:

vcenter_connection = ‘‘

• 常量名
  常量全部使用大寫字母的凹駝峰規則來表示, 通常在模組頂格定義

EXAMPLE:

MAX_OVERFLOW = ‘‘TOTAL = 1

• 方法名和執行個體變數
  
  • 非公開方法和執行個體變數開頭使用前置底線
  • 有時候可能會為了避免與子類命名衝突，採用兩個前置底線
    需要注意的是: 若 class Foo 的屬性名稱為 __a， 該屬性是不能以 Foo.__a 的方式訪問的(執著的使用者還是可以通過Foo._Foo__a 來訪問), 所以通常雙前置底線僅被用來避免與基類的屬性發生命名衝突。

編程建議

• None 的比較用 is 或 is not，而不要用 ==

• 用 is not 代替 not … is, 前者的可讀性更好

EXAMPLE:

# Yesif foo is not None# Noif not foo is None

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

# Yesdef f(x):     return 2*x# Nof = lambda x: 2*x

• 異常類應該繼承自Exception，而不是 BaseException

• Python 2 中用raise ValueError(‘message‘) 代替 raise ValueError, ‘message‘

• (考慮相容python3和續行的方便性)

• 捕獲異常時盡量指明具體異常, 盡量不用 except Exception, 應該捕獲 出了什麼問題，而不是 問題發生

EXAMPLE:

# Yes (捕獲具體異常)try:    import platform_specific_moduleexcept ImportError:    platform_specific_module = None# No (不要全域捕獲)try:    import platform_specific_moduleexcept:    platform_specific_module = None

• try/except 子句中的代碼要儘可能的少, 以免屏蔽掉其他的錯誤

EXAMPLE:

# Yestry:    value = collection[key]except KeyError:    return key_not_found(key)else:    return handle_value(value)# Notry:    return handle_value(collection[key])except KeyError:    # 可能會捕捉到 handle_value()中的 KeyError, 而不是 collection 的    return key_not_found(key)

• 函數或者方法在沒有傳回值時要明確返回 None

# Yesdef foo():    return None# Nodef foo():    return

• 使用字串方法而不是 string 模組
  python 2.0 以後字串方法總是更快，而且與 Unicode 字串使用了相同的 API

• 使用使用 .startswith() 和 .endswith() 代替字串切片來檢查首碼和尾碼
  startswith() 和 endswith 更簡潔，利於減少錯誤

EXAMPLE:

# Yesif foo.startswith(‘bar‘):# Noif foo[:3] == ‘bar‘:

• 使用 isinstance() 代替物件類型的比較

EXAMPLE:

# Yesif isinstance(obj, int):# Noif type(obj) is type(1):

• 空序列類型對象的 bool 為 False:

# Yesif not seq:   passif seq:   pass# Noif len(seq):   passif not len(seq):   pass

• 不要用 == 進行 bool 比較

# Yesif greeting:   pass# Noif greeting == True   passif greeting is True: # Worse   pass

Python 常用PEP8規範