Python 檔案命名風格

本文中討論的所有命名風格均基於 Python 程式碼的 PEP 8 樣式指南。

Python 庫的命名風格提供了一些可供選擇的空間，因此沒有太多的一致性。

Python 是一門龐大的語言，它有兩部分：現有的庫和函式。而另一個是第三方框架和包。

前者遵循一致性，而在後者的情況下命名可能會有所不同。

Python 中的命名風格

Python 中命名風格的一般注意事項：

• 不要使用可能類似於預定義函式的通用名稱。
• 不要使用過於冗長的名稱，因為它們會在多次使用該功能時增加出錯的空間。
• 字元 l、O 或 I 不應單獨用於命名。在某些字型中，這些字元有時會被誤解為 0 或 1。
• 當使用 CamelCase 約定時，所有縮寫的字母都大寫。

模組：

• 所有模組應僅以小寫字元命名。
• 當需要使用多個單詞來命名模組時，下劃線適合空白。
• 建議使用單個詞來命名模組。

庫：

• 與模組類似，包只能在小寫字母的幫助下命名。
• 當需要使用多個單詞來命名模組時，下劃線適合空白。
• 建議使用單個詞來命名包。

類：

• 通常建議使用 CapWords 約定來命名類。
• 但是，Python 中的內建類通常是小寫的。
• 建議所有異常類的名稱末尾都包含單詞 Error。

全域性變數：

• 建議這些變數全部使用小寫字母。
• 如果需要，可以用下劃線分隔單詞。

變數：

• 與全域性變數類似，例項變數也應該使用小寫字母。
• 如果需要，可以用下劃線分隔單詞。
• 在極少數情況下，例項變數的開頭可能帶有雙下劃線。

函式/方法：

• 函式或方法應始終使用小寫字母進行命名。
• 如果需要，可以用下劃線分隔單詞。
• 以單個下劃線開頭的函式通常標記非公共函式的命名。
• 在極少數情況下，方法的開頭可能帶有雙下劃線。

函式引數：

• 例項方法的第一個引數需要是 self。
• 類方法的第一個引數必須是 cls。

常量：

• 常量使用全部大寫字母。
• 如果有多個單詞，可以用下劃線分隔它們。