python基礎(chǔ)之編碼規(guī)范總結(jié)

一、PEP 8規(guī)范

官方文檔：https://legacy.python.org/dev/peps/pep-0008/
中文翻譯： https://www.jb51.net/article/103944.htm

二、縮進(jìn)

每一級縮進(jìn)4個空格。

續(xù)行應(yīng)該與包裹元素對齊，要么使用圓括號，方括號，花括號內(nèi)的隱式行連接來垂直對齊，要么使用掛行縮進(jìn)對齊。當(dāng)使用掛行縮進(jìn)對齊時，應(yīng)該考慮到第一行不應(yīng)該有參數(shù)，以及使用縮進(jìn)以區(qū)分自己是續(xù)行。

• 對齊縮進(jìn)（左右括號對齊）

def long_function_name(var_one, var_two,
                       var_three, var_four):
    print(var_one)

• 懸掛縮進(jìn)

def long_function_name(
       var_one, var_two,
       var_three, var_four):
   print(var_one)

• 層級縮進(jìn)

def long_function_name(
      var_one, var_two, var_three,
      var_four):
  print(var_one, var_two, var_three, var_four)

三、行的最大長度

所有行限制的最大字符數(shù)為79

沒有結(jié)構(gòu)化限制的大塊文本（文檔字符或者注釋），每行的最大字符數(shù)限制在72。

with open("file1", "r") as f1, \

        open("file2", "r") as f2:
    f2.write(f1.read())

四、空行

頂層函數(shù)和類定義，前后用兩個空行隔開。

類里面方法定義用一個空行隔開。

class Class01:
    pass


class Class02:
    def function_01(self):
        pass

    def function_02(self):
        pass

五、命名約定

變量命名

• 永遠(yuǎn)不要使用字母I (小寫的L)， O （大寫的O）， I （大寫的I）作為單字符的變量名。
• 在有些字體里面，這些字符無法與數(shù)字0和1區(qū)分。如果想用I， 可使用L代替。

函數(shù)命名

• 函數(shù)名應(yīng)該小寫，如果想提高可讀性可以用下劃線分隔。
• 大小寫混合僅在為了兼容原來主要以大小寫混合風(fēng)格的情況下使用，保持向后兼容。

類命名

•  類名一般使用首字母大寫的約定。
• 在接口被文檔化并且主要被用于調(diào)用的情況下，可以使用函數(shù)的命名風(fēng)格代替。
• 注意：對于內(nèi)置的變量命名有一個單獨(dú)的約定：大部分內(nèi)置變量是單個單詞（或者兩個單詞連接在一起），首字母大寫的命名法只用于異常名或者內(nèi)部的常量。

類里面函數(shù)和方法參數(shù)

• 始終要將self作為實(shí)例方法的第一個參數(shù)。
• 始終要將cls作為類方法的第一個參數(shù)。
• 如果函數(shù)的參數(shù)名和已有關(guān)鍵字沖突，在最后加大意下劃線比縮寫或者隨意拼寫更好。因此class_比clss更好。

六、字符串引號

單引號和雙引號字符串是相同的。PEP不會為這個給出建議。選擇一條規(guī)則并堅(jiān)持使用下去。當(dāng)一個字符串中包含單引號或者雙引號字符串的時候，使用和最外層不同的符號來避免使用反斜杠，從而提高可讀性。

模塊和包導(dǎo)入規(guī)范

• 命名規(guī)范 模塊名稱要短，使用小寫，并避免使用特殊符號， 比如點(diǎn)和問號
• 因此請盡量保持模塊名簡單，以無需分開單詞最佳（不推薦在兩個單詞之間使用下劃線）

模塊導(dǎo)入建議