Python 風格規範

標籤：表達   through   第三方   包括   做什麼   元素   erro   occurred   pos   

分號不要在行尾加分號, 也不要用分號將兩條命令放在同一行.   行長度 每行不超過80 個字元例外: 如果使用Python 2.4 或更早的版本, 匯入模組的行可能多於80 個字元.Python 會將圓括弧, 中括弧和花括弧中的行隱式的串連起來, 你可以利用這個特點. 如果需要, 你可以在運算式外圍增加一對額外的圓括弧.Yes: foo_bar(self, width, height, color=‘black‘, design=None, x=‘foo‘,    emphasis=None, highlight=0)if (width == 0 and height == 0 and    color == ‘red‘ and emphasis == ‘strong‘):如果一個文本字串在一行放不下, 可以使用圓括弧來實現隱式行串連:x = (‘This will build a very long long ‘‘long long long long long long string‘)注意上面例子中的元素縮排; 你可以在本文的 縮排 部分找到解釋.   括弧 寧缺毋濫的使用括弧除非是用於實現行串連, 否則不要在返回語句或條件陳述式中使用括弧. 不過在元組兩邊使用括弧是可以的.Yes: if foo:    bar()  while x:    x = bar()  if x and y:    bar()  if not x:    bar()  return foofor (x, y) in dict.items(): ... No: if (x):    bar()  if not(x):    bar()  return (foo)  縮排 用 4 個空格來縮排代碼絕對不要用tab, 也不要tab 和空格混用. 對於行串連的情況, 你應該要麼垂直對齊換行的元素(見 行長度 部分的樣本), 或者使用4 空格的懸掛式縮排(這時第一行不應該有參數):Yes: # Aligned with opening delimiterfoo = long_function_name(var_one, var_two,var_three, var_four)# 4-space hanging indent; nothing on first linefoo = long_function_name(var_one, var_two, var_three,var_four)No: # Stuff on first line forbiddenfoo = long_function_name(var_one, var_two,var_three, var_four)# 2-space hanging indent forbiddenfoo = long_function_name(var_one, var_two, var_three,var_four)  空行 頂級定義之間空兩行, 方法定義之間空一行頂級定義之間空兩行, 比如函數或者類定義. 方法定義, 類定義與第一個方法之間, 都應該空一行. 函數或方法中, 某些地方要是你覺得合適, 就空一行.   空格 按照標準的排版規範來使用標點兩邊的空格1. 括弧內不要有空格.Yes: spam(ham[1], {eggs: 2}, [])No: spam( ham[ 1 ], { eggs: 2 }, [ ] ) 2. 不要在逗號, 分號, 冒號前面加空格, 但應該在它們後面加(除了在行尾).Yes: if x == 4:print x, yx, y = y, xNo: if x == 4 :print x , yx , y = y , x 3. 參數列表, 索引或切片的左括弧前不應加空格.Yes: spam(1)Yes: spam (1)Yes: dict[‘key‘] = list[index]No: dict [‘key‘] = list [index] 4. 在二元操作符兩邊都加上一個空格, 比如賦值(=), 比較(==, <, >, !=, <>, <=, >=, in, notin, is, is not), 布爾(and, or, not). 至於算術操作符兩邊的空格該如何使用, 需要你自己好好判斷. 不過兩側務必要保持一致.Yes: x == 1No: x<1 5. 當’=’用於指示關鍵字參數或預設參數值時, 不要在其兩側使用空格.Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)No: def complex(real, imag = 0.0): return magic(r = real, i = imag) 6. 不要用空格來垂直對齊多行間的標記, 因為這會成為維護的負擔(適用於:, #, =等):Yes:foo = 1000 # commentlong_name = 2 # comment that should not be aligneddictionary = {"foo": 1,"long_name": 2,}No:foo = 1000 # commentlong_name = 2 # comment that should not be aligneddictionary = {"foo" : 1,"long_name": 2,}   Python 解譯器 每個模組都應該以#!/usr/bin/env python開頭模組應該以一個構造行開始, 以指定執行這個程式用到的Python 解譯器:#!/usr/bin/env python2.4總是使用最特化的版本, 例如, 使用/usr/bin/python2.4, 而不是 /usr/bin/python2. 這樣,當升級到不同的Python 版本時, 能輕鬆找到依賴關係, 同時也避免了使用時的迷惑. 例如,/usr/bin/python2 是表示/usr/bin/python2.0.1 還是/usr/bin/python2.3.0?   注釋確保對模組, 函數, 方法和行內注釋使用正確的風格  文檔字串Python 有一種獨一無二的的注釋方式: 使用文檔字串. 文檔字串是包, 模組, 類或函數裡的第一個語句. 這些字串可以通過對象的__doc__成員被自動提取, 並且被pydoc 所用. (你可以在你的模組上運行pydoc 試一把, 看看它長什麼樣). 我們對文檔字串的慣例是使用三重雙引號. 一個文檔字串應該這樣組織: 首先是一行以句號, 問號或驚歎號結尾的概述. 接著是一個空行. 接著是文檔字串剩下的部分, 它應該與文檔字串的第一行的第一個引號對齊. 下面有更多文檔字串的格式化規範.  模組每個檔案應該包含下列項, 依次是:1. 著作權聲明(例如, Copyright 2008 Google Inc.)72. 一個許可樣板. 根據項目使用的許可(例如, Apache 2.0, BSD, LGPL, GPL), 選擇合適的樣板3. 作者聲明, 標識檔案的原作者.  函數和方法如果不是既顯然又簡短, 任何函數或方法都需要一個文檔字串. 而且, 任何外部可訪問的函數或方法, 不管多短多簡單, 都需要文檔字串. 文檔字串應該包含函數做什麼, 以及輸入和輸出的詳細描述. 通常, 不應該描述”怎麼做”, 除非是一些複雜的演算法. 對於技巧性的代碼, 塊注釋或者行內注釋是最重要的. 文檔字串應該提供足夠的資訊, 當別人編寫代碼調用該函數時, 他不需要看一行代碼, 只要看文檔字串就可以了. 應該給參數單獨寫文檔. 在冒號後跟上解釋, 而且應該用統一的懸掛式2 或4空格縮排. 文檔字串應該在需要特定類型的地方指定期望的類型. “Raise:”部分應該列出該函數可能觸發的所有異常. 產生器函數的文檔字串應該用”Yields:”而非”Returns:”.def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):"""Fetches rows from a Bigtable.Retrieves rows pertaining to the given keys from the Table instancerepresented by big_table. Silly things may happen ifother_silly_variable is not None.Args:big_table: An open Bigtable Table instance.keys: A sequence of strings representing the key of each table rowto fetch.other_silly_variable: Another optional variable, that has a muchlonger name than the other args, and which does nothing.Returns:A dict mapping keys to the corresponding table row datafetched. Each row is represented as a tuple of strings. Forexample:{‘Serak‘: (‘Rigel VII‘, ‘Preparer‘),‘Zim‘: (‘Irk‘, ‘Invader‘),‘Lrrr‘: (‘Omicron Persei 8‘, ‘Emperor‘)}If a key from the keys argument is missing from the dictionary,then that row was not found in the table.Raises:IOError: An error occurred accessing the bigtable.Table object."""pass  類? 類應該在其定義下有一個用於描述該類的文檔字串. 如果你的類有公用屬性(Attributes), 那麼文檔中應該有一個屬性(Attributes)段. 並且應該遵守和函數參數相同的格式.class SampleClass(object):"""Summary of class here.Longer class information....Longer class information....Attributes:likes_spam: A boolean indicating if we like SPAM or not.eggs: An integer count of the eggs we have laid."""def __init__(self, likes_spam=False):"""Inits SampleClass with blah."""self.likes_spam = likes_spamself.eggs = 0def public_method(self):"""Performs operation blah."""  塊注釋和行注釋? 最需要寫注釋的是代碼中那些技巧性的部分. 如果你在下次代碼走查的時候必須解釋一下, 那麼你應該現在就給它寫注釋. 對於複雜的操作, 應該在其操作開始前寫上若干行注釋. 對於不是一目瞭然的代碼, 應在其行尾添加註釋.# We use a weighted dictionary search to find out where i is in# the array. We extrapolate position based on the largest num# in the array and the array size and then do binary search to# get the exact number.if i & (i-1) == 0: # true iff i is a power of 2為了提高可讀性, 注釋應該至少離開代碼2 個空格.另一方面, 絕不要描述代碼. 假設閱讀代碼的人比你更懂Python, 他只是不知道你的代碼要做什麼.# BAD COMMENT: Now go through the b array and make sure whenever i occurs# the next element is i+1  類? 如果一個類不繼承自其它類, 就顯式的從object 繼承. 嵌套類也一樣.No: class SampleClass:passclass OuterClass:class InnerClass:passYes: class SampleClass(object):passclass OuterClass(object):class InnerClass(object):passclass ChildClass(ParentClass):"""Explicitly inherits from another class already."""繼承自 object 是為了使屬性(properties)正常工作, 並且這樣可以保護你的代碼, 使其不受Python 3000 的一個特殊的潛在不相容性影響. 這樣做也定義了一些特殊的方法, 這些方法實現了對象的預設語義, 包括 __new__, __init__, __delattr__, __getattribute__,__setattr__, __hash__, __repr__, and __str__ .  字串? 用%操作符格式化字串, 即使參數都是字串. 不過也不能一概而論, 你需要在+和%之間好好判定.No: x = ‘%s%s‘ % (a, b) # use + in this casex = imperative + ‘, ‘ + expletive + ‘!‘x = ‘name: ‘ + name + ‘; score: ‘ + str(n)Yes: x = a + bx = ‘%s, %s!‘ % (imperative, expletive)x = ‘name: %s; score: %d‘ % (name, n) 避免在迴圈中用+和+=操作符來累加字串. 由於字串是不可變的, 這樣做會建立不必要的臨時對象, 並且導致二次方而不是線性已耗用時間. 作為替代方案, 你可以將每個子串加入列表, 然後在迴圈結束後用 .join 串連列表. (也可以將每個子串寫入一個cStringIO.StringIO 緩衝中.)No: employee_table = ‘<table>‘for last_name, first_name in employee_list:employee_table += ‘<tr><td>%s, %s</td></tr>‘ % (last_name, first_name)employee_table += ‘</table>‘Yes: items = [‘<table>‘]for last_name, first_name in employee_list:items.append(‘<tr><td>%s, %s</td></tr>‘ % (last_name, first_name))items.append(‘</table>‘)employee_table = ‘‘.join(items)為多行字串使用三重雙引號而非三重單引號. 不過要注意, 通常用隱式行串連更清晰, 因為多行字串與程式其他部分的縮排方式不一致.No:print """This is pretty ugly.Don‘t do this."""Yes:print ("This is much nicer.\n""Do it this way.\n")  TODO 注釋? 為臨時代碼使用TODO 注釋, 它是一種短期解決方案. 不算完美, 但夠好了.TODO 注釋應該在所有開頭處包含”TODO”字串, 緊跟著是用括弧括起來的你的名字,email 地址或其它標識符. 然後是一個可選的冒號. 接著必須有一行注釋, 解釋要做什麼. 主要目的是為了有一個統一的TODO 格式, 這樣添加註釋的人就可以搜尋到(並可以按需提供更多細節). 寫了TODO 注釋並不保證寫的人會親自解決問題.# TODO([email protected]): Drop the use of "has_key".# TODO(Zeke) change this to use relations.如果你的TODO 是”將來做某事”的形式, 那麼請確保你包含了一個指定的日期(“2009 年11 月解決”)或者一個特定的事件(“等到所有的客戶都可以處理XML 請求就移除這些代碼”).  匯入格式? 每個匯入應該獨佔一行Yes: import osimport sysNo: import os, sys匯入總應該放在檔案頂部, 位於模組注釋和文檔字串之後, 模組全域變數和常量之前. 匯入應該按照從最通用到最不通用的順序分組:1. 標準庫匯入2. 第三方庫匯入3. 應用程式指定匯入每種分組中, 應該根據每個模組的完整包路徑按字典序排序, 忽略大小寫.import foofrom foo import barfrom foo.bar import bazfrom foo.bar import Quuxfrom Foob import ar  語句? 通常每個語句應該獨佔一行不過, 如果測試結果與測試語句在一行放得下, 你也可以將它們放在同一行. 如果是if 語句,只有在沒有else 時才能這樣做. 特別地, 絕不要對 try/except 這樣做, 因為try 和except不能放在同一行.Yes:if foo: bar(foo)No:if foo: bar(foo)else: baz(foo)try: bar(foo)except ValueError: baz(foo)12try:bar(foo)except ValueError: baz(foo)   存取控制? 在 Python 中, 對於瑣碎又不太重要的訪問函數, 你應該直接使用公有變數來取代它們,這樣可以避免額外的函數調用開銷. 當添加更多功能時, 你可以用屬性(property)來保持文法的一致性.(譯者注: 重視封裝的物件導向程式員看到這個可能會很反感, 因為他們一直被教育: 所有成員變數都必須是私人的! 其實, 那真的是有點麻煩啊. 試著去接受Pythonic 哲學吧)另一方面, 如果訪問更複雜, 或者變數的訪問開銷很顯著, 那麼你應該使用像 get_foo() 和set_foo() 這樣的函數調用. 如果之前的程式碼為允許通過屬性(property)訪問 , 那麼就不要將新的訪問函數與屬性綁定. 這樣, 任何試圖通過老方法訪問變數的代碼就沒法運行, 使用者也就會意識到複雜性發生了變化.   命名module_name, package_name,ClassName, method_name, ExceptionName, function_name,GLOBAL_VAR_NAME,instance_var_name, function_parameter_name, local_var_name.應該避免的名稱1. 單字母名稱, 除了計數器和迭代器.2. 包/模組名中的連字號(-)3. 雙底線開頭並結尾的名稱(Python 保留, 例如__init__)命名規範1. 所謂”內部(Internal)”表示僅模組內可用, 或者, 在類內是保護或私人的.2. 用單底線(_)開頭表示模組變數或函數是protected 的(使用import * from時不會包含).3. 用雙底線(__)開頭的執行個體變數或方法表示類內私人.4. 將相關的類和頂級函數放在同一個模組裡. 不像Java, 沒必要限制一個類一個模組.5. 對類名使用大寫字母開頭的單詞(如CapWords, 即Pascal 風格), 但是模組名應該用小寫加底線的方式(如lower_with_under.py). 儘管已經有很多13現存的模組使用類似於CapWords.py 這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模組名碰巧和類名一致, 這會讓人困擾.Python 之父Guido 推薦的規範Type Public InternalModules lower_with_under _lower_with_underPackages lower_with_underClasses CapWords _CapWordsExceptions CapWordsFunctions lower_with_under() _lower_with_under()Global/ClassConstantsCAPS_WITH_UNDER _CAPS_WITH_UNDERGlobal/ClassVariableslower_with_under _lower_with_underInstance 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/MethodParameterslower_with_underLocal Variables lower_with_underMain? 即使是一個打算被用作指令碼的檔案, 也應該是可匯入的. 並且簡單的匯入不應該導致這個指令碼的主功能(main functionality)被執行, 這是一種副作用. 主功能應該放在一個main()函數中.在Python 中, pychecker, pydoc 以及單元測試要求模組必須是可匯入的. 你的代碼應該在執行主程式前總是檢查 if __name__ == ‘__main__‘ , 這樣當模組被匯入時主程式就不會被執行.def main():...if __name__ == ‘__main__‘:main()  所有的頂級代碼在模組匯入時都會被執行. 要小心不要去調用函數, 建立對象, 或者執行那些不應該在使用pychecker 或pydoc 時執行的操作.  

Python 風格規範