2018-06-28 python命名規(guī)范

Python命名規(guī)范

Google Python****命名規(guī)范

module_name, 模塊

package_name, 包

ClassName, 類

method_name, 方法

ExceptionName, 異常

function_name, 函數(shù)

GLOBAL_VAR_NAME, 全局變量

instance_var_name, 實例

function_parameter_name, 參數(shù)

local_var_name. 本地變量

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

函數(shù)****&****方法

小寫+下劃線

注意:混合大小寫僅被允許用于這種風格已經(jīng)占據(jù)優(yōu)勢的時候,以便保持向后兼容。

函數(shù)和方法的參數(shù)
如果一個函數(shù)的參數(shù)名稱和保留的關鍵字沖突台丛,通常使用一個后綴下劃線

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

變量

小寫,由下劃線連接各個單詞浪汪。如color = WHITE巴柿,this_is_a_variable = 1
注意
1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴死遭。
2.私有類成員使用單一下劃線前綴標識广恢。
3.變量名不應帶有類型信息,因為Python是動態(tài)類型語言呀潭。如 iValue钉迷、names_list、dict_obj 等都是不好的命名钠署。

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

異常
以“Error”作為后綴枷颊。

文件名
全小寫,可使用下劃線


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

模塊
與包的規(guī)范同隔缀。如mymodule题造。

縮寫
命名應當盡量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫猾瘸,如XML界赔、ID等,在命名時也應只大寫首字母牵触,如XmlParser淮悼。
2.命名中含有長單詞,對某個單詞進行縮寫揽思。這時應使用約定成俗的縮寫方式袜腥。

例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等钉汗。

前導后綴下劃線
一個前導下劃線:表示非公有羹令。
一個后綴下劃線:避免關鍵字沖突鲤屡。
兩個前導下劃線:當命名一個類屬性引起名稱沖突時使用。
兩個前導和后綴下劃線:“魔”(有特殊用圖)對象或者屬性福侈,例如init或者file酒来。絕對不要創(chuàng)造這樣的名字,而只是使用它們肪凛。
注意:關于下劃線的使用存在一些爭議堰汉。

特定命名方式
主要是指 xxx 形式的系統(tǒng)保留字命名法。項目中也可以使用這種命名伟墙,它的意義在于這種形式的變量是只讀的衡奥,這種形式的類成員函數(shù)盡量不要重載。如
class Base(object):
def init(self, id, parent = None):
self.id = id
self.parent = parent
def message(self, msgid):
其中 id远荠、parentmessage 都采用了系統(tǒng)保留字命名法。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末失息,一起剝皮案震驚了整個濱河市譬淳,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌盹兢,老刑警劉巖邻梆,帶你破解...
    沈念sama閱讀 218,682評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異绎秒,居然都是意外死亡浦妄,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評論 3 395
  • 文/潘曉璐 我一進店門见芹,熙熙樓的掌柜王于貴愁眉苦臉地迎上來剂娄,“玉大人,你說我怎么就攤上這事玄呛≡呐常” “怎么了?”我有些...
    開封第一講書人閱讀 165,083評論 0 355
  • 文/不壞的土叔 我叫張陵徘铝,是天一觀的道長耳胎。 經(jīng)常有香客問我,道長惕它,這世上最難降的妖魔是什么怕午? 我笑而不...
    開封第一講書人閱讀 58,763評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮淹魄,結果婚禮上郁惜,老公的妹妹穿的比我還像新娘。我一直安慰自己揭北,他們只是感情好扳炬,可當我...
    茶點故事閱讀 67,785評論 6 392
  • 文/花漫 我一把揭開白布吏颖。 她就那樣靜靜地躺著,像睡著了一般恨樟。 火紅的嫁衣襯著肌膚如雪半醉。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,624評論 1 305
  • 那天劝术,我揣著相機與錄音缩多,去河邊找鬼。 笑死养晋,一個胖子當著我的面吹牛衬吆,可吹牛的內容都是我干的。 我是一名探鬼主播绳泉,決...
    沈念sama閱讀 40,358評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼逊抡,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了零酪?” 一聲冷哼從身側響起冒嫡,我...
    開封第一講書人閱讀 39,261評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎四苇,沒想到半個月后孝凌,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,722評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡月腋,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年蟀架,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片榆骚。...
    茶點故事閱讀 40,030評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡片拍,死狀恐怖,靈堂內的尸體忽然破棺而出寨躁,到底是詐尸還是另有隱情穆碎,我是刑警寧澤,帶...
    沈念sama閱讀 35,737評論 5 346
  • 正文 年R本政府宣布职恳,位于F島的核電站所禀,受9級特大地震影響,放射性物質發(fā)生泄漏放钦。R本人自食惡果不足惜色徘,卻給世界環(huán)境...
    茶點故事閱讀 41,360評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望操禀。 院中可真熱鬧褂策,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至遍搞,卻和暖如春罗侯,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背溪猿。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評論 1 270
  • 我被黑心中介騙來泰國打工钩杰, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人诊县。 一個月前我還...
    沈念sama閱讀 48,237評論 3 371
  • 正文 我出身青樓讲弄,卻偏偏與公主長得像,于是被迫代替她去往敵國和親依痊。 傳聞我的和親對象是個殘疾皇子避除,可洞房花燭夜當晚...
    茶點故事閱讀 44,976評論 2 355

推薦閱讀更多精彩內容