Python 程式的編碼規範（風格指南）？

---

編碼規範，即 Python 的風格指南，由名為 PEP8 的文件提供。PEP8 是 Python 增強提案 8。它是一個提供 Python 程式碼編碼約定的文件。

以下是風格指南：

命名約定

以下是當前推薦的命名標準。

避免使用這些名稱

切勿將字元“l”（小寫字母 el）、“O”（大寫字母 oh）或“I”（大寫字母 eye）用作單字元變數名。

包和模組名稱

模組應具有簡短、全部小寫的名稱。如果可以提高可讀性，則可以在模組名稱中使用下劃線。Python 包也應具有簡短、全部小寫的名稱，儘管不鼓勵使用下劃線。

類名

類名通常應使用 CapWords 約定。在介面已記錄且主要用作可呼叫物件的情況下，可以使用函式命名約定。

異常名稱

此處適用類命名約定。但是，您應該在異常名稱上使用字尾“Error”。

函式和變數名稱

函式名應為小寫，必要時用下劃線分隔單詞以提高可讀性。

變數名遵循與函式名相同的約定。

函式和方法引數

始終對例項方法的第一個引數使用 self。

始終對類方法的第一個引數使用 cls。

方法名和例項變數

使用函式命名規則：小寫，必要時用下劃線分隔單詞以提高可讀性。

僅對非公共方法和例項變數使用一個前導下劃線。

為了避免與子類發生名稱衝突，請使用兩個前導下劃線以呼叫 Python 的名稱改編規則。

常量

常量通常在模組級別定義，並以全大寫字母編寫，並使用下劃線分隔單詞。

縮排

指南建議每個縮排級別使用 4 個空格。

製表符或空格

製表符應僅用於保持與已使用製表符縮排的程式碼一致。

Python 不允許混合使用製表符和空格進行縮排。

最大行長

將所有行限制為最多 79 個字元。

匯入

import 語句，就像 Python 中的任何其他語句或關鍵字一樣，都應正確使用並新增到程式碼中，遵循最佳實踐。讓我們逐一瞭解它們：

多個匯入

多個匯入通常應位於單獨的行上。例如：

import numpy
import pandas
import matplotlib

始終位於頂部

匯入始終放在檔案頂部，即

• 在任何模組註釋和文件字串之後。
• 在模組全域性變數和常量之前。

例如：

# import the numpy module
import numpy

按順序匯入模組

一個好的實踐是按以下順序匯入模組：

• 標準庫模組 - 例如 sys、os、getopt、re。
• 第三方庫模組 - 例如 ZODB、PIL.Image 等。
• 本地開發的模組。

絕對匯入

建議使用絕對匯入，因為它們通常更具可讀性，並且如果匯入系統配置不正確，往往會更好地執行。例如：

import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

萬用字元匯入（fromimport *）應避免

避免使用萬用字元匯入，因為它們使名稱空間中存在的名稱不清楚，從而使讀者和許多自動化工具都感到困惑。

表示式和語句中的空格

避免不必要的空格，如下列情況所示：

在尾隨逗號之後

# Correct:
a = (0,)

# Wrong:
b = (0, )

在逗號、分號或冒號之前：

# Correct:
if a == 5: print(a, b); a, b = b, a

# Wrong:
if a == 5 : print(a , b) ; a , b = b , a

在開始函式呼叫引數列表的開括號之前

# Correct:
demo()

# Wrong:
demo ()

在開始索引或切片的開括號之前

# Correct:
dct['key'] = lst[index]

# Wrong:
dct ['key'] = lst [index]

註釋

• 註釋應為完整的句子。

• 第一個單詞應大寫，除非它是一個以小寫字母開頭的識別符號。

• 塊註釋通常由一個或多個由完整句子組成的段落組成，每個句子以句號結尾。

• 在多句註釋中，句尾句點後應使用兩個空格，最後一個句子除外。