1. 程式人生 > >python 編寫規範 pep8 筆記

python 編寫規範 pep8 筆記

 



PEP8 Python 編碼規範

一 程式碼編排
1 縮排。4個空格的縮排(編輯器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。
2 每行最大長度79,換行可以使用反斜槓,最好使用圓括號。換行點要在操作符的後邊敲回車。
3 類和top-level函式定義之間空兩行;類中的方法定義之間空一行;函式內邏輯無關段落之間空一行;其他地方儘量不要再空行。

二 文件編排
1 模組內容的順序:模組說明和docstring—import—globals&constants—其他定義。其中import部分,又按標準、三方和自己編寫順序依次排放,之間空一行。
2 不要在一句import中多個庫,比如import os, sys不推薦。
3 如果採用from XX import XX引用庫,可以省略‘module.’,都是可能出現命名衝突,這時就要採用import XX。

三 空格的使用
        總體原則,避免不必要的空格。
1 各種右括號前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函式的左括號前不要加空格。如Func(1)。
4 序列的左括號前不要加空格。如list[2]。
5 操作符左右各加一個空格,不要為了對齊增加空格。
6 函式預設引數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行,儘管使用‘;’允許。
8 if/for/while語句中,即使執行語句只有一句,也必須另起一行。

四 註釋
        總體原則,錯誤的註釋不如沒有註釋。所以當一段程式碼發生變化時,第一件事就是要修改註釋!
        註釋必須使用英文,最好是完整的句子,首字母大寫,句後要有結束符,結束符後跟兩個空格,開始下一句。如果是短語,可以省略結束符。
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.

"""

六 命名規範
        總體原則,新編程式碼必須按下面命名風格進行,現有庫的編碼儘量保持風格。
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,而靜態方法第一個引數必須是cls。

七 編碼建議
1 編碼中考慮到其他python實現的效率等問題,比如運算子‘+’在CPython(Python)中效率很高,都是Jython中卻非常低,所以應該採用.join()的方式。
2 儘可能使用‘is’‘is not’取代‘==’,比如if x is not None 要優於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)
要優於
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'):優於
No: if foo[:3] == 'bar':
7 使用isinstance()比較物件的型別。比如
Yes: if isinstance(obj, int): 優於
No: if type(obj) is type(1):
8 判斷序列空或不空,有如下規則
Yes: if not seq:
if seq:
優於
No: if len(seq)
if not len(seq)
9 字串不要以空格收尾。
10 二進位制資料判斷使用 if boolvalue的方式。

 

 

code sample message
E1 Indentation
E101 indentation contains mixed spaces and tabs
E111 indentation is not a multiple of four
E112 expected an indented block
E113 unexpected indentation
E114 indentation is not a multiple of four (comment)
E115 expected an indented block (comment)
E116 unexpected indentation (comment)
E121 (*^) continuation line under-indented for hanging indent
E122 (^) continuation line missing indentation or outdented
E123 (*) closing bracket does not match indentation of opening bracket’s line
E124 (^) closing bracket does not match visual indentation
E125 (^) continuation line with same indent as next logical line
E126 (*^) continuation line over-indented for hanging indent
E127 (^) continuation line over-indented for visual indent
E128 (^) continuation line under-indented for visual indent
E129 (^) visually indented line with same indent as next logical line
E131 (^) continuation line unaligned for hanging indent
E133 (*) closing bracket is missing indentation
E2 Whitespace
E201 whitespace after ‘(‘
E202 whitespace before ‘)’
E203 whitespace before ‘:’
E211 whitespace before ‘(‘
E221 multiple spaces before operator
E222 multiple spaces after operator
E223 tab before operator
E224 tab after operator
E225 missing whitespace around operator
E226 (*) missing whitespace around arithmetic operator
E227 missing whitespace around bitwise or shift operator
E228 missing whitespace around modulo operator
E231 missing whitespace after ‘,’, ‘;’, or ‘:’
E241 (*) multiple spaces after ‘,’
E242 (*) tab after ‘,’
E251 unexpected spaces around keyword / parameter equals
E261 at least two spaces before inline comment
E262 inline comment should start with ‘# ‘
E265 block comment should start with ‘# ‘
E266 too many leading ‘#’ for block comment
E271 multiple spaces after keyword
E272 multiple spaces before keyword
E273 tab after keyword
E274 tab before keyword
E275 missing whitespace after keyword
E3 Blank line
E301 expected 1 blank line, found 0
E302 expected 2 blank lines, found 0
E303 too many blank lines (3)
E304 blank lines found after function decorator
E305 expected 2 blank lines after end of function or class
E4 Import
E401 multiple imports on one line
E402 module level import not at top of file
E5 Line length
E501 (^) line too long (82 > 79 characters)
E502 the backslash is redundant between brackets
E7 Statement
E701 multiple statements on one line (colon)
E702 multiple statements on one line (semicolon)
E703 statement ends with a semicolon
E704 (*) multiple statements on one line (def)
E711 (^) comparison to None should be ‘if cond is None:’
E712 (^) comparison to True should be ‘if cond is True:’ or ‘if cond:’
E713 test for membership should be ‘not in’
E714 test for object identity should be ‘is not’
E721 (^) do not compare types, use ‘isinstance()’
E731 do not assign a lambda expression, use a def
E741 do not use variables named ‘l’, ‘O’, or ‘I’
E742 do not define classes named ‘l’, ‘O’, or ‘I’
E743 do not define functions named ‘l’, ‘O’, or ‘I’
E9 Runtime
E901 SyntaxError or IndentationError
E902 IOError
W1 Indentation warning
W191 indentation contains tabs
W2 Whitespace warning
W291 trailing whitespace
W292 no newline at end of file
W293 blank line contains whitespace
W3 Blank line warning
W391 blank line at end of file
W5 Line break warning
W503 (*) line break occurred before a binary operator
W6 Deprecation warning
W601 .has_key() is deprecated, use ‘in’
W602 deprecated form of raising exception
W603 ‘<>’ is deprecated, use ‘!=’
W604 backticks are deprecated, use ‘repr()’

分類: Python