Python基礎之PEP8規范(代碼寫作規范)

文章目錄
1、縮進
2、命名約定
3、Python之禪

PEP8是Python的官方文檔中提供的代碼規范,結合這套規范,我順便整理了一下自己的寫代碼習慣。

點這里查看PEP8官方原文,本文只節選了我自己比較看重的一些規范,僅供參考。


1、縮進

強制縮進的規定,讓代碼看上去很整齊,強迫癥表示很喜歡。

第一種情況:代碼塊的分割

Python使用一個冒號和縮進,來分割代碼塊,代碼塊指的是類的定義、函數的定義、流程控制中if、for、while模塊。縮進表示一個代碼塊的開始,非縮進表示一個代碼的結束,相同的縮進表示在代碼塊中處于相同的級別。

每一級縮進使用一個tab鍵(四個空格)。實際上一個空格就可以,但是一個空格看起來不那么明顯,所以用一個tab更方便、清楚。

例如下面,就是2個代碼塊(兩個代碼塊之間建議空一行)。

# 一個冒號加換行縮進,開啟一個代碼塊,直到下面一行不縮進了,說明下面一行已經不在這個代碼塊里了
if a>b:
    print(a)

def print_name(var):
    print(var)
    print('haha')   

第二種情況:換行

有時候寫一行代碼,特別特別長的時候,就需要換行。文檔建議續行與其包裹元素對齊,譬如用括號來垂直對齊,如下。

# 換行后的括號里內容,不超過上一行的括號
foo = long_function_name(var_one, var_two,
                         var_three, var_four)


2、命名約定

變量名可以是字母、數字、下劃線的組合,不能以數字開頭,也不可以用關鍵字來命名哦!

關鍵字,就是有特殊意義的字符:

import keyword
print(keyword.kwlist)
['False', 'None', 'True', 'and', 'as', 'assert', 'break', \
 'class', 'continue', 'def', 'del', 'elif', 'else', 'except',\
 'finally', 'for', 'from', 'global', 'if', 'import', 'in', \
 'is', 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise',\
 'return', 'try', 'while', 'with', 'yield']

除此之外,還有一些其他的規范:
1)Python 里面區分大小寫,類名一般使用首字母大寫;
2)慎用字母I(i的大寫)、l(L的小寫)、o、O,因為可能被人錯看成數字1和0;
3)命名應既簡短又具有描述性。例如,student_name比s_n好,name_length比length_of_persons_name好;
4)在運算符前后各保留一個空格,例如 n == 1;


3、Python之禪

Python 中內置了一個彩蛋,簡單明了地說明了 Python 的哲學,只要輸入 import this,然后按下回車就能看到原文,這里貼出中文翻譯版本:

Python之禪
by Tim Peters

優美勝于丑陋
明了勝于隱晦
簡潔勝于復雜
復雜勝于混亂
扁平勝于嵌套
寬松勝于緊湊
可讀性很重要
即便是特例,也不可違背這些規則
雖然現實往往不那么完美
但是不應該放過任何異常
除非你確定需要如此
如果存在多種可能,不要猜測
肯定有一種——通常也是唯一一種——最佳的解決方案
雖然這并不容易,因為你不是Python之父
動手比不動手要好
但不假思索就動手還不如不做
如果你的方案很難懂,那肯定不是一個好方案
如果你的方案很好懂,那肯定是一個好方案
命名空間非常有用,我們應當多加利用

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,428評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,024評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,285評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,548評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,328評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,878評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,971評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,098評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,616評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,554評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,725評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,243評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,971評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,361評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,613評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,339評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,695評論 2 370

推薦閱讀更多精彩內容