python命名規(guī)范

Google Python命名規(guī)范

  • module_name, 模塊

  • package_name, 包

模塊與包 包就是多個(gè)模塊的集合呕诉,單個(gè) .py文件 就是一個(gè)模塊

  • ClassName, 類

  • method_name, 方法

  • ExceptionName, 異常

  • function_name, 函數(shù)

  • GLOBAL_VAR_NAME, 全局變量

  • instance_var_name, 實(shí)例

  • function_parameter_name, 參數(shù)

  • local_var_name. 本變量

總是使用首字母大寫單詞串缘厢。如MyClass。內(nèi)部類可以使用額外的前導(dǎo)下劃線义钉。

函數(shù)&方法

小寫+下劃線

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

函數(shù)和方法的參數(shù)

如果一個(gè)函數(shù)的參數(shù)名稱和保留的關(guān)鍵字沖突捶闸,通常使用一個(gè)后綴下劃線

全局變量

對(duì)于from M import *導(dǎo)入語句夜畴,如果想阻止導(dǎo)入模塊內(nèi)的全局變量可以使用舊有的規(guī)范,在全局變量上加一個(gè)前導(dǎo)的下劃線删壮。
注意:應(yīng)避免使用全局變量

變量

小寫贪绘,由下劃線連接各個(gè)單詞。如color = WHITE央碟,this_is_a_variable = 1
注意
1.不論是類成員變量還是全局變量税灌,均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標(biāo)識(shí)亿虽。
3.變量名不應(yīng)帶有類型信息菱涤,因?yàn)镻ython是動(dòng)態(tài)類型語言。如 iValue洛勉、names_list粘秆、dict_obj 等都是不好的命名。

常量

常量名所有字母大寫收毫,由下劃線連接各個(gè)單詞如MAX_OVERFLOW攻走,TOTAL。

異常

以“Error”作為后綴此再。

文件名

全小寫,可使用下劃線

應(yīng)該是簡(jiǎn)短的昔搂、小寫的名字。如果下劃線可以改善可讀性可以加入输拇。如mypackage摘符。

模塊

與包的規(guī)范同。如mymodule策吠。

縮寫

命名應(yīng)當(dāng)盡量使用全拼寫的單詞议慰,縮寫的情況有如下兩種:
1.常用的縮寫,如XML奴曙、ID等,在命名時(shí)也應(yīng)只大寫首字母草讶,如XmlParser洽糟。
2.命名中含有長(zhǎng)單詞,對(duì)某個(gè)單詞進(jìn)行縮寫。這時(shí)應(yīng)使用約定成俗的縮寫方式坤溃。

例如:

function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num拍霜,等。

前導(dǎo)后綴下劃線

一個(gè)前導(dǎo)下劃線:表示非公有薪介。
一個(gè)后綴下劃線:避免關(guān)鍵字沖突祠饺。
兩個(gè)前導(dǎo)下劃線:當(dāng)命名一個(gè)類屬性引起名稱沖突時(shí)使用。
兩個(gè)前導(dǎo)和后綴下劃線:“魔”(有特殊用圖)對(duì)象或者屬性汁政,例如init或者file道偷。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字,而只是使用它們记劈。
注意:關(guān)于下劃線的使用存在一些爭(zhēng)議勺鸦。

特定命名方式

主要是指 xxx 形式的系統(tǒng)保留字命名法。項(xià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)保留字命名法军拟。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市誓禁,隨后出現(xiàn)的幾起案子懈息,更是在濱河造成了極大的恐慌,老刑警劉巖现横,帶你破解...
    沈念sama閱讀 206,013評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件漓拾,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡戒祠,警方通過查閱死者的電腦和手機(jī)骇两,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,205評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來姜盈,“玉大人低千,你說我怎么就攤上這事×笏蹋” “怎么了示血?”我有些...
    開封第一講書人閱讀 152,370評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)救拉。 經(jīng)常有香客問我难审,道長(zhǎng),這世上最難降的妖魔是什么亿絮? 我笑而不...
    開封第一講書人閱讀 55,168評(píng)論 1 278
  • 正文 為了忘掉前任告喊,我火速辦了婚禮麸拄,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘黔姜。我一直安慰自己拢切,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,153評(píng)論 5 371
  • 文/花漫 我一把揭開白布秆吵。 她就那樣靜靜地躺著淮椰,像睡著了一般。 火紅的嫁衣襯著肌膚如雪纳寂。 梳的紋絲不亂的頭發(fā)上主穗,一...
    開封第一講書人閱讀 48,954評(píng)論 1 283
  • 那天,我揣著相機(jī)與錄音烈疚,去河邊找鬼黔牵。 笑死,一個(gè)胖子當(dāng)著我的面吹牛爷肝,可吹牛的內(nèi)容都是我干的猾浦。 我是一名探鬼主播,決...
    沈念sama閱讀 38,271評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼灯抛,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼金赦!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起对嚼,我...
    開封第一講書人閱讀 36,916評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤夹抗,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后纵竖,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體漠烧,經(jīng)...
    沈念sama閱讀 43,382評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,877評(píng)論 2 323
  • 正文 我和宋清朗相戀三年靡砌,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了已脓。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 37,989評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡通殃,死狀恐怖度液,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情画舌,我是刑警寧澤堕担,帶...
    沈念sama閱讀 33,624評(píng)論 4 322
  • 正文 年R本政府宣布,位于F島的核電站曲聂,受9級(jí)特大地震影響霹购,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜朋腋,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,209評(píng)論 3 307
  • 文/蒙蒙 一厕鹃、第九天 我趴在偏房一處隱蔽的房頂上張望兢仰。 院中可真熱鬧,春花似錦剂碴、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,199評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至请垛,卻和暖如春催训,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背宗收。 一陣腳步聲響...
    開封第一講書人閱讀 31,418評(píng)論 1 260
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人顽冶。 一個(gè)月前我還...
    沈念sama閱讀 45,401評(píng)論 2 352
  • 正文 我出身青樓宝当,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親匈勋。 傳聞我的和親對(duì)象是個(gè)殘疾皇子礼旅,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,700評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容