Python 之 函數可變參數和關鍵字參數

可變參數允許你傳入0個或任意個參數，這些可變參數在函數調用時自動組裝為一個tuple。

def calc(*numbers): sum = 0 for n in numbers: sum = sum + n * n return sum 

定義可變參數和定義一個list或tuple參數相比，僅僅在參數前面加了一個*號。在函數內部，參數numbers接收到的是一個tuple，因此，函數代碼完全不變。但是，調用該函數時，可以傳入任意個參數，包括0個參數：

>>> calc(1, 2) 5 >>> calc() 0

而關鍵字參數允許你傳入0個或任意個含參數名的參數，這些關鍵字參數在函數內部自動組裝為一個dict。

def person(name, age, **kw): print('name:', name, 'age:', age, 'other:', kw) 

函數person除了必選參數name和age外，還接受關鍵字參數kw。在調用該函數時，可以只傳入必選參數：

>>> person('Michael', 30) name: Michael age: 30 other: {} 

也可以傳入任意個數的關鍵字參數：

>>> person('Bob', 35, city='Beijing') name: Bob age: 35 other: {'city': 'Beijing'} >>> person('Adam', 45, gender='M', job='Engineer') name: Adam age: 45 other: {'gender': 'M', 'job': 'Engineer'}

關鍵字參數有什么用？它可以擴展函數的功能。比如，在person函數里，我們保證能接收到name和age這兩個參數，但是，如果調用者願意提供更多的參數，我們也能收到。試想你正在做一個用戶注冊的功能，除了用戶名和年齡是必填項外，其他都是可選項，利用關鍵字參數來定義這個函數就能滿足注冊的需求。

和可變參數類似，也可以先組裝出一個dict，然后，把該dict轉換為關鍵字參數傳進去：

>>> extra = {'city': 'Beijing', 'job': 'Engineer'} >>> person('Jack', 24, city=extra['city'], job=extra['job']) name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'} 

當然，上面復雜的調用可以用簡化的寫法：

>>> extra = {'city': 'Beijing', 'job': 'Engineer'} >>> person('Jack', 24, **extra) name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
**extra表示把extra這個dict的所有key-value用關鍵字參數傳入到函數的**kw參數，kw將獲得一個dict，注意kw獲得的dict是extra的一份拷貝，對kw的改動不會影響到函數外的extra。

命名關鍵字參數

對於關鍵字參數，函數的調用者可以傳入任意不受限制的關鍵字參數。至於到底傳入了哪些，就需要在函數內部通過kw檢查。

仍以person()函數為例，我們希望檢查是否有city和job參數：

def person(name, age, **kw): if 'city' in kw: # 有city參數 pass if 'job' in kw: # 有job參數 pass print('name:', name, 'age:', age, 'other:', kw) 

但是調用者仍可以傳入不受限制的關鍵字參數：

>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456) 

如果要限制關鍵字參數的名字，就可以用命名關鍵字參數，例如，只接收city和job作為關鍵字參數。這種方式定義的函數如下：

def person(name, age, *, city, job): print(name, age, city, job) 

和關鍵字參數**kw不同，命名關鍵字參數需要一個特殊分隔符*，*后面的參數被視為命名關鍵字參數。

調用方式如下：

>>> person('Jack', 24, city='Beijing', job='Engineer') Jack 24 Beijing Engineer 

如果函數定義中已經有了一個可變參數，后面跟着的命名關鍵字參數就不再需要一個特殊分隔符*了：

def person(name, age, *args, city, job): print(name, age, args, city, job) 

命名關鍵字參數必須傳入參數名，這和位置參數不同。如果沒有傳入參數名，調用將報錯：

>>> person('Jack', 24, 'Beijing', 'Engineer')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module> TypeError: person() takes 2 positional arguments but 4 were given 

由於調用時缺少參數名city和job，Python解釋器把這4個參數均視為位置參數，但person()函數僅接受2個位置參數。

命名關鍵字參數可以有缺省值，從而簡化調用：

def person(name, age, *, city='Beijing', job): print(name, age, city, job) 

由於命名關鍵字參數city具有默認值，調用時，可不傳入city參數：

>>> person('Jack', 24, job='Engineer') Jack 24 Beijing Engineer 

使用命名關鍵字參數時，要特別注意，如果沒有可變參數，就必須加一個*作為特殊分隔符。如果缺少*，Python解釋器將無法識別位置參數和命名關鍵字參數：

def person(name, age, city, job): # 缺少 *，city和job被視為位置參數 pass

參數組合

在Python中定義函數，可以用必選參數、默認參數、可變參數、關鍵字參數和命名關鍵字參數，這5種參數都可以組合使用。但是請注意，參數定義的順序必須是：必選參數、默認參數、可變參數、命名關鍵字參數和關鍵字參數。

 

小結

Python的函數具有非常靈活的參數形態，既可以實現簡單的調用，又可以傳入非常復雜的參數。

默認參數一定要用不可變對象，如果是可變對象，程序運行時會有邏輯錯誤！

要注意定義可變參數和關鍵字參數的語法：

*args是可變參數，args接收的是一個tuple；

**kw是關鍵字參數，kw接收的是一個dict。

以及調用函數時如何傳入可變參數和關鍵字參數的語法：

可變參數既可以直接傳入：func(1, 2, 3)，又可以先組裝list或tuple，再通過*args傳入：func(*(1, 2, 3))；

關鍵字參數既可以直接傳入：func(a=1, b=2)，又可以先組裝dict，再通過**kw傳入：func(**{'a': 1, 'b': 2})。

使用*args和**kw是Python的習慣寫法，當然也可以用其他參數名，但最好使用習慣用法。

命名的關鍵字參數是為了限制調用者可以傳入的參數名，同時可以提供默認值。

定義命名的關鍵字參數在沒有可變參數的情況下不要忘了寫分隔符*，否則定義的將是位置參數。