Python開發編碼規范

2020-02-23 04:39:10

字體：大中小

來源：轉載

供稿：網友

這篇文檔所給出的編碼約定適用于在主要的Python發布版本中組成標準庫的Python   代碼，請查閱相關的關于在Python的C實現中C代碼風格指南的描述。
這篇文檔改編自Guido最初的《Python風格指南》一文，并從《Barry's style guide》中添加了部分內容。在有沖突的地方，Guide的風格規則應該是符合本PEP的意圖(譯注：指當有沖突時，應以Guido風格為準)。這篇PEP仍然尚未完成(實際上，它可能永遠都不會完成)。
  在這篇風格指導中的一致性是重要的。在一個項目內的一致性更重要。在一個模塊或函數內的一致性最重要。但最重要的是：知道何時會不一致——有時只是沒有實施風格指導。當出現疑惑時，運用你的最佳判斷，看看別的例子，然后決定怎樣看起來更好。并且要不恥下問！
  打破一條既定規則的兩個好理由：
(1)     當應用這個規則是將導致代碼可讀性下降，即便對某人來說，他已經習慣于按這條規則來閱讀代碼了。
(2)     為了和周圍的代碼保持一致而打破規則(也許是歷史原因)，雖然這也是個清除其它混亂的好機會(真正的XP風格)。

代碼的布局
  縮進
使用Emacs的Python-mode的默認值：4個空格一個縮進層次。對于確實古老的代碼，你不希望產生混亂，可以繼續使用8空格的制表符(8-space tabs)。Emacs Python-mode自動發現文件中主要的縮進層次，依此設定縮進參數。

制表符還是空格
  永遠不要混用制表符和空格。最流行的Python縮進方式是僅使用空格，其次是僅使用制表符，混合著制表符和空格縮進的代碼將被轉換成僅使用空格。(在Emacs中，選中整個緩沖區，按ESC-x去除制表符。)調用Python命令行解釋器時使用-t選項，可對代碼中不合法得混合制表符和空格發出警告，使用-tt時警告將變成錯誤。這些選項是被高度推薦的。
  對于新的項目，強烈推薦僅使用空格而不是制表符。許多編輯器擁有使之易于實現的功能(在Emacs中，確認indent-tabs-mode是nil)。

行的最大長度
  周圍仍然有許多設備被限制在每行80字符：而且，窗口限制在80個字符。使將多個窗口并排放置成為可能。在這些設備上使用默認的折疊方式看起來有點丑陋。因此，請將所有行限制在最大79字符(Emacs準確得將行限制為長80字符)，對順序排放的大塊文本(文檔字符串或注釋)，推薦將長度限制在72字符。
  折疊長行的首選方法是使用Pyhon支持的圓括號，方括號和花括號內的行延續。如果需要，你可以在表達式周圍增加一對額外的圓括號，但是有時使用反斜杠看起來更好，確認恰當得縮進了延續的行。

上一篇：Python isinstance判斷對象類型

下一篇：python編程-將Python程序轉化為可執行程序[整理]