Python中PEP8風格之帶下劃線的變量和函數(shù)的意義

Python的代碼風格一般由PEP8來描述。這個文檔描述了Python風格的方方面面悬荣,一般開發(fā)人員遵循這個規(guī)定風格,可以最大限度的保持代碼風格的相似性,便于開發(fā)人員之間的交流和維護荆烈。

在Python中,下劃線是比較特殊的字符竟趾,含有下劃線的也許有合數(shù)的意義°竟海現(xiàn)在對根據(jù)PEP8規(guī)定的風格,來說明帶下劃線的變量和函數(shù)的意義岔帽。

  • 變量
  • 前面帶一個_的變量:表明這是一個私有變量玫鸟,外部類最好不要調(diào)用它。這只是一種聲明犀勒,因為Python中沒有所謂的私有變量一說屎飘,所以外部類還是可以訪問的。
  • 前帶兩個贾费,后帶兩個的變量:標明是內(nèi)部變量钦购,外部類訪問不了。
  • 大寫加下劃線的變量:標明是不會發(fā)生改變的全局變量褂萧。
  • 函數(shù)
  • 前帶_的函數(shù):聲明是私有函數(shù)押桃,只是一種聲明。
  • 前帶兩個箱玷,后帶兩個的函數(shù):標明是特殊函數(shù)怨规。
以上是帶下劃線的函數(shù)和變量的總結陌宿。

具體請看下面的例子:

  • 變量
  • 常量 : 大寫加下劃線,對于不會發(fā)生改變的全局變量波丰,使用大寫加下劃線壳坪。
    USER_CONSTANT
  • 私有變量 : 小寫和一個前導下劃線
    _private_value
    Python 中不存在私有變量一說,若是遇到需要保護的變量掰烟,使用小寫和一個前導下劃線爽蝴。但這只是程序員之間的一個約定,用于警告說明這是一個私有變量纫骑,外部類不要去訪問它蝎亚。但實際上,外部類還是可以訪問到這個變量先馆。
  • 內(nèi)置變量 : 小寫发框,兩個前導下劃線和兩個后置下劃線
    class
    兩個前導下劃線會導致變量在解釋期間被更名。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突煤墙,用戶定義的變量要嚴格避免這種風格梅惯,以免導致混亂。
  • 函數(shù)和方法:總體而言仿野,函數(shù)和方法應該使用铣减,小寫和下劃線。小寫和下劃線已成為規(guī)范脚作。

  • 私有方法 : 小寫和一個前導下劃線
    def _secrete(self):
    print "don't test me."
    這里和私有變量一樣葫哗,并不是真正的私有訪問權限。同時也應該注意一般函數(shù)不要使用兩個前導下劃線(當遇到兩個前導下劃線時球涛,Python 的名稱改編特性將發(fā)揮作用)劣针。特殊函數(shù)后面會提及。

  • 特殊方法 : 小寫和兩個前導下劃線亿扁,兩個后置下劃線:
    def add(self, other):
    return int.add(other)
    這種風格只應用于特殊函數(shù)酿秸,比如操作符重載等。

  • 函數(shù)參數(shù) : 小寫和下劃線魏烫,缺省值等號兩邊無空格
    def connect(self, user=None):
    self._user = user

    • 類總是使用駝峰格式命名,即所有單詞首字母大寫其余字母小寫肝箱。類名應該簡明哄褒,精確,并足以從中理解該類所完成的工作煌张。常見的一個方法是使用表示其類型或者特性的后綴呐赡,例如:
      SQLEngine
      MimeTypes

    • 對于基類而言,可以使用一個 Base 或者 Abstract 前綴:
      BaseCookie
      AbstractGroup

    • 如下類骏融,示例
      class UserProfile(object):
      def init(self, profile):
      return self._profile = profile

          def profile(self):
             return self._profile
      
  • 模塊和包

    • 除特殊模塊 init 之外链嘀,模塊名稱都使用不帶下劃線的小寫字母
      import os
      import sys
    • 若是它們實現(xiàn)一個協(xié)議萌狂,那么通常使用lib為后綴,例如:
      import smtplib
  • 關于參數(shù)

  • 不要用斷言來實現(xiàn)靜態(tài)類型檢測
    斷言可以用于檢查參數(shù)怀泊,但不應僅僅是進行靜態(tài)類型檢測茫藏。 Python是動態(tài)類型語言,靜態(tài)類型檢測違背了其設計思想霹琼。斷言應該用于避免函數(shù)不被毫無意義的調(diào)用务傲。

  • 不要濫用 *args 和 **kwargs
    *args 和 **kwargs 參數(shù)可能會破壞函數(shù)的健壯性。它們使簽名變得模糊枣申,而且代碼常常開始在不應該的地方構建小的參數(shù)解析器售葡。

  • 其他

  • 使用 has 或 is 前綴命名布爾元素
    is_connect = True
    has_member = False

  • 用復數(shù)形式命名序列
    members = ['user_1', 'user_2']

  • 用顯式名稱命名字典
    person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}

  • 避免通用名稱
    諸如 list, dict, sequence 或者 element 這樣的名稱應該避免。

  • 避免現(xiàn)有名稱
    諸如 os, sys 這種系統(tǒng)已經(jīng)存在的名稱應該避免忠藤。

  • Python編碼風格的一些數(shù)字

    • 一行列數(shù) : PEP 8 規(guī)定為 79 列挟伙,這有些苛刻了。根據(jù)自己的情況模孩,比如不要超過滿屏時編輯器的顯示列數(shù)尖阔。這樣就可以在不動水平游標的情況下,方便的查看代碼瓜贾。
    • 一個函數(shù) : 不要超過 30 行代碼, 即可顯示在一個屏幕類诺祸,可以不使用垂直游標即可看到整個函數(shù)。
    • 一個類 : 不要超過 200 行代碼祭芦,不要有超過 10 個方法筷笨。
    • 一個模塊 不要超過 500 行。
  • 驗證腳本
    可以安裝一個 pep8 腳本用于驗證你的代碼風格是否符合 PEP8龟劲。

     >>easy_install pep8
    
     >>pep8 -r --ignoire E501 Test.py
    
     #這個命令行的意思是胃夏,重復打出錯誤,并且忽略 501 錯誤(代碼超過 79 行)昌跌。
最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末仰禀,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子蚕愤,更是在濱河造成了極大的恐慌答恶,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,039評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件萍诱,死亡現(xiàn)場離奇詭異悬嗓,居然都是意外死亡,警方通過查閱死者的電腦和手機裕坊,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評論 3 395
  • 文/潘曉璐 我一進店門包竹,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事周瞎∶缢酰” “怎么了?”我有些...
    開封第一講書人閱讀 165,417評論 0 356
  • 文/不壞的土叔 我叫張陵声诸,是天一觀的道長酱讶。 經(jīng)常有香客問我,道長双絮,這世上最難降的妖魔是什么浴麻? 我笑而不...
    開封第一講書人閱讀 58,868評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮囤攀,結果婚禮上软免,老公的妹妹穿的比我還像新娘。我一直安慰自己焚挠,他們只是感情好膏萧,可當我...
    茶點故事閱讀 67,892評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著蝌衔,像睡著了一般榛泛。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上噩斟,一...
    開封第一講書人閱讀 51,692評論 1 305
  • 那天曹锨,我揣著相機與錄音,去河邊找鬼剃允。 笑死沛简,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的斥废。 我是一名探鬼主播椒楣,決...
    沈念sama閱讀 40,416評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼牡肉!你這毒婦竟也來了捧灰?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,326評論 0 276
  • 序言:老撾萬榮一對情侶失蹤统锤,失蹤者是張志新(化名)和其女友劉穎毛俏,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體饲窿,經(jīng)...
    沈念sama閱讀 45,782評論 1 316
  • 正文 獨居荒郊野嶺守林人離奇死亡拧抖,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,957評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了免绿。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,102評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡擦盾,死狀恐怖嘲驾,靈堂內(nèi)的尸體忽然破棺而出淌哟,到底是詐尸還是另有隱情,我是刑警寧澤辽故,帶...
    沈念sama閱讀 35,790評論 5 346
  • 正文 年R本政府宣布徒仓,位于F島的核電站,受9級特大地震影響誊垢,放射性物質發(fā)生泄漏掉弛。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,442評論 3 331
  • 文/蒙蒙 一喂走、第九天 我趴在偏房一處隱蔽的房頂上張望殃饿。 院中可真熱鬧,春花似錦芋肠、人聲如沸乎芳。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,996評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽奈惑。三九已至,卻和暖如春睡汹,著一層夾襖步出監(jiān)牢的瞬間肴甸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,113評論 1 272
  • 我被黑心中介騙來泰國打工囚巴, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留原在,地道東北人。 一個月前我還...
    沈念sama閱讀 48,332評論 3 373
  • 正文 我出身青樓文兢,卻偏偏與公主長得像晤斩,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子姆坚,可洞房花燭夜當晚...
    茶點故事閱讀 45,044評論 2 355

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