python 代碼風格

指導原則

命名: 清晰易懂熙涤,代碼風格要一致

函數(shù): 函數(shù)是抽象的主要機制屑宠,最好一個函數(shù)只做一件事。便于組合 復用绳锅。

目的: 每一行代碼應該有一個明確的目的西饵,減少冗余的代碼。

簡潔: 代碼應該是簡潔明了的鳞芙。

變量命名

Good

goal, score, opp_score = 1 00, 0, 0
greeting = ' hello world'
is_even = lambda x: x % 2

Bad

a, b, m = 1 00, 0, 0
thing = ' hello world'
stuff = lambda x: x % 2

注意字母和數(shù)字

當很明確一個字母是做什么的時候眷柔,使用縮寫的可以的。

Good

i = 0 # a counter for a loop
x, y = 0, 0 # x and y coordinates
p, q = 5, 1 7 # mathematical names in the context of the question
一般來說 i , j , k是循環(huán)中最常用的原朝。

Bad

o = O + 4 # letter ' O' or number 0?
l = l + 5 # letter ' l' or number 1 ?
用 o 和 l 很容易使 o 和 0 驯嘱,l 和1搞混

不必要的變量

Good

return answer(argument)

Bad

result = answer(argument)
return result

如果是表達式太長,或者返回的這個結果不是清晰明了的應該
創(chuàng)建一個變量竿拆。

Good

divisible_49 = lambda x: x % 49 == 0
score = (total + 1 ) // 7
do_something(divisible_49, score)

Bad

do_something(lambda x: x % 49 == 0, (total + 1 ) // 7)

命名約定

Good
total_score = 0
final_score = 1

def mean_strategy(score, opp):

class ExampleClass:

Bad
TotalScore = 0
finalScore = 1

def Mean_Strategy(score, opp):

class example_class:
    
# python 中一般變量和函數(shù)名使用下劃線宙拉,類名使用駝峰

使用空格代替tab,一般使用四個空格鍵丙笋。保存一行代碼不要過長谢澈,
大概在 70 個字符作用就好。

操作符之間的間隔

Good

x = a + b*c*(a**2) / c - 4
tup = (x, x/2, x/3, x/4)

Bad

x=a+b*c*(a**2)/c-4
tup = (x, x/2, x/3, x/4)

Good

def func(a, b, c, d, e, f,
        g, h, i):
    # body
    
tup = (1 , 2, 3, 4, 5,
        6, 7, 8)
        
names = (' alice' ,
        ' bob' ,
        ' eve' )

控制語句

Bad

if pred == True: # bad!
. . .
if pred == False: # bad!

Good

if pred: # good!
. . .
if not pred: # good!

python 中的 [] , () , {} , set() 都可以使用bool判斷

if lst: # if lst is not empty
. . .
if not tup: # if tup is empty

這里要注意的一點是如果要將一個元素默認為一個list御板,

這種做法會使得每次調用都增加一個元素在x中锥忿。

def demo(x=[]):
    pass

正確的做法是
    
def demo(x=None):
    if x is None:
        x = []

這里也不可以使用 not x,因為可能傳入的是一個空字符怠肋,
這種程序就會報錯敬鬓。

多余的if else

Bad

if pred: # bad!
    return True
else:
    return False
    
if num ! = 49:
    total += example(4, 5, True)
else:
    total += example(4, 5, False)
    
if pred: # bad!
    print(' stuff' )
    x += 1
    return x
else:
    x += 1
    return x

Good

return pred

total += example(4, 5, num!=49)

if pred: # good!
    print(' stuff' )
x += 1
return x

Good

把注釋寫到doc中,使用help函數(shù)可以看到

def average(fn, samples):
    " " " Calls a 0-argument function SAMPLES times, and takes
    the average of the outcome.
    " " "

不必要的注釋

Bad

def example(y):
    x += 1 # increments x by 1
    return square(x) # returns the square of x

重復笙各,使用一個變量保存钉答。

Bad
if a + b - 3 * h / 2 % 47 == 4:
total += a + b - 3 * h / 2 % 47
return total

Good

turn_score = a + b - 3 * h / 2 % 47
if turn_score == 4:
    total += turn_score
    return total

合理使用 生成式

Good

ex = [x*x for x in range(1 0)]
L = [pair[0] + pair[1 ]
    for pair in pairs
    if len(pair) == 2]

Bad

L = [x + y + z for x in nums if x > 1 0 for y in nums2 for z in nums3 if y > z]

博客 https://www.97up.cn/

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市杈抢,隨后出現(xiàn)的幾起案子数尿,更是在濱河造成了極大的恐慌,老刑警劉巖惶楼,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件右蹦,死亡現(xiàn)場離奇詭異,居然都是意外死亡歼捐,警方通過查閱死者的電腦和手機何陆,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來豹储,“玉大人贷盲,你說我怎么就攤上這事“郏” “怎么了晃洒?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵慨灭,是天一觀的道長。 經(jīng)常有香客問我球及,道長氧骤,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任吃引,我火速辦了婚禮筹陵,結果婚禮上,老公的妹妹穿的比我還像新娘镊尺。我一直安慰自己朦佩,他們只是感情好,可當我...
    茶點故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布庐氮。 她就那樣靜靜地躺著语稠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪弄砍。 梳的紋絲不亂的頭發(fā)上仙畦,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天,我揣著相機與錄音音婶,去河邊找鬼慨畸。 笑死,一個胖子當著我的面吹牛衣式,可吹牛的內(nèi)容都是我干的寸士。 我是一名探鬼主播,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼碴卧,長吁一口氣:“原來是場噩夢啊……” “哼弱卡!你這毒婦竟也來了?” 一聲冷哼從身側響起住册,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤婶博,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后界弧,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡搭综,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年垢箕,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片兑巾。...
    茶點故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡条获,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出蒋歌,到底是詐尸還是另有隱情帅掘,我是刑警寧澤委煤,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站修档,受9級特大地震影響碧绞,放射性物質發(fā)生泄漏。R本人自食惡果不足惜吱窝,卻給世界環(huán)境...
    茶點故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一讥邻、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧院峡,春花似錦兴使、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至俩垃,卻和暖如春励幼,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背吆寨。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工赏淌, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人啄清。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓六水,卻偏偏與公主長得像,于是被迫代替她去往敵國和親辣卒。 傳聞我的和親對象是個殘疾皇子掷贾,可洞房花燭夜當晚...
    茶點故事閱讀 42,802評論 2 345

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

  • 更新時間:2016/5/13 介紹 本文檔所提供的編碼規(guī)范,適用于主要的Python發(fā)行版中組成標準庫的Pytho...
    超net閱讀 5,845評論 0 15
  • 通常代碼不單單是寫給自己看的荣茫。 當代碼出現(xiàn)bug而你又想不通哪有問題時想帅,就需要把代碼貼到論壇或請身邊的人審閱。 或...
    學習之術閱讀 835評論 0 2
  • 一python代碼規(guī)范 Python代碼風格規(guī)約:一個至關重要的建議是每級縮進使用4個空格啡莉,不要使用tab港准,因為t...
    一曲廣陵散閱讀 1,727評論 0 1
  • 參考自 《Google Python Style Guide》 和 Python最佳實踐 -- 董偉明 。 ...
    蔣狗閱讀 526評論 0 1
  • 開場白: 大家好咧欣,我是G159期2組的丁玉枝浅缸,來自浙江麗水。我的三個標簽:工程師魄咕,易效能時間管理踐行者衩椒,6歲孩子的...
    微瀾_12ca閱讀 220評論 0 0