函式的引數

定義函式的時候，我們把引數的名字和位置確定下來，函式的介面定義就完成了。對於函式的呼叫者來說，只需要知道如何傳遞正確的引數，以及函式將返回什麼樣的值就夠了，函式內部的複雜邏輯被封裝起來，呼叫者無需瞭解。

Python的函式定義非常簡單，但靈活度卻非常大。除了正常定義的必選引數外，還可以使用預設引數、可變引數和關鍵字引數，使得函式定義出來的介面，不但能處理複雜的引數，還可以簡化呼叫者的程式碼。

1、預設引數

我們仍以具體的例子來說明如何定義函式的預設引數。先寫一個計算x2的函式：

>>> def power(x):
...     return x*x
...
 
 
>>> power(5)

當我們呼叫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函式，可以計算任意n次方：

>>> power(5, 2)
25
>>> power(5, 3)
125

但是，舊的呼叫程式碼失敗了，原因是我們增加了一個引數，導致舊的程式碼無法正常呼叫：

>>> power(5)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: power() takes exactly 2 arguments (1 given)
這個時候，預設引數就排上用場了。由於我們經常計算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')
Student:
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這樣的不變物件呢？因為不變物件一旦建立，物件內部的資料就不能修改，這樣就減少了由於修改資料導致的錯誤。此外，由於物件不變，多工環境下同時讀取物件不需要加鎖，同時讀一點問題都沒有。我們在編寫程式時，如果可以設計一個不變物件，那就儘量設計成不變物件。

2、可變引數

在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

這種寫法相當有用，而且很常見。

3、關鍵字引數

可變引數允許你傳入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轉換為關鍵字引數傳進去：

>>> 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'}

4、引數組合

在Python中定義函式，可以用必選引數、預設引數、可變引數和關鍵字引數，這4種引數都可以一起使用，或者只用其中某些，但是請注意，引數定義的順序必須是：必選引數、預設引數、可變引數和關鍵字引數。

比如定義一個函式，包含上述4種引數：

def func(a, b, c=0, *args, **kw):
    print 'a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw

在函式呼叫的時候，Python直譯器自動按照引數位置和引數名把對應的引數傳進去。

>>> 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，你也可以呼叫該函式：

>>> args = (1, 2, 3, 4)
>>> kw = {'x': 99}
>>> func(*args, **kw)
a = 1 b = 2 c = 3 args = (4,) kw = {'x': 99}

所以，對於任意函式，都可以通過類似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的習慣寫法，當然也可以用其他引數名，但最好使用習慣用法。

部落格參考 廖雪峰的官方網站，覺得寫的很全面，故整理到自己的部落格。