理解Python中函數(shù)的參數(shù)

定義函數(shù)的時候，我們把參數(shù)的名字和位置確定下來，函數(shù)的接口定義就完成了。對于函數(shù)的調用者來說，只需要知道如何傳遞正確的參數(shù)，以及函數(shù)將返回什么樣的值就夠了，函數(shù)內部的復雜邏輯被封裝起來，調用者無需了解。
Python的函數(shù)定義非常簡單，但靈活度卻非常大。除了正常定義的必選參數(shù)外，還可以使用默認參數(shù)、可變參數(shù)和關鍵字參數(shù)，使得函數(shù)定義出來的接口，不但能處理復雜的參數(shù)，還可以簡化調用者的代碼。
默認參數(shù)
我們仍以具體的例子來說明如何定義函數(shù)的默認參數(shù)。先寫一個計算x2的函數(shù)：    
def power(x):
  return x * x

當我們調用power函數(shù)時，必須傳入有且僅有的一個參數(shù)x：    
>>> power(5)
25
>>> power(15)
225

現(xiàn)在，如果我們要計算x3怎么辦？可以再定義一個power3函數(shù)，但是如果要計算x4、x5……怎么辦？我們不可能定義無限多個函數(shù)。

你也許想到了，可以把power(x)修改為power(x, n)，用來計算xn，說干就干：    
def power(x, n):
  s = 1
  while n > 0:
    n = n - 1
    s = s * x
  return s

對于這個修改后的power函數(shù)，可以計算任意n次方：    
>>> power(5, 2)
25
>>> power(5, 3)
125

但是，舊的調用代碼失敗了，原因是我們增加了一個參數(shù)，導致舊的代碼無法正常調用：    
>>> power(5)
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
TypeError: power() takes exactly 2 arguments (1 given)

這個時候，默認參數(shù)就排上用場了。由于我們經(jīng)常計算x2，所以，完全可以把第二個參數(shù)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)。
從上面的例子可以看出，默認參數(shù)可以簡化函數(shù)的調用。設置默認參數(shù)時，有幾點要注意：
一是必選參數(shù)在前，默認參數(shù)在后，否則Python的解釋器會報錯（思考一下為什么默認參數(shù)不能放在必選參數(shù)前面）；
二是如何設置默認參數(shù)。
當函數(shù)有多個參數(shù)時，把變化大的參數(shù)放前面，變化小的參數(shù)放后面。變化小的參數(shù)就可以作為默認參數(shù)。
使用默認參數(shù)有什么好處？最大的好處是能降低調用函數(shù)的難度。
舉個例子，我們寫個一年級小學生注冊的函數(shù)，需要傳入name和gender兩個參數(shù)：    
def enroll(name, gender):
  print 'name:', name
  print 'gender:', gender

這樣，調用enroll()函數(shù)只需要傳入兩個參數(shù)：    
>>> enroll('Sarah', 'F')
name: Sarah
gender: F

如果要繼續(xù)傳入年齡、城市等信息怎么辦？這樣會使得調用函數(shù)的復雜度大大增加。

我們可以把年齡和城市設為默認參數(shù)：    
def enroll(name, gender, age=6, city='Beijing'):
  print 'name:', name
  print 'gender:', gender
  print 'age:', age
  print 'city:', city

這樣，大多數(shù)學生注冊時不需要提供年齡和城市，只提供必須的兩個參數(shù)：    
>>> enroll('Sarah', 'F')
Student:
name: Sarah
gender: F
age: 6
city: Beijing

只有與默認參數(shù)不符的學生才需要提供額外的信息：    
enroll('Bob', 'M', 7)
enroll('Adam', 'M', city='Tianjin')

可見，默認參數(shù)降低了函數(shù)調用的難度，而一旦需要更復雜的調用時，又可以傳遞更多的參數(shù)來實現(xiàn)。無論是簡單調用還是復雜調用，函數(shù)只需要定義一個。

有多個默認參數(shù)時，調用的時候，既可以按順序提供默認參數(shù)，比如調用enroll('Bob', 'M', 7)，意思是，除了name，gender這兩個參數(shù)外，最后1個參數(shù)應用在參數(shù)age上，city參數(shù)由于沒有提供，仍然使用默認值。

也可以不按順序提供部分默認參數(shù)。當不按順序提供部分默認參數(shù)時，需要把參數(shù)名寫上。比如調用enroll('Adam', 'M', city='Tianjin')，意思是，city參數(shù)用傳進去的值，其他默認參數(shù)繼續(xù)使用默認值。

默認參數(shù)很有用，但使用不當，也會掉坑里。默認參數(shù)有個最大的坑，演示如下：

先定義一個函數(shù)，傳入一個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']

當你使用默認參數(shù)調用時，一開始結果也是對的：    
>>> add_end()
['END']

但是，再次調用add_end()時，結果就不對了：    
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']

很多初學者很疑惑，默認參數(shù)是[]，但是函數(shù)似乎每次都“記住了”上次添加了'END'后的list。

原因解釋如下：

Python函數(shù)在定義的時候，默認參數(shù)L的值就被計算出來了，即[]，因為默認參數(shù)L也是一個變量，它指向對象[]，每次調用該函數(shù)，如果改變了L的內容，則下次調用時，默認參數(shù)的內容就變了，不再是函數(shù)定義時的[]了。

所以，定義默認參數(shù)要牢記一點：默認參數(shù)必須指向不變對象！

要修改上面的例子，我們可以用None這個不變對象來實現(xiàn)：    
def add_end(L=None):
  if L is None:
    L = []
  L.append('END')
  return L

現(xiàn)在，無論調用多少次，都不會有問題：    
>>> add_end()
['END']
>>> add_end()
['END']

為什么要設計str、None這樣的不變對象呢？因為不變對象一旦創(chuàng)建，對象內部的數(shù)據(jù)就不能修改，這樣就減少了由于修改數(shù)據(jù)導致的錯誤。此外，由于對象不變，多任務環(huán)境下同時讀取對象不需要加鎖，同時讀一點問題都沒有。我們在編寫程序時，如果可以設計一個不變對象，那就盡量設計成不變對象。
可變參數(shù)

在Python函數(shù)中，還可以定義可變參數(shù)。顧名思義，可變參數(shù)就是傳入的參數(shù)個數(shù)是可變的，可以是1個、2個到任意個，還可以是0個。

我們以數(shù)學題為例子，給定一組數(shù)字a，b，c……，請計算a2 + b2 + c2 + ……。

要定義出這個函數(shù)，我們必須確定輸入的參數(shù)。由于參數(shù)個數(shù)不確定，我們首先想到可以把a，b，c……作為一個list或tuple傳進來，這樣，函數(shù)可以定義如下：    
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

如果利用可變參數(shù)，調用函數(shù)的方式可以簡化成這樣：    
>>> calc(1, 2, 3)
14
>>> calc(1, 3, 5, 7)
84

所以，我們把函數(shù)的參數(shù)改為可變參數(shù)：    
def calc(*numbers):
  sum = 0
  for n in numbers:
    sum = sum + n * n
  return sum

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

如果已經(jīng)有一個list或者tuple，要調用一個可變參數(shù)怎么辦？可以這樣做：    
>>> nums = [1, 2, 3]
>>> calc(nums[0], nums[1], nums[2])
14

這種寫法當然是可行的，問題是太繁瑣，所以Python允許你在list或tuple前面加一個*號，把list或tuple的元素變成可變參數(shù)傳進去：    
>>> nums = [1, 2, 3]
>>> calc(*nums)
14

這種寫法相當有用，而且很常見。
關鍵字參數(shù)

可變參數(shù)允許你傳入0個或任意個參數(shù)，這些可變參數(shù)在函數(shù)調用時自動組裝為一個tuple。而關鍵字參數(shù)允許你傳入0個或任意個含參數(shù)名的參數(shù)，這些關鍵字參數(shù)在函數(shù)內部自動組裝為一個dict。請看示例：    
def person(name, age, **kw):
  print 'name:', name, 'age:', age, 'other:', kw

函數(shù)person除了必選參數(shù)name和age外，還接受關鍵字參數(shù)kw。在調用該函數(shù)時，可以只傳入必選參數(shù)：    
>>> person('Michael', 30)
name: Michael age: 30 other: {}

也可以傳入任意個數(shù)的關鍵字參數(shù)：    
>>> 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'}

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

和可變參數(shù)類似，也可以先組裝出一個dict，然后，把該dict轉換為關鍵字參數(shù)傳進去：    
>>> kw = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, city=kw['city'], job=kw['job'])
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

當然，上面復雜的調用可以用簡化的寫法：    
>>> kw = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, **kw)
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

參數(shù)組合

在Python中定義函數(shù)，可以用必選參數(shù)、默認參數(shù)、可變參數(shù)和關鍵字參數(shù)，這4種參數(shù)都可以一起使用，或者只用其中某些，但是請注意，參數(shù)定義的順序必須是：必選參數(shù)、默認參數(shù)、可變參數(shù)和關鍵字參數(shù)。

比如定義一個函數(shù)，包含上述4種參數(shù)：    
def func(a, b, c=0, *args, **kw):
  print 'a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw

在函數(shù)調用的時候，Python解釋器自動按照參數(shù)位置和參數(shù)名把對應的參數(shù)傳進去。    
>>> func(1, 2)
a = 1 b = 2 c = 0 args = () kw = {}
>>> func(1, 2, c=3)
a = 1 b = 2 c = 3 args = () kw = {}
>>> func(1, 2, 3, 'a', 'b')
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}
>>> func(1, 2, 3, 'a', 'b', x=99)
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}

最神奇的是通過一個tuple和dict，你也可以調用該函數(shù)：    
>>> args = (1, 2, 3, 4)
>>> kw = {'x': 99}
>>> func(*args, **kw)
a = 1 b = 2 c = 3 args = (4,) kw = {'x': 99}

所以，對于任意函數(shù)，都可以通過類似func(*args, **kw)的形式調用它，無論它的參數(shù)是如何定義的。
小結

Python的函數(shù)具有非常靈活的參數(shù)形態(tài)，既可以實現(xiàn)簡單的調用，又可以傳入非常復雜的參數(shù)。

默認參數(shù)一定要用不可變對象，如果是可變對象，運行會有邏輯錯誤！

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

    *args是可變參數(shù)，args接收的是一個tuple；
    **kw是關鍵字參數(shù)，kw接收的是一個dict。

以及調用函數(shù)時如何傳入可變參數(shù)和關鍵字參數(shù)的語法：
    可變參數(shù)既可以直接傳入：func(1, 2, 3)，又可以先組裝list或tuple，再通過*args傳入：func(*(1, 2, 3))；
    關鍵字參數(shù)既可以直接傳入：func(a=1, b=2)，又可以先組裝dict，再通過**kw傳入：func(**{'a': 1, 'b': 2})。
使用*args和**kw是Python的習慣寫法，當然也可以用其他參數(shù)名，但最好使用習慣用法。