python PEP8編碼規(guī)范

一.代碼的編排

1縮進(jìn)4個空格的縮進(jìn)(編輯器都可以完成的功能),不使用TaP憾朴,更不能混合使用Tap和空格

2每行最大的長度為79,換行可以使用反斜杠,最好使用圓括號,換行點要在原操作符的后面敲回車锈至。

3 類和top-level函數(shù)定義之間空兩行;類中的方法定義之間空一行异吻;函數(shù)內(nèi)邏輯無關(guān)段落之間空一行裹赴;其他地方盡量不要再空行。

二.編排文檔

1 模塊內(nèi)容的順序:模塊說明和docstring—import—globals&constants—其他定義诀浪。其中import部分棋返,又按標(biāo)準(zhǔn)、三方和自己編寫順序依次排放雷猪,之間空一行睛竣。

2 不要在一句import中多個庫,比如import os, sys不推薦求摇。

3.如果采用from XX import XX引用庫射沟,可以省略‘module.’,都是可能出現(xiàn)命名沖突与境,這時就要采用import XX验夯。

三.空格的使用

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

1 各種右括號前不要加空格挥转。

2 逗號、冒號共屈、分號前不要加空格绑谣。

3 函數(shù)的左括號前不要加空格。如Func(1)拗引。

4 序列的左括號前不要加空格借宵。如list[2]。

5 操作符左右各加一個空格矾削,不要為了對齊增加空格壤玫。

6 函數(shù)默認(rèn)參數(shù)使用的賦值符左右省略空格豁护。

7 不要將多句語句寫在同一行,盡管使用‘欲间;’允許择镇。

8 if/for/while語句中,即使執(zhí)行語句只有一句括改,也必須另起一行腻豌。

四.注釋

1總體的原則錯誤的注釋不如沒有注釋。所以當(dāng)一段代碼發(fā)生變化時候第一件事情就是要修改注釋嘱能!

2注釋必須使用英文吝梅,最好是完整的句子,首字母大寫惹骂,句后要有結(jié)束符苏携,結(jié)束符后面跟兩個空格。

五.命名規(guī)則

1包和模塊名應(yīng)該簡短对粪,全部用小寫字母,多字母之間可以用單下滑線連接

2類名遵循駝峰命名

3全局變量名應(yīng)盡量只在模塊內(nèi)部使用, 對可能使用語句 from moduleName import variableName 而被導(dǎo)入的模塊右冻,應(yīng)采用 __all__ 機(jī)制來防止全局變量被別的模塊導(dǎo)入, 或者在全局變量名開頭加一個前置下劃線.

4函數(shù)名應(yīng)該為全部小寫的凹駝峰規(guī)則

5常量全部使用大寫字母的凹駝峰規(guī)則來表示, 通常在模塊頂格定義

6非公開方法和實例變量開頭使用前置下劃線

有時候可能會為了避免與子類命名沖突,采用兩個前置下劃線

需要注意的是: 若 class Foo 的屬性名為 __a著拭, 該屬性是不能以 Foo.__a 的方式訪問的(執(zhí)著的用戶還是可以通過Foo._Foo__a 來訪問), 所以通常雙前置下劃線僅被用來避免與基類的屬性發(fā)生命名沖突纱扭。

圖片發(fā)自簡書App
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市儡遮,隨后出現(xiàn)的幾起案子乳蛾,更是在濱河造成了極大的恐慌,老刑警劉巖鄙币,帶你破解...
    沈念sama閱讀 206,311評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件肃叶,死亡現(xiàn)場離奇詭異,居然都是意外死亡十嘿,警方通過查閱死者的電腦和手機(jī)因惭,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來绩衷,“玉大人蹦魔,你說我怎么就攤上這事〈狡福” “怎么了版姑?”我有些...
    開封第一講書人閱讀 152,671評論 0 342
  • 文/不壞的土叔 我叫張陵柱搜,是天一觀的道長迟郎。 經(jīng)常有香客問我,道長聪蘸,這世上最難降的妖魔是什么宪肖? 我笑而不...
    開封第一講書人閱讀 55,252評論 1 279
  • 正文 為了忘掉前任表制,我火速辦了婚禮,結(jié)果婚禮上控乾,老公的妹妹穿的比我還像新娘么介。我一直安慰自己,他們只是感情好蜕衡,可當(dāng)我...
    茶點故事閱讀 64,253評論 5 371
  • 文/花漫 我一把揭開白布壤短。 她就那樣靜靜地躺著,像睡著了一般慨仿。 火紅的嫁衣襯著肌膚如雪久脯。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,031評論 1 285
  • 那天镰吆,我揣著相機(jī)與錄音帘撰,去河邊找鬼。 笑死万皿,一個胖子當(dāng)著我的面吹牛摧找,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播牢硅,決...
    沈念sama閱讀 38,340評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼蹬耘,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了减余?” 一聲冷哼從身側(cè)響起婆赠,我...
    開封第一講書人閱讀 36,973評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎佳励,沒想到半個月后休里,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡赃承,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,937評論 2 323
  • 正文 我和宋清朗相戀三年妙黍,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瞧剖。...
    茶點故事閱讀 38,039評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡拭嫁,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出抓于,到底是詐尸還是另有隱情做粤,我是刑警寧澤,帶...
    沈念sama閱讀 33,701評論 4 323
  • 正文 年R本政府宣布捉撮,位于F島的核電站怕品,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏巾遭。R本人自食惡果不足惜肉康,卻給世界環(huán)境...
    茶點故事閱讀 39,254評論 3 307
  • 文/蒙蒙 一闯估、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧吼和,春花似錦涨薪、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至末捣,卻和暖如春光督,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背塔粒。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工结借, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人卒茬。 一個月前我還...
    沈念sama閱讀 45,497評論 2 354
  • 正文 我出身青樓船老,卻偏偏與公主長得像,于是被迫代替她去往敵國和親圃酵。 傳聞我的和親對象是個殘疾皇子柳畔,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,786評論 2 345

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

  • 一 代碼編排 縮進(jìn) 4個空格的縮進(jìn)(編輯器都可以完成此功能),不使用Tap郭赐,更不能混合使用Tap和空格薪韩。 每行最大...
    隨風(fēng)化作雨閱讀 355評論 0 1
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)捌锭,斷路器俘陷,智...
    卡卡羅2017閱讀 134,599評論 18 139
  • --< > 令人討厭的小人物身上有著愚蠢的一致性 --(A Foolish Consistency is the ...
    LittleWizard閱讀 3,213評論 0 4
  • 第2章 基本語法 2.1 概述 基本句法和變量 語句 JavaScript程序的執(zhí)行單位為行(line),也就是一...
    悟名先生閱讀 4,118評論 0 13
  • Android編碼規(guī)范 源文件基礎(chǔ) 文件名 源文件以其最頂層的類名來命名观谦,大小寫敏感拉盾,文件擴(kuò)展名為.java。 文...
    呼呼哥閱讀 932評論 0 0