好的代碼風格,給人舒服的感覺,今天介紹一下谷歌的Python風格規範 1 分號 不要在行尾加分號, 也不要用分號將兩條命令放在同一行。 2 行長度 每行不超過80個字元;不要使用反斜杠連接行。Python會將圓括弧、中括弧和花括弧的行隱式的連接起來,可以利用這個特點。如果需要,可以在表達式外圍增加一 ...
好的代碼風格,給人舒服的感覺,今天介紹一下谷歌的Python風格規範
1 分號
不要在行尾加分號, 也不要用分號將兩條命令放在同一行。
2 行長度
每行不超過80個字元;不要使用反斜杠連接行。Python會將圓括弧、中括弧和花括弧的行隱式的連接起來,可以利用這個特點。如果需要,可以在表達式外圍增加一堆額外的圓括弧。
3 括弧
寧缺毋濫得使用括弧。除非是用於實現行連接,否則不要在返回語句或條件語句中使用括弧。不過在元組兩遍使用括弧是可以的。
4 縮進
用四個空格來縮進代碼。絕對不要用tab,也不要tab和空格混用。對於行連接的情況,應該垂直對其換行的元素,或者使用4空格的懸掛式縮進:
5 空行
頂級定義(比如函數或者類定義)之間空兩行,方法定義之間空一行。
6 空格
按照標準的排版規範來使用標點兩邊的空格。
括弧內不要有空格。
不要在逗號,分號,冒號前面加空格,但應該在它們後面加(除了在行尾)。
參數列表, 索引或切片的左括弧前不應加空格。
在二元操作符兩邊都加上一個空格, 比如賦值(=), 比較(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布爾(and, or, not)。至於算術操作符兩邊的空格該如何使用, 需要你自己好好判斷。不過兩側務必要保持一致。
當’=’用於指示關鍵字參數或預設參數值時, 不要在其兩側使用空格。
不要用空格來垂直對齊多行間的標記, 因為這會成為維護的負擔(適用於:, #, =等):
7 Shebang
大部分.py文件不必以#!作為文件的開始. 根據 PEP-394, 程式的main文件應該以 #!/usr/bin/python2或者 #!/usr/bin/python3開始。在電腦科學中,Shebang(也稱為 Hashbang )是一個由井號和嘆號構成的字元序列 #! ,其出現在文本文件的第一行的前兩個字元。在文件中存在 Shebang 的情況下,類 Unix 操作系統的程式載入器會分析 Shebang 後的內容,將這些內容作為解釋器指令,並調用該指令,並將載有 Shebang 的文件路徑作為該解釋器的參數。
8 註釋
確保對模塊, 函數, 方法和行內註釋使用正確的風格。
文檔字元串
Python有一種獨一無二的的註釋方式:使用文檔字元串。文檔字元串是包, 模塊, 類或函數里的第一個語句。這些字元串可以通過對象的doc成員被自動提取,並且被pydoc所用。我們對文檔字元串的慣例是使用三重雙引號。一個文檔字元串應該這樣組織:首先是一行以句號、問號或驚嘆號結尾的概述(或者該文檔字元串單純只有一行)、 接著是一個空行, 接著是文檔字元串剩下的部分,它應該與文檔字元串的第一行的第一個引號對齊。下麵有更多文檔字元串的格式化規範。
模塊
每個文件應該包含一個許可樣板。根據項目使用的許可(例如:Apache 2.0,,BSD,LGPL, GPL), 選擇合適的樣板。
函數和方法
一個函數必須要有文檔字元串, 除非它滿足以下條件:
文檔字元串應該包含函數做什麼,以及輸入和輸出的詳細描述。通常, 不應該描述”怎麼做”,除非是一些複雜的演算法。文檔字元串應該提供足夠的信息, 當別人編寫代碼調用該函數時,他不需要看一行代碼,只要看文檔字元串就可以了。對於複雜的代碼, 在代碼旁邊加註釋會比使用文檔字元串更有意義。
類
類應該在其定義下有一個用於描述該類的文檔字元串。如果你的類有公共屬性(Attributes),那麼文檔中應該有一個屬性(Attributes)段。並且應該遵守和函數參數相同的格式。
塊註釋和行註釋
最需要寫註釋的是代碼中那些技巧性的部分。如果你在下次 代碼審查的時候必須解釋一下,那麼你應該現在就給它寫註釋。對於複雜的操作, 應該在其操作開始前寫上若幹行註釋。對於不是一目瞭然的代碼,應在其行尾添加註釋。
9 類
如果一個類不繼承自其它類, 就顯式的從object繼承. 嵌套類也一樣。繼承自 object 是為了使屬性(properties)正常工作, 並且這樣可以保護你的代碼, 使其不受 PEP-3000的一個特殊的潛在不相容性影響。這樣做也定義了一些特殊的方法, 這些方法實現了對象的預設語義, 包括 __new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__ 。