pyhton自動化項目編碼以及命名規範

對於任何一個編程項目來說,都需要一個編碼的規範以及標準,這裏整理了一些Google python的命名規範以及python語言PEP8的編碼規範。

一、命名規範

命名示例:

module_name, 模塊
package_name, 包
ClassName, 類
method_name, 方法
ExceptionName, 異常
function_name, 函數
GLOBAL_VAR_NAME, 全局變量
instance_var_name, 實例
function_parameter_name, 參數
local_var_name. 本變量

總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下劃線。

函數&方法

小寫+下劃線
注意:混合大小寫僅被允許用於這種風格已經佔據優勢的時候,以便保持向後兼容。

函數和方法的參數 如果一個函數的參數名稱和保留的關鍵字衝突,通常使用一個後綴下劃線。

全局變量 對於from M import *導入語句,如果想阻止導入模塊內的全局變量可以使用舊有的規範,在全局變量上加一個前導的下劃線。 注意:應避免使用全局變量。

變量

小寫,由下劃線連接各個單詞。如color = WHITE,this_is_a_variable = 1
注意:
1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標識。
3.變量名不應帶有類型信息,因爲Python是動態類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量

常量名所有字母大寫,由下劃線連接各個單詞如MAX_OVERFLOW,TOTAL。

異常

以“Error”作爲後綴。

文件名

全小寫,可使用下劃線

應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。

模塊

與包的規範同。如mymodule。

縮寫

命名應當儘量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫,如XML、ID等,在命名時也應只大寫首字母,如XmlParser。
2.命名中含有長單詞,對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如:
function 縮寫爲 fn text 縮寫爲 txt object 縮寫爲 obj count 縮寫爲 cnt number 縮寫爲 num,等。

前導後綴下劃線

一個前導下劃線:表示非公有。
一個後綴下劃線:避免關鍵字衝突。
兩個前導下劃線:當命名一個類屬性引起名稱衝突時使用。
兩個前導和後綴下劃線:“魔”(有特殊用圖)對象或者屬性,例如__init__或者__file__。絕對不要創造這樣的名字,而只是使用它們。
注意:關於下劃線的使用存在一些爭議。

特定命名方式

主要是指 xxx 形式的系統保留字命名法。項目中也可以使用這種命名,它的意義在於這種形式的變量是隻讀的,這種形式的類成員函數儘量不要重載。
如:

 class Base(object): 
 	def init(self, id, parent = None): 
 		self.id = id
 		self.parent = parent 
 		
 	def message(self, msgid): 
 		pass

其中 id、parent 和 message 都採用了系統保留字命名法。

二、PEP8 Python編碼規範

關於pep8 python的編碼規範,一般在ide中書寫python代碼時,都會有類似下劃線這樣的格式不規範提示,寫代碼時也要經常注意儘量不要出現不規範的書寫格式。

2.1 代碼編排

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

2.2 文檔編排

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

2.3空格的使用

總體原則,避免不必要的空格。

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

2.3 註釋

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

  1. 塊註釋,在一段代碼前增加的註釋。在‘#’後加一空格。段落之間以只有‘#’的行間隔。比如:
# Description : Module config.
# 
# Input : None
#
# Output : None
  1. 行註釋,在一句代碼後加註釋。比如:
x = x + 1 # Increment x

但是這種方式儘量少使用。

  1. 避免無謂的註釋。

2.5 文檔描述

  1. 爲所有的共有模塊、函數、類、方法寫docstrings;非共有的沒有必要,但是可以寫註釋(在def的下一行)。
  2. 如果docstring要換行,參考如下例子,詳見PEP 257
"""
Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

2.6 命名規範

總體原則,新編代碼必須按下面命名風格進行,現有庫的編碼儘量保持風格。

  1. 儘量單獨使用小寫字母‘l’,大寫字母‘O’等容易混淆的字母。
  2. 模塊命名儘量短小,使用全部小寫的方式,可以使用下劃線。
  3. 包命名儘量短小,使用全部小寫的方式,不可以使用下劃線。
  4. 類的命名使用CapWords的方式,模塊內部使用的類採用_CapWords的方式。
  5. 異常命名使用CapWords+Error後綴的方式。
  6. 全局變量儘量只在模塊內有效,類似C語言中的static。實現方法有兩種,一是__all__機制;二是前綴一個下劃線。
  7. 函數命名使用全部小寫的方式,可以使用下劃線。
  8. 常量命名使用全部大寫的方式,可以使用下劃線。
  9. 類的屬性(方法和變量)命名使用全部小寫的方式,可以使用下劃線。
  10. 類的屬性有3種作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public屬性前,前綴一條下劃線。
  11. 類的屬性若與關鍵字名字衝突,後綴一下劃線,儘量不要使用縮略等其他方式。
  12. 爲避免與子類屬性命名衝突,在類的一些屬性前,前綴兩條下劃線。比如:類Foo中聲明__a,訪問時,只能通過Foo._Foo__a,避免歧義。如果子類也叫Foo,那就無能爲力了。
  13. 類的方法第一個參數必須是self,而靜態方法第一個參數必須是cls。

2.7編碼建議

  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)
  1. 使用startswith() and endswith()代替切片進行序列前綴或後綴的檢查。比如
if foo.startswith(‘bar’):

優於

if foo[:3] == ‘bar’:
  1. 使用isinstance()比較對象的類型。
    比如
if isinstance(obj, int): 

優於

if type(obj) is type(1):
  1. 判斷序列空或不空,有如下規則
if not seq:
if seq:

優於

if len(seq)
if not len(seq)
  1. 字符串不要以空格收尾。
  2. 二進制數據判斷使用 if boolvalue的方式。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章