HOWTO · Python

在 Python 中過載建構函式

本教程演示如何在 Python 中過載建構函式

本頁內容

Python 不會依參數比對來選擇多個 __init__ 方法中的某一個。若類別重複定義 __init__,後面的定義會取代前面的定義,因此建立實例時只有後面的定義可用。若要支援多種物件初始化方式,可以在同一個初始化方法中處理不同選項、提供具名工廠方法,或為初始化參數設定實用的預設值。

Python 中的建構函式多載是什麼意思

在支援依簽章多載建構函式的語言中,執行階段可以根據參數型別或數量選擇建構函式。Python 不會為重複定義的 __init__ 做這種選擇。單一 __init__ 可以接受彈性的引數並自行決定如何處理,但這是在同一個方法內進行分派,並非原生多載。請明確列出支援的形式,讓呼叫端知道這個類別接受哪些值。

使用 *args 依引數型別或數量進行分派

*args 參數會將位置引數收集成一個 tuple。你可以檢查 tuple 的長度或其中各值的型別,再據此初始化實例。讀取引數前,先確認該引數確實存在;也要決定遇到不支援的輸入形式時,類別應如何處理。以下可執行範例支援一個整數或一個字串,並顯示選取的值。

執行此範例:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

class Greeting:
    def __init__(self, *args):
        if len(args) != 1:
            self.message = "Pass one integer or string"
        else:
            value = args[0]
            if isinstance(value, int):
                self.message = str(value)
            elif isinstance(value, str):
                self.message = "Hello from " + value
            else:
                self.message = "Pass an integer or string"


print(Greeting("Delft").message)

在存取 args[0] 前先檢查引數數量,就能安全處理沒有位置引數的呼叫。數量檢查也會拒絕多餘的引數。在 Python 中,bool 是 int 的子類別,因此 isinstance(True, int) 的結果為 true;如果不應將布林值當成整數接受,請使用精確型別檢查。

當每種位置引數數量都有明確意義時,依數量選擇處理方式就很實用。這個初始化方法只支援零個、一個或兩個引數:不提供引數時使用預設範圍;提供一個引數時,該值是終點;提供兩個引數時,兩者分別是起點和終點。其他數量都會收到清楚的訊息。每個分支都會先檢查數量再讀取 args,因此零引數或不支援的數量都不會造成索引不存在的值。

執行此範例:

class RangeSpec:
    def __init__(self, *args):
        if len(args) == 0:
            self.start, self.stop = 0, 10
        elif len(args) == 1:
            self.start, self.stop = 0, args[0]
        elif len(args) == 2:
            self.start, self.stop = args
        else:
            self.start, self.stop = None, None
            self.message = "Pass zero, one, or two values"

    def describe(self):
        if self.start is None:
            return self.message
        return f"Range from {self.start} to {self.stop}"


for spec in (RangeSpec(), RangeSpec(5), RangeSpec(2, 5), RangeSpec(1, 2, 3)):
    print(spec.describe())

這四次呼叫涵蓋所有支援的引數數量,以及一種超出支援範圍的數量。如果需要支援更多形式,建議使用具名參數或工廠方法,讓呼叫端不必記住每種位置引數數量代表什麼。

使用 @classmethod 工廠方法作為替代建構方式

@classmethod 會以類別作為第一個引數,慣例上將其命名為 cls。工廠方法可以將其他表示形式轉換成一般初始化方法所需的值,再傳回 cls(...)。這會建立一個實例;由於 cls 指向呼叫此方法的類別,因此也能自然地搭配子類別使用。工廠方法是具名的建構途徑,不會為 __init__ 增加多載。

執行此範例:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    @classmethod
    def from_pair(cls, pair):
        return cls(pair[0], pair[1])


point = Point.from_pair((3, 4))
print(point.x, point.y)

當輸入格式有明確名稱時,可以分別提供工廠方法,例如 from_file、from_row 或 from_coordinates。如果轉換工作本身需要驗證或正規化資料,就在工廠方法中處理。主要初始化方法則應維持為建立物件必要狀態的單一位置。

使用預設引數處理可選的初始化模式

當參數確實可省略,而且其意義清楚時,預設值就很適合。呼叫端可以省略這些值,不必另外加入分派邏輯。建議使用數字、字串或 None 等不可變的預設值;像 list 這類可變值通常應在方法內建立,避免不同實例意外共用同一個值。

執行此範例:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

class Profile:
    def __init__(self, name="Guest", score=0):
        self.name = name
        self.score = score


for profile in (Profile(), Profile("Mina"), Profile("Mina", 7)):
    print(profile.name, profile.score)

在此範例中,呼叫端可以不提供任何可選值、只提供名稱,或同時提供兩個值。如果省略參數會代表好幾種不同情況、參數彼此相依,或許多位置引數組合難以記憶,預設值就不太適合。這時使用只能以關鍵字指定的參數或具名工廠方法,能讓呼叫方式更清楚。

選擇合適的建構函式模式

少量一般的可選值適合使用預設值。如果建構過程從另一種表示形式開始,或建立方式值得使用描述性名稱,則可使用工廠方法。只有在精簡且穩定的位置引數形式屬於預期 API 的一部分時,才使用 *args 分派;使用值之前,請先驗證引數數量和型別。若需要複雜的驗證,明確的分支和有幫助的錯誤訊息,比巧妙的型別技巧更容易維護。

這些技巧可以搭配使用:工廠方法可以先驗證資料,再呼叫同一個初始化方法;預設值則可處理可選欄位。請選擇最簡單的介面,讓有效的呼叫方式一目瞭然,也讓不支援的呼叫有可預期的處理結果。最重要的原則是,每個類別只有一個生效中的 __init__ 定義;彈性來自你在該定義中提供的邏輯與具名替代方式。