python中類名和文件名的命名規(guī)則詳細(xì)解釋

更新時間：2025年10月19日 09:52:13 作者：EVE?????

在Python中文件名命名規(guī)則對于代碼的可讀性和可維護性至關(guān)重要,這篇文章主要介紹了python中類名和文件名命名規(guī)則的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

1. 命名約定的來源

對于普通模塊（文件）

PEP 8 規(guī)定：模塊名（即文件名）應(yīng)該使用簡短、全小寫的名字，可以使用下劃線以提高可讀性。例如：my_module.py, data_loader.py。
類名：類名應(yīng)該使用駝峰命名法（CapWords convention）。例如：MyClass, DataLoader。

所以，如果你有一個類叫 DataLoader，那么它所在的文件最自然、最合理的名字就是全小寫的 data_loader.py。

類名：DataLoader -> 文件名：data_loader.py

對于測試模塊（pytest）

pytest 規(guī)定：pytest 為了能自動發(fā)現(xiàn)測試用例，對文件名和函數(shù)名有強制要求：
- 測試文件名應(yīng)以 test_ 開頭或以 _test.py 結(jié)尾。例如：test_login.py 或 login_test.py。
- 測試類名應(yīng)以 Test 開頭。例如：TestLogin。
- 測試函數(shù)名應(yīng)以 test_ 開頭。例如：test_login_success。

所以，在測試中，如果你有一個測試類叫 TestLogin，那么它所在的測試文件最合理的名字就是 test_login.py。

測試類名：TestLogin -> 測試文件名：test_login.py

2. 這樣做的主要好處

這種“文件名與類名強相關(guān)”的約定帶來了巨大的便利：

1. 極高的可讀性和可發(fā)現(xiàn)性

一看就懂：當(dāng)你看到一個類名 UserManager 時，你幾乎可以立刻猜到它定義在 user_manager.py 文件里。這極大地減少了尋找代碼位置的認(rèn)知負(fù)擔(dān)和時間成本。
反向亦然：當(dāng)你看到一個文件名 payment_processor.py 時，你也能很容易猜到里面主要的類應(yīng)該叫 PaymentProcessor。

2. 簡化導(dǎo)入語句

導(dǎo)入語句會變得非常直觀和整潔。你會發(fā)現(xiàn)導(dǎo)入語句和文件路徑幾乎有直接的映射關(guān)系。

# 從 user_manager.py 文件中導(dǎo)入 UserManager 類
from .user_manager import UserManager

# 從 test_login.py 文件中導(dǎo)入 TestLogin 類
from tests.test_login import TestLogin

如果命名不一致，導(dǎo)入語句就會變得很奇怪且難以理解。

3. 與 IDE 功能完美配合

現(xiàn)代 IDE（如 PyCharm）的強大導(dǎo)航和重構(gòu)功能都基于這種約定。

Go to Definition (跳轉(zhuǎn)到定義)：你在代碼中點擊 Login 類，IDE 會精準(zhǔn)地帶你跳到 login.py 文件。
Rename Refactoring (重命名重構(gòu))：如果你在 PyCharm 中重命名一個類（如將 Login 改為 UserLogin），IDE 會智能地詢問你是否也要重命名對應(yīng)的文件（將 login.py 改為 user_login.py），并自動更新所有引用該文件和類的地方。這保證了項目結(jié)構(gòu)的一致性，避免了手動修改可能帶來的錯誤。

4. 遵循社區(qū)共識，降低協(xié)作成本

當(dāng)所有項目都遵循相似的約定時，任何一個新的開發(fā)者加入項目，都能憑借這種“肌肉記憶”快速上手和理解項目結(jié)構(gòu)，而不需要去記憶每個項目獨特的、可能很隨意的命名規(guī)則。

總結(jié)

項目	來源	規(guī)則	好處
文件名小寫下劃線 (如 `data_loader.py`)	PEP 8 風(fēng)格指南	社區(qū)最佳實踐	可讀性高，易于導(dǎo)入
類名駝峰式 (如 `DataLoader`)	PEP 8 風(fēng)格指南	社區(qū)最佳實踐	符合面向?qū)ο缶幊虘T例，清晰易辨
測試文件以 test_ 開頭 (如 `test_login.py`)	pytest 框架規(guī)定	強制要求（為了自動發(fā)現(xiàn)測試）	pytest 能夠自動找到并運行測試用例
測試類以 Test 開頭 (如 `TestLogin`)	pytest 框架規(guī)定	強制要求（為了自動發(fā)現(xiàn)測試）	pytest 能夠識別該類為測試集合