python PEP8 style

總結(jié):
變量:

  1. 前帶_的變量: 標明是一個私有變量, 只用于標明, 外部類還是可以訪問到這個變量
  2. 前帶兩個_ ,后帶兩個_ 的變量: 標明是內(nèi)置變量,
  3. 大寫加下劃線的變量: 標明是 不會發(fā)生改變的全局變量
    函數(shù):
  4. 前帶_的變量: 標明是一個私有函數(shù), 只用于標明,
  5. 前帶兩個_ ,后帶兩個_ 的函數(shù): 標明是特殊函數(shù)

Python 的代碼風(fēng)格由 PEP 8 描述。這個文檔描述了 Python 編程風(fēng)格的方方面面鳖昌。在遵守這個文檔的條件下局骤,不同程序員編寫的 Python 代碼可以保持最大程度的相似風(fēng)格己沛。這樣就易于閱讀缠局,易于在程序員之間交流扎瓶。

1 變量

常量 : 大寫加下劃線

 USER_CONSTANT

對于不會發(fā)生改變的全局變量蕊爵,使用大寫加下劃線著蛙。

私有變量 : 小寫和一個前導(dǎo)下劃線

_private_value

Python 中不存在私有變量一說删铃,若是遇到需要保護的變量,使用小寫和一個前導(dǎo)下劃線踏堡。但這只是程序員之間的一個約定猎唁,用于警告說明這是一個私有變量,外部類不要去訪問它顷蟆。但實際上诫隅,外部類還是可以訪問到這個變量。

內(nèi)置變量 : 小寫帐偎,兩個前導(dǎo)下劃線和兩個后置下劃線

__class__

兩個前導(dǎo)下劃線會導(dǎo)致變量在解釋期間被更名逐纬。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突。用戶定義的變量要嚴格避免這種風(fēng)格削樊。以免導(dǎo)致混亂豁生。

2 函數(shù)和方法

總體而言應(yīng)該使用,小寫和下劃線漫贞。但有些比較老的庫使用的是混合大小寫甸箱,即首單詞小寫,之后每個單詞第一個字母大寫迅脐,其余小寫芍殖。但現(xiàn)在,小寫和下劃線已成為規(guī)范仪际。

私有方法 : 小寫和一個前導(dǎo)下劃線

 def _secrete(self):
    print "don't test me."

這里和私有變量一樣围小,并不是真正的私有訪問權(quán)限。同時也應(yīng)該注意一般函數(shù)不要使用兩個前導(dǎo)下劃線(當(dāng)遇到兩個前導(dǎo)下劃線時树碱,Python 的名稱改編特性將發(fā)揮作用)肯适。特殊函數(shù)后面會提及。

特殊方法 : 小寫和兩個前導(dǎo)下劃線成榜,兩個后置下劃線

 def __add__(self, other):
    return int.__add__(other)

這種風(fēng)格只應(yīng)用于特殊函數(shù)框舔,比如操作符重載等。

函數(shù)參數(shù) : 小寫和下劃線赎婚,缺省值等號兩邊無空格

 def connect(self, user=None):
    self._user = user

3 類

  • 類總是使用駝峰格式命名刘绣,即所有單詞首字母大寫其余字母小寫。類名應(yīng)該簡明挣输,精確纬凤,并足以從中理解類所完成的工作。常見的一個方法是使用表示其類型或者特性的后綴撩嚼,例如:
    SQLEngine
    MimeTypes

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

    class UserProfile(object):
        def __init__(self, profile):
            return self._profile = profile
    
        def profile(self):
            return self._profile
    

4 模塊和包

除特殊模塊 init 之外,模塊名稱都使用不帶下劃線的小寫字母完丽。
若是它們實現(xiàn)一個協(xié)議恋技,那么通常使用lib為后綴,例如: import smtplib

5 關(guān)于參數(shù)

5.1 不要用assert來實現(xiàn)靜態(tài)類型檢測

assert可以用于檢查參數(shù)逻族,但不應(yīng)僅僅是進行靜態(tài)類型檢測蜻底。 python 是動態(tài)類型語言,靜態(tài)類型檢測違背了其設(shè)計思想聘鳞。assert應(yīng)該用于避免函數(shù)不被毫無意義的調(diào)用薄辅。

5.2 不要濫用 *args 和 **kwargs

*args 和 **kwargs 參數(shù)可能會破壞函數(shù)的健壯性。它們使簽名變得模糊搁痛,而且代碼常常開始在不應(yīng)該的地方構(gòu)建小的參數(shù)解析器长搀。

6 其他

6.1 使用 has 或 is 前綴命名布爾元素

 is_connect = True
 has_member = False

6.2 用復(fù)數(shù)形式命名序列

 members = ['user_1', 'user_2']

6.3 用顯式名稱命名字典

person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}

7 一些數(shù)字

一行列數(shù) : PEP 8 規(guī)定為 79 列,這有些苛刻了鸡典。根據(jù)自己的情況源请,比如不要超過滿屏?xí)r編輯器的顯示列數(shù)。這樣就可以在不動水平游標的情況下彻况,方便的查看代碼谁尸。

一個函數(shù) : 不要超過 30 行代碼, 即可顯示在一個屏幕類,可以不使用垂直游標即可看到整個函數(shù)纽甘。
一個類 : 不要超過 200 行代碼良蛮,不要有超過 10 個方法。
一個模塊 不要超過 500 行悍赢。

8 驗證腳本

可以安裝一個 pep8 腳本用于驗證你的代碼風(fēng)格是否符合 PEP8决瞳。

easy_install pep8

pep8 -r --ignoire E501 Test.py

這個命令行的意思是货徙,重復(fù)打出錯誤,并且忽略 501 錯誤(代碼超過 79 行)皮胡。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末痴颊,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子屡贺,更是在濱河造成了極大的恐慌蠢棱,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,843評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件甩栈,死亡現(xiàn)場離奇詭異泻仙,居然都是意外死亡,警方通過查閱死者的電腦和手機量没,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,538評論 3 392
  • 文/潘曉璐 我一進店門玉转,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人允蜈,你說我怎么就攤上這事冤吨。” “怎么了饶套?”我有些...
    開封第一講書人閱讀 163,187評論 0 353
  • 文/不壞的土叔 我叫張陵漩蟆,是天一觀的道長。 經(jīng)常有香客問我妓蛮,道長怠李,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,264評論 1 292
  • 正文 為了忘掉前任蛤克,我火速辦了婚禮捺癞,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘构挤。我一直安慰自己髓介,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,289評論 6 390
  • 文/花漫 我一把揭開白布筋现。 她就那樣靜靜地躺著唐础,像睡著了一般。 火紅的嫁衣襯著肌膚如雪矾飞。 梳的紋絲不亂的頭發(fā)上一膨,一...
    開封第一講書人閱讀 51,231評論 1 299
  • 那天,我揣著相機與錄音洒沦,去河邊找鬼豹绪。 笑死,一個胖子當(dāng)著我的面吹牛申眼,可吹牛的內(nèi)容都是我干的瞒津。 我是一名探鬼主播蝉衣,決...
    沈念sama閱讀 40,116評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼巷蚪!你這毒婦竟也來了买乃?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,945評論 0 275
  • 序言:老撾萬榮一對情侶失蹤钓辆,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后肴焊,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體前联,經(jīng)...
    沈念sama閱讀 45,367評論 1 313
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,581評論 2 333
  • 正文 我和宋清朗相戀三年娶眷,在試婚紗的時候發(fā)現(xiàn)自己被綠了似嗤。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,754評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡届宠,死狀恐怖烁落,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情豌注,我是刑警寧澤伤塌,帶...
    沈念sama閱讀 35,458評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站轧铁,受9級特大地震影響每聪,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜齿风,卻給世界環(huán)境...
    茶點故事閱讀 41,068評論 3 327
  • 文/蒙蒙 一药薯、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧救斑,春花似錦童本、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,692評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至纪他,卻和暖如春鄙煤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背茶袒。 一陣腳步聲響...
    開封第一講書人閱讀 32,842評論 1 269
  • 我被黑心中介騙來泰國打工梯刚, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人薪寓。 一個月前我還...
    沈念sama閱讀 47,797評論 2 369
  • 正文 我出身青樓亡资,卻偏偏與公主長得像澜共,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子锥腻,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,654評論 2 354

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