Python 預設引數 (2)
預設引數
新的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
。
這個時候,預設引數就排上用場了。由於我們經常計算x^2
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
這樣的不變物件呢?因為不變物件一旦建立,物件內部的資料就不能修改,這樣就減少了由於修改資料導致的錯誤。此外,由於物件不變,多工環境下同時讀取物件不需要加鎖,同時讀一點問題都沒有。我們在編寫程式時,如果可以設計一個不變物件,那就儘量設計成不變物件。