在 Python 開發中，良好的命名慣例不僅能提升程式碼的可讀性，更能幫助團隊成員更好地理解和維護程式碼。本文將深入探討 Python 中底線（underscore）的各種用法，並結合實際案例說明其在機器學習和深度學習專案中的應用。

為什麼命名慣例很重要？

在軟體開發中，程式碼的可讀性與可維護性往往比執行效率更重要。Python 的核心開發者 Tim Peters 在《The Zen of Python》中提到：

Explicit is better than implicit.
Simple is better than complex.
Readability counts.

良好的命名慣例能幫助我們實現這些理念。

Python 底線命名的六種形式

Snake Case 命名法

在 Python 中，我們使用底線來分隔單字，這種命名方式被稱為 Snake Case。這是 Python 社群最推薦的命名方式。

# 推薦的命名方式
learning_rate = 0.001
batch_size = 32

def train_model(data_loader, model, optimizer):
    pass

# 不推薦的命名方式
learningRate = 0.001  # 這是 camelCase，不符合 Python 風格

單前置底線

當我們想表示一個變數或方法是內部使用時，可以使用單個底線作為前綴。

class NeuralNetwork:
    def __init__(self):
        self._hidden_layer = 64  # 表示這是內部使用的變數
        
    def _preprocess_data(self, data):
        # 內部使用的方法
        pass

這種命名方式表示：

這是一個內部實作細節
不建議外部直接存取
不會被 from module import * 導入

雙前置底線

Python 的名稱修飾（Name Mangling）機制會自動修改具有雙前置底線的變數名稱。

class BaseModel:
    def __init__(self):
        self.__version = "1.0"  # 會被修改為 _BaseModel__version

class SubModel(BaseModel):
    def __init__(self):
        super().__init__()
        self.__version = "2.0"  # 會被修改為 _SubModel__version

這種機制可以：

避免子類別意外覆蓋父類別的屬性
提供更強的封裝性
防止命名衝突

後置底線

當變數名稱與 Python 關鍵字衝突時，可以在後面加上底線。

class_ = "positive"  # class 是 Python 關鍵字
type_ = "numeric"    # type 是 Python 內建函數

def process_data(data, class_):
    return data[class_]

常見的例子包括：

class_
type_
lambda_
filter_

單獨底線

單獨的底線通常用於表示臨時性或不重要的變數。

# 在迴圈中忽略計數器
for _ in range(100):
    train_model()

# 解構時忽略某些值
name, _, age = ("John", "unused", 25)

# 在機器學習中忽略不需要的輸出
predictions, _ = model.predict(data)

這種用法在以下場景特別有用：

迴圈計數器
解構賦值
忽略函數返回值
臨時變數

雙前後底線（魔術方法）

Python 中的特殊方法（也稱為魔術方法）使用雙底線作為前後綴。

class Dataset:
    def __init__(self, data):
        self.data = data
    
    def __len__(self):
        return len(self.data)
    
    def __getitem__(self, idx):
        return self.data[idx]
    
    def __call__(self, x):
        return self.process(x)

常用的魔術方法包括：

__init__: 初始化物件
__len__: 定義長度
__getitem__: 允許索引存取
__call__: 使物件可調用
__str__: 字串表示

最佳實踐建議

一致性
- 在整個專案中保持命名風格的一致性
- 遵循團隊約定的命名規範
明確性
- 選擇有意義的變數名稱
- 避免過度簡寫和縮寫
適度使用
- 不要過度使用雙前置底線
- 單前置底線已經足夠表達"內部使用"的意圖
文件化
- 為複雜的命名決策添加註解
- 在專案文件中說明命名慣例

在機器學習專案中的應用

機器學習專案中常見的命名模式：

class NeuralNetwork:
    def __init__(self):
        self._learning_rate = 0.001
        self._hidden_size = 64
        self.__checkpoint = None
    
    def _normalize_input(self, x):
        return (x - self._mean) / self._std
    
    def __save_state(self):
        # 內部狀態保存
        pass

class DataLoader:
    def __init__(self, batch_size):
        self.batch_size = batch_size
        self._buffer = []
    
    def __len__(self):
        return len(self._buffer)
    
    def __getitem__(self, idx):
        return self._buffer[idx]

總結

Python 的底線命名慣例是一個強大的工具，能夠：

提高程式碼可讀性
表達開發者意圖
防止命名衝突
實現更好的封裝

透過合理使用這些命名慣例，我們可以寫出更易維護、更專業的 Python 程式碼。

CS Note
En

Python 中的底線命名慣例與最佳實踐