Python中的編碼規格有哪些-Python教學-PHP中文網

編碼規範

Python 編碼規範重要性的原因用一句話來概括就是：統一的編碼規範可以提高開發效率。

ps.python的程式碼寫基本上都要遵循PEP8的風格

#1、分號

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

2、命名

module_name, package_name, ClassName, method_name

應該避免的名稱

單字元名稱, 除了計數器和迭代器.
包/模組名稱中的連字號(-)
雙底線開頭並結尾的名稱(Python保留, 例如__init__)

命名約定

所謂"內部(Internal)"表示僅模組內可用, 或, 在類別內是保護或私有的.
用單下劃線(_)開頭表示模組變數或函數是protected的(使用import * from時不會包含)
用雙底線(__)開頭的實例變數或方法表示類別內私有.
將相關的類別和頂層函數放在同一個模組裡. 不像Java, 沒必要限制一個類別一個模組.
#對類別名稱使用大寫字母開頭的單字(如CapWords, 即Pascal風格),但是模組名應該用小寫加下劃線的方式(如lower_with_under.py). 儘管已經有很多現存的模組使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模組名碰巧和類名一致, 這會讓人困擾.

3、行長度

每行不超過80個字元

以下情況除外：

長的導入模組語句註解裡的URL
#不要使用反斜線連接行。

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

4、縮排

#用4個空格來縮排碼

絕對不要用tab, 也不要tab和空格混用. 對於行連接的情況, 你應該要么垂直對齊換行的元素(見:ref:`行長度` 部分的範例), 或使用4空格的懸掛式縮排(這時第一行不應該有參數):

       # 与起始变量对齐
       foo = long_function_name(var_one, var_two,
                                var_three, var_four)
 
       # 字典中与起始值对齐
       foo = {
           long_dictionary_key: value1 +
                                value2,
           ...
       }

登入後複製

5、空白行

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

頂級定義之間空兩行, 例如函數或類別定義.方法定義, 類別定義與第一個方法之間, 都應該空一行. 函數或方法中, 某些地方要是你覺得合適, 就空一行.

6、空格

按照標準的排版規範來使用標點兩邊的空格

#括號內不要有空格.

依照標準的排版規範來使用標點兩邊的空格

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

登入後複製

错误示范: spam( ham[ 1 ], { eggs: 2 }, [ ] )

登入後複製

7、類別

類別應該在其定義下有一個用於描述該類別的文檔字串. 如果你的類別有公共屬性(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_spam
        self.eggs = 0
 
    def public_method(self):
        """Performs operation blah."""

登入後複製

8、區塊註解和行註解

最需要寫註解的是程式碼中那些技巧性的部分. 如果你在下次程式碼審查的時候必須解釋一下, 那麼你應該現在就給它寫註釋. 對於複雜的操作, 應該在其操作開始前寫上若干行註釋. 對於不是一目了然的代碼, 應在其行尾添加註釋.

# 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

登入後複製

9、字串

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

登入後複製

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

登入後複製

10、導包

每個導入應該獨佔一行

正确示范: 
import os 
import sys

登入後複製

错误示范:   import os, sys

登入後複製

導入總是應該放在檔案頂部, 位於模組註釋和文檔字串之後, 模組全域變數和常數之前. 導入應該按照從最通用到最不通用的順序分組:

標準庫導入第三方庫導入應用程式指定導入

【總結】

1.命名

#函數、變數及屬性都應該用小寫單字拼寫，只見用_連接，不遵循駝峰命名法
類別與異常應該是首字母大寫，不要用_連接
受保護的實例屬性，應以單底線開頭
實例的私有屬性，應以雙底線開頭
模組層級的變數單字都要大寫，中間以單下劃線隔開
變數要盡可能有意義

2.空白

##和語法相關的每一層縮排都用4個空格表示
賦值時等號兩邊都要有一個空格
每一行所佔用的字元數應不超過79，實際操作應盡量不讓程式碼編輯器的行捲軸顯示出來
在使用函數進行函數式程式設計時，函數之間要空兩行
在類別中的函數，函數之間應該空一行
函數與類別是同一個級別，則他們之間應該空兩行
對於超出每行規定的字元數的長表達式，應當敲回車縮進，通常除了首行其餘各行都要在原來的基礎上再次縮進4個空格

3.語句

##判斷變數是否為None、False或True時不要用==，要用is，例如，if a is None
import語句要放在句首，導入時要盡量使用絕對導入不要使用相對導入，並且導入時最好指定相應的模組的某一具體功能，例如，from datetime import datetime
模組導入時應根據標準庫模組、第三方模組以及自用模組進行分類
檢測容器不為空時，應使用if 容器名，例如，lists = [] if lists
#採用內聯形式的否定詞，不要把否定詞放在整個表達式的前面，例如，應該if a is not None 而不是if not a is None

4.註解

對某些重要的程式碼區塊的功能說明，應使用單行註解
對整個模組功能的說明應使用多行註解
對類別或函數的功能及使用方法的詳細說明應使用文檔字串
python的註解盡量使用英文

以上是Python中的編碼規格有哪些的詳細內容。更多資訊請關注PHP中文網其他相關文章！