函數的參數 · 廖雪峰 JavaScript Python Git 教程

# 函數的參數定義函數的時候，我們把參數的名字和位置確定下來，函數的接口定義就完成了。對于函數的調用者來說，只需要知道如何傳遞正確的參數，以及函數將返回什么樣的值就夠了，函數內部的復雜邏輯被封裝起來，調用者無需了解。 Python的函數定義非常簡單，但靈活度卻非常大。除了正常定義的必選參數外，還可以使用默認參數、可變參數和關鍵字參數，使得函數定義出來的接口，不但能處理復雜的參數，還可以簡化調用者的代碼。 ## 位置參數我們先寫一個計算x2的函數： ``` def power(x): return x * x ``` 對于`power(x)`函數，參數`x`就是一個位置參數。當我們調用`power`函數時，必須傳入有且僅有的一個參數`x`： ``` >>> power(5) 25 >>> power(15) 225 ``` 現在，如果我們要計算x3怎么辦？可以再定義一個`power3`函數，但是如果要計算x4、x5……怎么辦？我們不可能定義無限多個函數。你也許想到了，可以把`power(x)`修改為`power(x, n)`，用來計算xn，說干就干： ``` def power(x, n): s = 1 while n > 0: n = n - 1 s = s * x return s ``` 對于這個修改后的`power(x, n)`函數，可以計算任意n次方： ``` >>> power(5, 2) 25 >>> power(5, 3) 125 ``` 修改后的`power(x, n)`函數有兩個參數：`x`和`n`，這兩個參數都是位置參數，調用函數時，傳入的兩個值按照位置順序依次賦給參數`x`和`n`。 ## 默認參數新的`power(x, n)`函數定義沒有問題，但是，舊的調用代碼失敗了，原因是我們增加了一個參數，導致舊的代碼因為缺少一個參數而無法正常調用： ``` >>> power(5) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: power() missing 1 required positional argument: 'n' ``` Python的錯誤信息很明確：調用函數`power()`缺少了一個位置參數`n`。這個時候，默認參數就排上用場了。由于我們經常計算x2，所以，完全可以把第二個參數n的默認值設定為2： ``` def power(x, n=2): s = 1 while n > 0: n = n - 1 s = s * x return s ``` 這樣，當我們調用`power(5)`時，相當于調用`power(5, 2)`： ``` >>> power(5) 25 >>> power(5, 2) 25 ``` 而對于`n > 2`的其他情況，就必須明確地傳入n，比如`power(5, 3)`。從上面的例子可以看出，默認參數可以簡化函數的調用。設置默認參數時，有幾點要注意：一是必選參數在前，默認參數在后，否則Python的解釋器會報錯（思考一下為什么默認參數不能放在必選參數前面）；二是如何設置默認參數。當函數有多個參數時，把變化大的參數放前面，變化小的參數放后面。變化小的參數就可以作為默認參數。使用默認參數有什么好處？最大的好處是能降低調用函數的難度。舉個例子，我們寫個一年級小學生注冊的函數，需要傳入`name`和`gender`兩個參數： ``` def enroll(name, gender): print('name:', name) print('gender:', gender) ``` 這樣，調用`enroll()`函數只需要傳入兩個參數： ``` >>> enroll('Sarah', 'F') name: Sarah gender: F ``` 如果要繼續傳入年齡、城市等信息怎么辦？這樣會使得調用函數的復雜度大大增加。我們可以把年齡和城市設為默認參數： ``` def enroll(name, gender, age=6, city='Beijing'): print('name:', name) print('gender:', gender) print('age:', age) print('city:', city) ``` 這樣，大多數學生注冊時不需要提供年齡和城市，只提供必須的兩個參數： ``` >>> enroll('Sarah', 'F') name: Sarah gender: F age: 6 city: Beijing ``` 只有與默認參數不符的學生才需要提供額外的信息： ``` enroll('Bob', 'M', 7) enroll('Adam', 'M', city='Tianjin') ``` 可見，默認參數降低了函數調用的難度，而一旦需要更復雜的調用時，又可以傳遞更多的參數來實現。無論是簡單調用還是復雜調用，函數只需要定義一個。有多個默認參數時，調用的時候，既可以按順序提供默認參數，比如調用`enroll('Bob', 'M', 7)`，意思是，除了`name`，`gender`這兩個參數外，最后1個參數應用在參數`age`上，`city`參數由于沒有提供，仍然使用默認值。也可以不按順序提供部分默認參數。當不按順序提供部分默認參數時，需要把參數名寫上。比如調用`enroll('Adam', 'M', city='Tianjin')`，意思是，`city`參數用傳進去的值，其他默認參數繼續使用默認值。默認參數很有用，但使用不當，也會掉坑里。默認參數有個最大的坑，演示如下：先定義一個函數，傳入一個list，添加一個`END`再返回： ``` def add_end(L=[]): L.append('END') return L ``` 當你正常調用時，結果似乎不錯： ``` >>> add_end([1, 2, 3]) [1, 2, 3, 'END'] >>> add_end(['x', 'y', 'z']) ['x', 'y', 'z', 'END'] ``` 當你使用默認參數調用時，一開始結果也是對的： ``` >>> add_end() ['END'] ``` 但是，再次調用`add_end()`時，結果就不對了： ``` >>> add_end() ['END', 'END'] >>> add_end() ['END', 'END', 'END'] ``` 很多初學者很疑惑，默認參數是`[]`，但是函數似乎每次都“記住了”上次添加了`'END'`后的list。原因解釋如下： Python函數在定義的時候，默認參數`L`的值就被計算出來了，即`[]`，因為默認參數`L`也是一個變量，它指向對象`[]`，每次調用該函數，如果改變了`L`的內容，則下次調用時，默認參數的內容就變了，不再是函數定義時的`[]`了。所以，定義默認參數要牢記一點：默認參數必須指向不變對象！要修改上面的例子，我們可以用`None`這個不變對象來實現： ``` def add_end(L=None): if L is None: L = [] L.append('END') return L ``` 現在，無論調用多少次，都不會有問題： ``` >>> add_end() ['END'] >>> add_end() ['END'] ``` 為什么要設計`str`、`None`這樣的不變對象呢？因為不變對象一旦創建，對象內部的數據就不能修改，這樣就減少了由于修改數據導致的錯誤。此外，由于對象不變，多任務環境下同時讀取對象不需要加鎖，同時讀一點問題都沒有。我們在編寫程序時，如果可以設計一個不變對象，那就盡量設計成不變對象。 ## 可變參數在Python函數中，還可以定義可變參數。顧名思義，可變參數就是傳入的參數個數是可變的，可以是1個、2個到任意個，還可以是0個。我們以數學題為例子，給定一組數字a，b，c……，請計算a2 + b2 + c2 + ……。要定義出這個函數，我們必須確定輸入的參數。由于參數個數不確定，我們首先想到可以把a，b，c……作為一個list或tuple傳進來，這樣，函數可以定義如下： ``` def calc(numbers): sum = 0 for n in numbers: sum = sum + n * n return sum ``` 但是調用的時候，需要先組裝出一個list或tuple： ``` >>> calc([1, 2, 3]) 14 >>> calc((1, 3, 5, 7)) 84 ``` 如果利用可變參數，調用函數的方式可以簡化成這樣： ``` >>> calc(1, 2, 3) 14 >>> calc(1, 3, 5, 7) 84 ``` 所以，我們把函數的參數改為可變參數： ``` 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 ``` 如果已經有一個list或者tuple，要調用一個可變參數怎么辦？可以這樣做： ``` >>> nums = [1, 2, 3] >>> calc(nums[0], nums[1], nums[2]) 14 ``` 這種寫法當然是可行的，問題是太繁瑣，所以Python允許你在list或tuple前面加一個`*`號，把list或tuple的元素變成可變參數傳進去： ``` >>> nums = [1, 2, 3] >>> calc(*nums) 14 ``` `*nums`表示把`nums`這個list的所有元素作為可變參數傳進去。這種寫法相當有用，而且很常見。 ## 關鍵字參數可變參數允許你傳入0個或任意個參數，這些可變參數在函數調用時自動組裝為一個tuple。而關鍵字參數允許你傳入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 ``` 命名關鍵字參數必須傳入參數名，這和位置參數不同。如果沒有傳入參數名，調用將報錯： ``` >>> 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種參數都可以組合使用，除了可變參數無法和命名關鍵字參數混合。但是請注意，參數定義的順序必須是：必選參數、默認參數、可變參數/命名關鍵字參數和關鍵字參數。比如定義一個函數，包含上述若干種參數： ``` def f1(a, b, c=0, *args, **kw): print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw) def f2(a, b, c=0, *, d, **kw): print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw) ``` 在函數調用的時候，Python解釋器自動按照參數位置和參數名把對應的參數傳進去。 ``` >>> f1(1, 2) a = 1 b = 2 c = 0 args = () kw = {} >>> f1(1, 2, c=3) a = 1 b = 2 c = 3 args = () kw = {} >>> f1(1, 2, 3, 'a', 'b') a = 1 b = 2 c = 3 args = ('a', 'b') kw = {} >>> f1(1, 2, 3, 'a', 'b', x=99) a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99} >>> f2(1, 2, d=99, ext=None) a = 1 b = 2 c = 0 d = 99 kw = {'ext': None} ``` 最神奇的是通過一個tuple和dict，你也可以調用上述函數： ``` >>> args = (1, 2, 3, 4) >>> kw = {'d': 99, 'x': '#'} >>> f1(*args, **kw) a = 1 b = 2 c = 3 args = (4,) kw = {'d': 99, 'x': '#'} >>> args = (1, 2, 3) >>> kw = {'d': 88, 'x': '#'} >>> f2(*args, **kw) a = 1 b = 2 c = 3 d = 88 kw = {'x': '#'} ``` 所以，對于任意函數，都可以通過類似`func(*args, **kw)`的形式調用它，無論它的參數是如何定義的。 ## 小結 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的習慣寫法，當然也可以用其他參數名，但最好使用習慣用法。命名的關鍵字參數是為了限制調用者可以傳入的參數名，同時可以提供默認值。定義命名的關鍵字參數不要忘了寫分隔符`*`，否則定義的將是位置參數。 ## 參考源碼 [var_args.py](https://github.com/michaelliao/learn-python3/blob/master/samples/function/var_args.py) [kw_args.py](https://github.com/michaelliao/learn-python3/blob/master/samples/function/kw_args.py)