淺談python函數簽名

函數簽名對象，表示調用函數的方式，即定義了函數的輸入和輸出。

在Python中，可以使用標准庫inspect的一些方法或類，來操作或創建函數簽名。

獲取函數簽名及參數

使用標准庫的signature方法，獲取函數簽名對象；通過函數簽名的parameters屬性，獲取函數參數。

# 注意是小寫的signature
from inspect import signature

def foo(value):
    return value

# 獲取函數簽名
foo_sig = signature(foo)
# 通過函數簽名的parameters屬性，可以獲取函數參數
foo_params = foo_sig.parameters

創建函數簽名

使用類Parameter的實例創建函數參數列表；使用Signature類，接受函數參數列表，實例化出函數簽名實例。

# 注意是首字母大寫的Signature
from inspect import Signature, Parameter

# 創建一個函數參數列表，列表內的元素由類Parameter的實例組成
# Parameter實例化時，依次接受參數名、參數類型、默認值和參數注解
# 默認值和參數類型默認為空，這里的空值不是None，而是Parameter.empty，代表沒有值
parms = [Parameter('x', Parameter.POSITIONAL_OR_KEYWORD),
         Parameter('y', Parameter.POSITIONAL_OR_KEYWORD),
         Parameter('z', Parameter.KEYWORD_ONLY, default=9)]

# 使用Signature類，接受函數參數列表，實例化出函數簽名實例
sig = Signature(parms)

檢查函數參數是否匹配簽名

使用函數簽名的bind的方法，檢查函數參數是否匹配簽名。

延續上面的例子，通過函數簽名的bind方法，接受函數參數，如果匹配，返回參數BoundArguments實例，如果不匹配，則拋出TypeError，並給出詳細的異常信息。

通過BoundArguments實例的屬性，可以獲取函數簽名、參數的值等內容。

bound_args_01 = sig.bind(1, 2, z=3)
# <BoundArguments (x=1, y=2, z=3)>
bound_args_02 = sig.bind(1, 2)
# <BoundArguments (x=1, y=2)>
bound_args_03 = sig.bind(1)
# TypeError
# missing a required argument: 'y'