概要
文件和sockets，todo注釋，導(dǎo)入格式，語句，訪問控制，命名，Main
內(nèi)容
文件和sockets
在文件和sockets結(jié)束時候，顯示的關(guān)閉它 除了文件之外，sockets或其他類似文件的對象在沒有必要的情況下打開，會有很多副作用： １可能會消耗有限的系統(tǒng)資源，如文件描述符，如果這些資源在使用后沒有及時歸還系統(tǒng)，用于處理這些對象的代碼會將資源消耗殆盡 ２持有文件將會阻止文件的其他操作，比如移動刪除之類 ３僅僅從邏輯上關(guān)閉文件和sockets，它們?nèi)匀豢赡軙还蚕淼某绦蜻M行讀寫操作 幻想當(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ù)期(比如對于異常的跟蹤, 包含有全局變量等).
使用with語句管理文件：
with open("hello.txt") as hello_file:
for line in hello_file:
print line
對于不支持with語句的類似文件的對象，使用contextlib.closing():
import contextlib
with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:
for line in front_page:
print line
TODO注釋
為臨時代碼使用todo注釋，是一種短期解決方案 TODO注釋應(yīng)該在所有開頭處包含”TODO”字符串, 緊跟著是用括號括起來的你的名字, email地址或其它標(biāo)識符. 然后是一個可選的冒號. 接著必須有一行注釋, 解釋要做什么. 主要目的是為了有一個統(tǒng)一的TODO格式, 這樣添加注釋的人就可以搜索到(并可以按需提供更多細節(jié)). 寫了TODO注釋并不保證寫的人會親自解決問題. 當(dāng)你寫了一個TODO, 請注上你的名字. 如果你的TODO是”將來做某事”的形式, 那么請確保你包含了一個指定的日期(“2009年11月解決”)或者一個特定的事件(“等到所有的客戶都可以處理XML請求就移除這些代碼”).
# TODO(kl@gmail.com): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.
導(dǎo)入格式
每個導(dǎo)入應(yīng)該獨占一行 導(dǎo)入總應(yīng)該放在文件頂部, 位于模塊注釋和文檔字符串之后, 模塊全局變量和常量之前. 導(dǎo)入應(yīng)該按照從最通用到最不通用的順序分組: 1標(biāo)準(zhǔn)庫導(dǎo)入 2第三方庫導(dǎo)入 3應(yīng)用程序指定導(dǎo)入 每種分組中, 應(yīng)該根據(jù)每個模塊的完整包路徑按字典序排序, 忽略大小寫
語句
通常每個語句應(yīng)該獨占一行 不過, 如果測試結(jié)果與測試語句在一行放得下, 你也可以將它們放在同一行 如果是if語句, 只有在沒有else時才能這樣做. 特別地, 絕不要對 try/except這樣做, 因為try和except不能放在同一行.
訪問控制
在python中，對于瑣碎的不太重要的訪問函數(shù)，使用公有變量來取代它們 這樣可以避免額外的函數(shù)調(diào)用開銷， 當(dāng)增加更多功能時候，可以用屬性property來保持語法的一致性 另一方面，如果訪問更復(fù)雜，或者變量的訪問開銷很顯著．那么你應(yīng)該使用像 get_foo()和set_foo()這樣的函數(shù)調(diào)用，如果之前的代碼行為允許通過屬性訪問，那么 就不要將新的訪問函數(shù)和屬性綁定，這樣，任何試圖通過老方法訪問變量的代碼就沒法運行，使用者也就意識到復(fù)雜性發(fā)生了變化
命名
module_name package_name ClassName method_name ExceptionName
function_name GLOBAL_VAR_NAME instance_var_name
function_parameter_name local_var_name
應(yīng)該避免的名稱 單字符名稱，除了計數(shù)器和迭代器 包／模塊名中的連字符－ 雙下劃線開頭并結(jié)尾的名稱（python保留，例如__init__）
命名約定： １所謂內(nèi)部internal表示僅模塊內(nèi)可用，或者，在類內(nèi)是保護或者私有的 2 用單下劃線開頭表示模塊變量或函數(shù)是protected的（使用import * from 時候不會包含） ３用下劃線__開頭的實例變量或方法表示類內(nèi)私有 ４將相關(guān)的類和頂級函數(shù)放在同一個模塊中 ５對類名使用大寫字母開頭的單詞 模塊名應(yīng)該用小寫加下劃線的方式，
python之父Guido推薦的規(guī)范
| Type | Public | Internal |
|---|---|---|
| Modules | lower_with_under | _lower_with_under |
| Packages | lower_with_under | |
| Classes | CapWords | _CapWords |
| Exceptions | CapWords | |
| Functions | lower_with_under() | _lower_with_under() |
| Global/Class Constants | CAPS_WITH_UNDER | _CAPS_WITH_UNDER |
| Global/Class Variables | lower_with_under | _lower_with_under |
| Instance Variables | lower_with_under | _lower_with_under (protected) or __lower_with_under (private) |
| Method Names | lower_with_under() | _lower_with_under() (protected) or __lower_with_under() (private) |
| Function/Method Parameters/Class Variables | lower_with_under | |
| Local Variables | lower_with_under |
Main
即使是一個打算被當(dāng)作腳本的文件，也應(yīng)該是可以導(dǎo)入的，并且簡單的導(dǎo)入不應(yīng)該導(dǎo)致這個腳本的主功能main functionality被執(zhí)行，這是一種副作用，主功能應(yīng)該放在一個main()函數(shù)中 在Python中, pydoc以及單元測試要求模塊必須是可導(dǎo)入的. 你的代碼應(yīng)該在執(zhí)行主程序前總是檢查if __name__ == '__main__', 這樣當(dāng)模塊被導(dǎo)入時主程序就不會被執(zhí)行. 所有的頂級代碼在模塊導(dǎo)入時都會被執(zhí)行. 要小心不要去調(diào)用函數(shù), 創(chuàng)建對象, 或者執(zhí)行那些不應(yīng)該在使用pydoc時執(zhí)行的操作.
