注釋 - python入門之編碼風(fēng)格規(guī)范分享

另一方面, 絕不要描述代碼. 假設(shè)閱讀代碼的人比你更懂Python, 他只是不知道你的代碼要做什么.

# BAD COMMENT: Now go through the b array and make sure whenever i occurs# the next element is i+1類

如果一個類不繼承自其它類, 就顯式的從object繼承. 嵌套類也一樣.

Yes:classSampleClass(object):passclassOuterClass(object):classInnerClass(object):passclassChildClass(ParentClass):"""Explicitly inherits from another class already."""No:classSampleClass:passclassOuterClass:classInnerClass:pass

繼承自?object?是為了使屬性(properties)正常工作, 并且這樣可以保護(hù)你的代碼, 使其不受Python 3000的一個特殊的潛在不兼容性影響. 這樣做也定義了一些特殊的方法, 這些方法實現(xiàn)了對象的默認(rèn)語義, 包括?__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__?.

字符串Yes:x=a+b x='%s, %s!'%(imperative,expletive)x='{}, {}!'.format(imperative,expletive)x='name: %s; score: %d'%(name,n)x='name: {}; score: {}'.format(name,n)No:x='%s%s'%(a,b)# use + in this casex='{}{}'.format(a,b)# use + in this casex=imperative+', '+expletive+'!'x='name: '+name+'; score: '+str(n)

避免在循環(huán)中用+和+=操作符來累加字符串. 由于字符串是不可變的, 這樣做會創(chuàng)建不必要的臨時對象, 并且導(dǎo)致二次方而不是線性的運行時間. 作為替代方案, 你可以將每個子串加入列表, 然后在循環(huán)結(jié)束后用?.join?連接列表. (也可以將每個子串寫入一個?cStringIO.StringIO?緩存中.)

Yes:items=['']forlast_name,first_nameinemployee_list:items.append(''%(last_name,first_name))items.append('

在同一個文件中, 保持使用字符串引號的一致性. 使用單引號'或者雙引號"之一用以引用字符串, 并在同一文件中沿用. 在字符串內(nèi)可以使用另外一種引號, 以避免在字符串中使用. PyLint已經(jīng)加入了這一檢查.

Yes:Python('Why are you hiding your eyes?')Gollum("I'm scared of lint errors.")Narrator('"Good!" thought a happy Python reviewer.')No:Python("Why are you hiding your eyes?")Gollum('The lint. It burns. It burns us.')Gollum("Always the great lint. Watching. Watching.")

為多行字符串使用三重雙引號"""而非三重單引號'''. 當(dāng)且僅當(dāng)項目中使用單引號'來引用字符串時, 才可能會使用三重'''為非文檔字符串的多行字符串來標(biāo)識引用. 文檔字符串必須使用三重雙引號""". 不過要注意, 通常用隱式行連接更清晰, 因為多行字符串與程序其他部分的縮進(jìn)方式不一致.

Yes:print("This is much nicer.\n""Do it this way.\n")No:print"""This is pretty ugly. Don't do this. """文件和sockets

在文件和sockets結(jié)束時, 顯式的關(guān)閉它.

除文件外, sockets或其他類似文件的對象在沒有必要的情況下打開, 會有許多副作用, 例如:

它們可能會消耗有限的系統(tǒng)資源, 如文件描述符. 如果這些資源在使用后沒有及時歸還系統(tǒng), 那么用于處理這些對象的代碼會將資源消耗殆盡.

持有文件將會阻止對于文件的其他諸如移動、刪除之類的操作.

僅僅是從邏輯上關(guān)閉文件和sockets, 那么它們?nèi)匀豢赡軙黄涔蚕淼某绦蛟跓o意中進(jìn)行讀或者寫操作. 只有當(dāng)它們真正被關(guān)閉后, 對于它們嘗試進(jìn)行讀或者寫操作將會跑出異常, 并使得問題快速顯現(xiàn)出來.

而且, 幻想當(dāng)文件對象析構(gòu)時, 文件和sockets會自動關(guān)閉, 試圖將文件對象的生命周期和文件的狀態(tài)綁定在一起的想法, 都是不現(xiàn)實的. 因為有如下原因:

沒有任何方法可以確保運行環(huán)境會真正的執(zhí)行文件的析構(gòu). 不同的Python實現(xiàn)采用不同的內(nèi)存管理技術(shù), 比如延時垃圾處理機制. 延時垃圾處理機制可能會導(dǎo)致對象生命周期被任意無限制的延長.

對于文件意外的引用,會導(dǎo)致對于文件的持有時間超出預(yù)期(比如對于異常的跟蹤, 包含有全局變量等).

推薦使用??以管理文件:

withopen("hello.txt")ashello_file:forlineinhello_file:printline

對于不支持使用"with"語句的類似文件的對象,使用 contextlib.closing():

importcontextlibwithcontextlib.closing(urllib.urlopen(""))asfront_page:forlineinfront_page:printline

Legacy AppEngine 中Python 2.5的代碼如使用"with"語句, 需要添加 "from __future__ import with_statement".

TODO注釋

為臨時代碼使用TODO注釋, 它是一種短期解決方案. 不算完美, 但夠好了.

TODO注釋應(yīng)該在所有開頭處包含"TODO"字符串, 緊跟著是用括號括起來的你的名字, email地址或其它標(biāo)識符. 然后是一個可選的冒號. 接著必須有一行注釋, 解釋要做什么. 主要目的是為了有一個統(tǒng)一的TODO格式, 這樣添加注釋的人就可以搜索到(并可以按需提供更多細(xì)節(jié)). 寫了TODO注釋并不保證寫的人會親自解決問題. 當(dāng)你寫了一個TODO, 請注上你的名字.

# TODO(kl@gmail.com): Use a "*" here for string repetition.# TODO(Zeke) Change this to use relations.