简明 Python 编程规范v2
生活随笔
收集整理的這篇文章主要介紹了
简明 Python 编程规范v2
小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.
賴勇浩（http://laiyonghao.com）
注：之前發(fā)布一篇《簡明 Python 編程規(guī)范》（見：http://blog.csdn.net/lanphaday/article/details/2834883），本是我給當(dāng)時所在的公司制定的，發(fā)表到博客的時候，對齊等問題都有一些錯誤，還包括一些錯別字。到后來，我又有做過修正。大概在 2010 年 8 年，我又由 C++ 開發(fā)轉(zhuǎn)到 Python 開發(fā)，便在那之前的基礎(chǔ)上潤飾和完善，形成第二版。前段時間 simple-is-better.com 網(wǎng)站轉(zhuǎn)發(fā)了我寫的前一版本規(guī)范（見：http://simple-is-better.com/news/534），引起大家的討論，我一一解釋不來，所以今天抽點時間把 v2 編輯一下發(fā)布上來，求交流、指正。
以下是為規(guī)范全文：
Python編程規(guī)范v2
執(zhí)行
- ?本規(guī)范使用 pylint 及對應(yīng)的配置文件來進(jìn)行檢測，關(guān)于 pylint 的安裝和配置見：http://blog.csdn.net/lanphaday/article/details/6089902
編碼
- 所有的 Python 腳本文件都應(yīng)在文件頭標(biāo)上如下標(biāo)識或其兼容格式的標(biāo)識： [python]?view plain?copy
- #?-*-?coding:utf-8?-*-??
- 設(shè)置編輯器，默認(rèn)保存為 utf-8 格式。
注釋
- 業(yè)界普遍認(rèn)同 Python 的注釋分為兩種的概念，一種是由 # 開頭的“真正的”注釋，另一種是 docstrings。前者表明為何選擇當(dāng)前實現(xiàn)以及這種實現(xiàn)的原理和難點，后者表明如何使用這個包、模塊、類、函數(shù)（方法），甚至包括使用示例和單元測試。
- 堅持適當(dāng)注釋原則。對不存在技術(shù)難點的代碼堅持不注釋，對存在技術(shù)難點的代碼必須注釋。但與注釋不同，推薦對每一個包、模塊、類、函數(shù)（方法）寫 docstrings，除非代碼一目了然，非常簡單。
格式
縮進(jìn)
- Python 依賴縮進(jìn)來確定代碼塊的層次，行首空白符主要有兩種：tab 和空格，但嚴(yán)禁兩者混用。
- 公司內(nèi)部使用 2 個空格的 tab 進(jìn)行縮進(jìn)。
空格
- ?空格在 Python 代碼中是有意義的，因為 Python 的語法依賴于縮進(jìn)，在行首的空格稱為前導(dǎo)空格。在這一節(jié)不討論前導(dǎo)空格相關(guān)的內(nèi)容，只討論非前導(dǎo)空格。非前導(dǎo)空格在 Python 代碼中沒有意義，但適當(dāng)?shù)丶尤敕乔皩?dǎo)空格可以增進(jìn)代碼的可讀性。
- 在二元算術(shù)、邏輯運算符前后加空格，如： [python]?view plain?copy
- a?=?b?+?c??
- “:”用在行尾時前后皆不加空格，如分枝、循環(huán)、函數(shù)和類定義語言；用在非行尾時兩端加空格，如 dict 對象的定義： [python]?view plain?copy
- d?=?{'key'?:?'value'}??
- 括號（含圓括號、方括號和花括號）前后不加空格，如： [html]?view plain?copy
- do_something(arg1,?arg2)?? 而不是 [python]?view plain?copy
- do_something(?arg1,?arg2?)??
- 逗號后面加一個空格，前面不加空格；
空行
- 適當(dāng)?shù)目招杏欣谠黾哟a的可讀性，加空行可以參考如下幾個準(zhǔn)則：
- 在類、函數(shù)的定義間加空行；
- 在 import 不同種類的模塊間加空行；
- 在函數(shù)中的邏輯段落間加空行，即把相關(guān)的代碼緊湊寫在一起，作為一個邏輯段落，段落間以空行分隔；
斷行
- 盡管現(xiàn)在的寬屏顯示器已經(jīng)可以單屏顯示超過 256 列字符，但本規(guī)范仍然堅持行的最大長度不得超過 78 個字符的標(biāo)準(zhǔn)。折疊長行的方法有以下幾種方法：
- 為長變量名換一個短名，如：
- 在括號（包括圓括號、方括號和花括號）內(nèi)換行，如：
[python]?view plain?copy
[python]?view plain?copy
- 如果行長到連第一個括號內(nèi)的參數(shù)都放不下，則每個元素都單獨占一行：
- 在長行加入續(xù)行符強行斷行，斷行的位置應(yīng)在操作符前，且換行后多一個縮進(jìn)，以使維護(hù)人員看代碼的時候看到代碼行首即可判定這里存在換行，如：
[html]?view plain?copy
命名
- 一致的命名可以給開發(fā)人員減少許多麻煩，而恰如其分的命名則可以大幅提高代碼的可讀性，降低維護(hù)成本。
常量
- 常量名所有字母大寫，由下劃線連接各個單詞，如：
變量
- 變量名全部小寫，由下劃線連接各個單詞，如：
- 不論是類成員變量還是全局變量，均不使用 m 或 g 前綴。私有類成員使用單一下劃線前綴標(biāo)識，多定義公開成員，少定義私有成員。
- 變量名不應(yīng)帶有類型信息，因為 Python 是動態(tài)類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。
函數(shù)
- 函數(shù)名的命名規(guī)則與變量名相同。
類
- 類名單詞首字母大寫，不使用下劃線連接單詞，也不加入 C、T 等前綴。如：
模塊
- 模塊名全部小寫，對于包內(nèi)使用的模塊，可以加一個下劃線前綴，如：
包
- 包的命名規(guī)范與模塊相同。
縮寫
- 命名應(yīng)當(dāng)盡量使用全拼寫的單詞，縮寫的情況有如下兩種：
- 常用的縮寫，如 XML、ID等，在命名時也應(yīng)只大寫首字母，如：
- 命名中含有長單詞，對某個單詞進(jìn)行縮寫。這時應(yīng)使用約定成俗的縮寫方式，如去除元音、包含輔音的首字符等方式，例如：
- function 縮寫為 fn
- text 縮寫為 txt
- object 縮寫為 obj
- count 縮寫為 cnt
- number 縮寫為 num，等。
特定命名方式
- 主要是指 __xxx__ 形式的系統(tǒng)保留字命名法。項目中也可以使用這種命名，它的意義在于這種形式的變量是只讀的，這種形式的類成員函數(shù)盡量不要重載。如：
語句
import
- import 語句有以下幾個原則需要遵守：
- import 的次序，先 import Python 內(nèi)置模塊，再 import 第三方模塊，最后 import 自己開發(fā)的項目中的其它模塊；這幾種模塊中用空行分隔開來。
- 一條 import 語句 import 一個模塊。
- 當(dāng)從模塊中 import 多個對象且超過一行時，使用如下斷行法（此語法 py2.5 以上版本才支持）：
- 不要使用 from module import *，除非是 import 常量定義模塊或其它你確保不會出現(xiàn)命名空間沖突的模塊。
賦值
- 對于賦值語句，主要是不要做無謂的對齊，如：
[python]?view plain?copy
分枝和循環(huán)
- 對于分枝和循環(huán)，有如下幾點需要注意的：
- 不要寫成一行，如：
[python]?view plain?copy
[python]?view plain?copy
注：本文檔中出現(xiàn)寫成一行的例子是因為排版的原因，不得作為編碼中不斷行的依據(jù)。
- 條件表達(dá)式的編寫應(yīng)該足夠 pythonic，如以下形式的條件表達(dá)式是拙劣的：
[python]?view plain?copy
- 用得著的時候多使用循環(huán)語句的 else 分句，以簡化代碼。
已有代碼
- 對于項目中已有的代碼，可能因為歷史遺留原因不符合本規(guī)范，應(yīng)當(dāng)看作可以容忍的特例，允許存在；但不應(yīng)在新的代碼中延續(xù)舊的風(fēng)格。
- 對于第三方模塊，可能不符合本規(guī)范，也應(yīng)看作可以容忍的特例，允許存在；但不應(yīng)在新的代碼中使用第三方模塊的風(fēng)格。
- tab 與空格混用的縮進(jìn)是'''不可容忍'''的，在運行項目時應(yīng)使用 -t 或 -tt 選項排查這種可能性存在。出現(xiàn)混用的情況時，如果是公司開發(fā)的基礎(chǔ)類庫代碼，應(yīng)當(dāng)通知類庫維護(hù)人員修改；第三方模塊則可以通過提交 patch 等方式敦促開發(fā)者修正問題。
已有風(fēng)格
- 開發(fā)人員往往在加入項目之前已經(jīng)形成自有的編碼風(fēng)格，加入項目后應(yīng)以本規(guī)范為準(zhǔn)編寫代碼。特別是匈牙利命名法，因為帶有類型信息，并不適合 Python 編程，不應(yīng)在 Python 項目中應(yīng)用。
《新程序員》：云原生和全面數(shù)字化實踐50位技術(shù)專家共同創(chuàng)作，文字、視頻、音頻交互閱讀
總結(jié)
以上是生活随笔為你收集整理的简明 Python 编程规范v2的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Python 字符串方法详解
- 下一篇： 用 python 实现一个多线程网页下载