Python PEP8編碼規範
通常會聽別人提到PEP8,但是具體指什麼內容呢?《Python Enhancement Proposal #8》 (8號python增強提案)又叫PEP8,它是針對python而編訂的程式碼格式指南。
程式語言不是藝術,而是工作或者工具,所以整理並遵循一套編碼規範十分必要。
1. 程式碼佈局
1.1 縮排
- 每級縮排用4個空格
- 括號中使用垂直隱式縮排或懸掛縮排
- 不使用Tap,更不能混合使用Tap和空格
正確示範
# (垂直隱式縮排)對準左括號起的第一個字元 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', )
1.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))
1.3 空行
- 兩行空行用於分割頂層函式和類的定義
- 單個空行用於分割類定義中的方法
- 函式內邏輯無關段落之間空一行;其他地方儘量不要再空行
- 雖然可以使用‘;’,但儘量不要把多個語句寫在同一行
- if/for/while語句中,即使執行語句只有一句,也必須另起一行
class A(object): # 類的方法定義用單個空行分割
def method1():
pass
def method2():
pass
def method3(): # 兩行空行分割頂層函式和類的定義
pass
1.4 模組匯入
- 匯入的每個模組應該單獨成行
- 匯入順序如下: 先標準庫,再相關的第三方庫,最後本地庫。(匯入不同型別的模組之間,要有空行分割,各組裡面的模組順序按首字母自上而下升序排列)
# 正確示範
import active # 按模組首字母排序匯入, 依此遞推
import adidas
import create
# 錯誤示範
import sys, os, knife # 錯誤:一行匯入多模組
import create # 錯誤:不按模組首字母匯入
import active
import beyond
1.5 字串
單引號和雙引號作用是一樣的,但必須保證成對存在,不能夾雜使用。 (建議句子使用雙引號, 單詞使用單引號, 但不強制。)
# 單引號和雙引號效果一樣
name = 'JmilkFan'
name = "Hey Guys!"
1.6 表示式和語句中的空格
括號裡邊避免空格
spam(ham[1], {eggs: 2}) # 正確示範
spam( ham[ 1 ], { eggs: 2 } ) # 錯誤示範
逗號,冒號,分號之前避免空格
if x == 4: print x, y; x, y = y, x # 正確示範
if x == 4 : print x , y ; x , y = y , x # 錯誤示範
函式呼叫的左括號之前不能有空格
spam(1)
dct['key'] = lst[index] # 正確示範
spam (1)
dct ['key'] = lst [index] # 錯誤示範
賦值等操作符前後不能因為對齊而新增多個空格
x = 1 # 正確示範
y = 2
long_variable = 3
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)
1.7 註釋
總體原則,錯誤的註釋不如沒有註釋。所以當一段程式碼發生變化時,第一件事就是修改註釋。
- 註釋塊
- 註釋塊通常應用在程式碼前,並和程式碼有同樣的縮排。每行以 ‘# ’ 開頭, 而且#後面有單個空格。段落之間以只有‘#’的行間隔
# 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])
- 單行註釋(這種方式儘量少使用)
x = x + 1 # Compensate for border
- 1
- 文件字串
# 多行文件, 首行首字母大寫,結尾的 """ 應該單獨成行
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
# 單行的文件, 結尾的 """ 在同一行。
"""Return a foobang"""
-
為共有的模組、函式、類、方法寫docstrings;非共有的沒有必要寫docstrings,但是可以寫註釋(在def的下一行)
-
應避免無謂的註釋
1.8 命名規則
-
包和模組名 包和模組名應該簡短,全部用小寫字母, 多字母之間可以使用單下劃線連線。
-
類名 遵循駝峰命名。
class MyClass(object):
pass
- 1
- 2
- 全域性變數名
全域性變數名應儘量只在模組內部使用, 對可能使用語句
from moduleName import variableName
而被匯入的模組,應採用__all__
機制來防止全域性變數被別的模組匯入, 或者在全域性變數名開頭加一個前置下劃線。
_name = 'name'
- 1
- 函式名 函式名應該為全部小寫的凹駝峰規則。
vcenter_connection = ''
- 1
- 常量名 常量全部使用大寫字母的凹駝峰規則來表示, 通常在模組頂格定義。
MAX_OVERFLOW = ''
TOTAL = 1
-
方法名和例項變數
- 非公開方法和例項變數開頭使用前置下劃線
- 有時候可能會為了避免與子類命名衝突,採用兩個前置下劃線 需要注意的是: 若 class Foo 的屬性名為 __a, 該屬性是不能以 Foo.__a 的方式訪問的(執著的使用者還是可以通過Foo._Foo__a 來訪問), 所以通常雙前置下劃線僅被用來避免與基類的屬性發生命名衝突。
2. 程式設計建議
-
編碼中應考慮到其他python實現的效率問題,比如運算子‘+’在CPython中效率很高,在Jython中卻非常低
-
None 的比較用 is 或 is not,而不要用 ==;儘可能使用‘is’‘is not’取代‘==’;用 is not 代替 not … is, 前者的可讀性更好
if foo is not None # Yes
if not foo is None # No
if x is not None # if x is not None 要優於if x
if x
- 使用函式定義關鍵字 def 代替 lambda 賦值給識別符號, 這樣更適合於回撥和字串表示
def f(x): # Yes
return 2*x
f = lambda x: 2*x # No
- 異常類應該繼承自Exception,而不是 BaseException;捕獲異常時儘量指明具體異常, 儘量不用 except Exception;應該捕獲出了什麼問題,而不是問題發生
try: # Yes (捕獲具體異常)
import platform_specific_module
except ImportError:
platform_specific_module = None
try: # No (不要全域性捕獲)
import platform_specific_module
except:
platform_specific_module = None
- try/except 子句中的程式碼要儘可能的少, 以免遮蔽掉其他的錯誤
try: # Yes
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
try: # No
return handle_value(collection[key])
except KeyError:
# 可能會捕捉到handle_value()中的 KeyError, 而不是collection的
return key_not_found(key)
- 函式或者方法在沒有返回值時要明確返回 None
def foo(): # Yes
return None
def foo(): # No
return
-
使用字串方法而不是 string 模組 python 2.0 以後字串方法總是更快,而且與 Unicode 字串使用了相同的 API
-
使用使用 .startswith() 和 .endswith() 代替字串切片來檢查字首和字尾 startswith() 和 endswith 更簡潔,利於減少錯誤
if foo.startswith('bar'): # Yes
if foo[:3] == 'bar': # No
- 使用 isinstance() 比較物件的型別
if isinstance(obj, int): # Yes
if type(obj) is type(1): # No
- 判斷序列空或不空 空序列型別物件的 bool 為 False:
if not seq: # Yes
pass
if seq:
pass
if len(seq): # No
pass
if not len(seq):
pass
- 不要使用 == 進行 bool 比較
# Yes
if greeting:
pass
# No
if greeting == True
pass
if greeting is True: # Worse
pass
-
字串不要以空格收尾
-
二進位制資料判斷使用
if boolvalue
的方式 -
使用Map和Reduce,不要使用迴圈
全文地址請點選:https://blog.csdn.net/yjk13703623757/article/details/79322172?utm_source=copy