在 Python 中實現函式過載

zhusongziye發表於2020-02-27

假設你有一個函式connect,它有一個引數address,這個引數可能是一個字串,也可能是一個元組。例如:

connect('123.45.32.18:8080')
connect(('123.45.32.18', 8080))

你想在程式碼裡面相容這兩種寫法,於是你可能會這樣寫程式碼:

def connect(address):
    if isinstance(address, str):
        ip, port = address.split(':')
    elif isinstance(address, tuple):
        ip, port = address
    else:
        print('地址格式不正確')

這種寫法簡單直接,但是如果引數的型別更多,那麼你就需要寫很長的 if-elif-elif-...-else。程式碼看起來就非常不美觀。

學習過 Java 的同學,應該對函式過載比較熟悉,可以定義幾個名字相同的函式,但是他們的引數型別或者數量不同,從而實現不同的程式碼邏輯。

在 Python 裡面,引數的數量不同可以使用預設引數來解決,不需要定義多個函式。那如果引數型別不同就實現不同的邏輯,除了上面的 if-else外,我們還可以使用functools模組裡面的singledispatch裝飾器實現函式過載。

我們來寫一段程式碼:

from functools import singledispatch

@singledispatch
def connect(address):
    print(f' 傳輸引數型別為:{type(address)},不是有效型別')

@connect.register
def _(address: str):
    ip, port = address.split(':')
    print(f'引數為字串,IP是:{ip}, 埠是:{port}')

@connect.register
def _(address: tuple):
    ip, port = address
    print(f'引數為元組,IP是:{ip}, 埠是:{port}')

connect('123.45.32.18:8080')
connect(('123.45.32.18', 8080))
connect(123)

我們執行一下這段程式碼,大家看看根據引數的不同,有什麼樣的不同效果:

可以看到,我們呼叫的函式,始終都是connect,但是由於傳入引數的型別不同,它執行的結果也不一樣。

我們使用singledispatch裝飾一個函式,那麼這個函式就是我們將會呼叫的函式。

這個函式在傳入引數不同時的具體實現,通過下面註冊的函式來實現。註冊的時候使用@我們定義的函式名.register來註冊。被註冊的函式名叫什麼無關緊要,所以這裡我都直接使用下劃線代替。

被註冊的函式的第一個引數,通過型別標註來確定它應該使用什麼型別。當我們呼叫我們定義的函式時,如果引數型別符合某個被註冊的函式,那麼就會執行這個被註冊的函式。如果引數型別不滿足任何一個被註冊的函式,那麼就會執行我們的原函式。

使用型別標註來指定引數型別是從 Python 3.7才引入的新特性。在 Python 3.6或之前的版本,我們需要通過@我們定義的函式名.register(型別)來指定型別,例如:

from functools import singledispatch

@singledispatch
def connect(address):
    print(f' 傳輸引數型別為:{type(address)},不是有效型別')

@connect.register(str)
def _(address):
    ip, port = address.split(':')
    print(f'引數為字串,IP是:{ip}, 埠是:{port}')

@connect.register(tuple)
def _(address):
    ip, port = address
    print(f'引數為元組,IP是:{ip}, 埠是:{port}')

同時,還有一個需要注意的點,就是隻有第一個引數的不同型別會被過載。後面的引數的型別變化會被自動忽略。

相關文章