編碼規(guī)范

Python 編碼規(guī)范重要性的原因用一句話來概括就是：統(tǒng)一的編碼規(guī)范可以提高開發(fā)效率。

無論你是 編程者，還是 閱讀者，好的規(guī)范能讓你的效率事半功倍，甚至機(jī)器在運(yùn)行時，提高程序運(yùn)行的效率。今天西紅柿就帶你盤一盤python的編碼規(guī)范。

ps.python的代碼編寫基本上都要遵循PEP8的風(fēng)格

1、分號

不要在行尾加分號, 也不要用分號將兩條命令放在同一行。

2、命名

module_name, package_name, ClassName, method_name

應(yīng)該避免的名稱

1. 單字符名稱, 除了計(jì)數(shù)器和迭代器.
2. 包/模塊名中的連字符(-)
3. 雙下劃線開頭并結(jié)尾的名稱(Python保留, 例如__init__)

命名約定

1. 所謂"內(nèi)部(Internal)"表示僅模塊內(nèi)可用, 或者, 在類內(nèi)是保護(hù)或私有的.
2. 用單下劃線(_)開頭表示模塊變量或函數(shù)是protected的(使用import * from時不會包含)
3. 用雙下劃線(__)開頭的實(shí)例變量或方法表示類內(nèi)私有.
4. 將相關(guān)的類和頂級函數(shù)放在同一個模塊里. 不像Java, 沒必要限制一個類一個模塊.
5. 對類名使用大寫字母開頭的單詞(如CapWords, 即Pascal風(fēng)格), 但是模塊名應(yīng)該用小寫加下劃線的方式(如lower_with_under.py). 盡管已經(jīng)有很多現(xiàn)存的模塊使用類似于CapWords.py這樣的命名, 但現(xiàn)在已經(jīng)不鼓勵這樣做, 因?yàn)槿绻K名碰巧和類名一致, 這會讓人困擾.

3、行長度

每行不超過80個字符

以下情況除外：

1. 長的導(dǎo)入模塊語句注釋里的URL
2. 不要使用反斜杠連接行。

Python會將 圓括號, 中括號和花括號中的行隱式的連接起來 , 你可以利用這個特點(diǎn). 如果需要, 你可以在表達(dá)式外圍增加一對額外的圓括號。

推薦: 

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'):

如果一個文本字符串在一行放不下, 可以使用圓括號來實(shí)現(xiàn)隱式行連接:

x = ('這是一個非常長非常長非常長非常長 '
     '非常長非常長非常長非常長非常長非常長的字符串')

4、縮進(jìn)

用4個空格來縮進(jìn)代碼

絕對不要用tab, 也不要tab和空格混用. 對于行連接的情況, 你應(yīng)該要么垂直對齊換行的元素(見 :ref:`行長度 <line_length>` 部分的示例), 或者使用4空格的懸掛式縮進(jìn)(這時第一行不應(yīng)該有參數(shù)):

       # 與起始變量對齊
       foo = long_function_name(var_one, var_two,
                                var_three, var_four)
 
       # 字典中與起始值對齊
       foo = {
           long_dictionary_key: value1 +
                                value2,
           ...
       }

5、空行

頂級定義之間空兩行, 方法定義之間空一行

頂級定義之間空兩行, 比如函數(shù)或者類定義. 方法定義, 類定義與第一個方法之間, 都應(yīng)該空一行. 函數(shù)或方法中, 某些地方要是你覺得合適, 就空一行.

6、空格

按照標(biāo)準(zhǔn)的排版規(guī)范來使用標(biāo)點(diǎn)兩邊的空格

括號內(nèi)不要有空格.

按照標(biāo)準(zhǔn)的排版規(guī)范來使用標(biāo)點(diǎn)兩邊的空格

正確示范: spam(ham[1], {eggs: 2}, [])

錯誤示范: spam( ham[ 1 ], { eggs: 2 }, [ ] )

7、類

類應(yīng)該在其定義下有一個用于描述該類的文檔字符串. 如果你的類有公共屬性(Attributes), 那么文檔中應(yīng)該有一個屬性(Attributes)段. 并且應(yīng)該遵守和函數(shù)參數(shù)相同的格式.

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_spam
        self.eggs = 0
 
    def public_method(self):
        """Performs operation blah."""

8、塊注釋和行注釋

最需要寫注釋的是代碼中那些技巧性的部分. 如果你在下次 代碼審查 的時候必須解釋一下, 那么你應(yīng)該現(xiàn)在就給它寫注釋. 對于復(fù)雜的操作, 應(yīng)該在其操作開始前寫上若干行注釋. 對于不是一目了然的代碼, 應(yīng)在其行尾添加注釋.

# 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

為了提高可讀性, 注釋應(yīng)該至少離開代碼2個空格.

另一方面, 絕不要描述代碼. 假設(shè)閱讀代碼的人比你更懂Python, 他只是不知道你的代碼要做什么.

# BAD COMMENT: Now go through the b array and make sure whenever i occurs
# the next element is i+1

9、字符串

正確示范: 
     x = a + b
     x = '%s, %s!' % (imperative, expletive)
     x = '{}, {}!'.format(imperative, expletive)
     x = 'name: %s; score: %d' % (name, n)
     x = 'name: {}; score: {}'.format(name, n)

錯誤示范: 
    x = '%s%s' % (a, b)  # use + in this case
    x = '{}{}'.format(a, b)  # use + in this case
    x = imperative + ', ' + expletive + '!'
    x = 'name: ' + name + '; score: ' + str(n)

10、導(dǎo)包

每個導(dǎo)入應(yīng)該獨(dú)占一行

正確示范: 
import os 
import sys

錯誤示范:   import os, sys

導(dǎo)入總應(yīng)該放在文件頂部, 位于模塊注釋和文檔字符串之后, 模塊全局變量和常量之前. 導(dǎo)入應(yīng)該按照從最通用到最不通用的順序分組:

標(biāo)準(zhǔn)庫導(dǎo)入第三方庫導(dǎo)入應(yīng)用程序指定導(dǎo)入

【總結(jié)】

1.命名

1. 函數(shù)、變量及屬性都應(yīng)該用小寫單詞拼寫，只見用_連接，不遵循駝峰命名法
2. 類與異常應(yīng)該首字母大寫，不要用_連接
3. 受保護(hù)的實(shí)例屬性，應(yīng)以單下劃線開頭
4. 實(shí)例的私有屬性，應(yīng)以雙下劃線開頭
5. 模塊級別的變量單詞都要大寫，中間以單下劃線隔開
6. 變量要盡可能有意義

2.空白

1. 和語法相關(guān)的每一層縮進(jìn)都用4個空格表示
2. 賦值時等號兩邊都要有一個空格
3. 每一行所占用的字符數(shù)應(yīng)不超過79，實(shí)際操作中應(yīng)當(dāng)盡量不讓代碼編輯器的行滾動條顯示出來
4. 在使用函數(shù)進(jìn)行函數(shù)式編程時，函數(shù)之間要空兩行
5. 在類中的函數(shù)，函數(shù)之間應(yīng)該空一行
6. 函數(shù)與類是同一個級別，則他們之間應(yīng)該空兩行
7. 對于超出每行規(guī)定的字符數(shù)的長表達(dá)式，應(yīng)當(dāng)敲回車縮進(jìn)，通常除了首行其余各行都要在原來的基礎(chǔ)上再次縮進(jìn)4個空格

3.語句

1. 判斷變量是否為None、False或True時不要用==，要用is，例如，if a is None
2. import語句應(yīng)放在句首，導(dǎo)入時要盡量使用絕對導(dǎo)入不要使用相對導(dǎo)入，并且導(dǎo)入時最好指定相應(yīng)的模塊的某一具體功能，例如，from datetime import datetime
3. 模塊導(dǎo)入時應(yīng)根據(jù)標(biāo)準(zhǔn)庫模塊、第三方模塊以及自用模塊進(jìn)行分類
4. 檢測容器不為空時，應(yīng)使用if 容器名，例如，lists = [] if lists
5. 采用內(nèi)聯(lián)形式的否定詞，不要把否定詞放在整個表達(dá)式的前面，例如，應(yīng)該if a is not None 而不是 if not a is None

4.注釋

1. 對某些重要的代碼塊的功能說明，應(yīng)使用單行注釋
2. 對整個模塊功能的說明應(yīng)使用多行注釋
3. 對類或函數(shù)的功能及使用方法的詳細(xì)說明應(yīng)使用文檔字符串
4. python的注釋盡量使用英文

到此這篇關(guān)于關(guān)于Python中的編碼規(guī)范的文章就介紹到這了,更多相關(guān)Python編碼規(guī)范內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論