定義函數(shù)的時候不同,我們把參數(shù)的名字和位置確定下來吱晒,函數(shù)的接口定義就完成了。對于函數(shù)的調用者來說,只需要知道如何傳遞正確的參數(shù)仗哨,以及函數(shù)將返回什么樣的值就夠了热某,函數(shù)內部的復雜邏輯被封裝起來计济,調用者無需了解饭入。
Python的函數(shù)定義非常簡單,但靈活度卻非常大叛甫。除了正常定義的必選參數(shù)外葵第,還可以使用默認參數(shù)、可變參數(shù)和關鍵字參數(shù)合溺,使得函數(shù)定義出來的接口卒密,不但能處理復雜的參數(shù),還可以簡化調用者的代碼棠赛。
位置參數(shù)
我們先寫一個計算x2的函數(shù):
def power(x):
return x * x
對于power(x)函數(shù)哮奇,參數(shù)x就是一個位置參數(shù)。
當我們調用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(x, n)函數(shù)伏伐,可以計算任意n次方:
>>> power(5, 2)
25
>>> power(5, 3)
125
修改后的power(x, n)函數(shù)有兩個參數(shù):x和n,這兩個參數(shù)都是位置參數(shù)晕拆,調用函數(shù)時藐翎,傳入的兩個值按照位置順序依次賦給參數(shù)x和n。
默認參數(shù)
新的power(x, n)函數(shù)定義沒有問題实幕,但是吝镣,舊的調用代碼失敗了,原因是我們增加了一個參數(shù)昆庇,導致舊的代碼因為缺少一個參數(shù)而無法正常調用:
>>> power(5)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: power() missing 1 required positional argument: 'n'
Python的錯誤信息很明確:調用函數(shù)power()缺少了一個位置參數(shù)n末贾。
這個時候,默認參數(shù)就排上用場了凰锡。由于我們經常計算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')
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
如果已經有一個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
*nums表示把nums這個list的所有元素作為可變參數(shù)傳進去躏嚎。這種寫法相當有用蜜自,而且很常見。
關鍵字參數(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ù)傳進去:
>>> 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用關鍵字參數(shù)傳入到函數(shù)的**kw參數(shù),kw將獲得一個dict辈讶,注意kw獲得的dict是extra的一份拷貝命浴,對kw的改動不會影響到函數(shù)外的extra。
命名關鍵字參數(shù)
對于關鍵字參數(shù),函數(shù)的調用者可以傳入任意不受限制的關鍵字參數(shù)生闲。至于到底傳入了哪些媳溺,就需要在函數(shù)內部通過kw檢查。
仍以person()函數(shù)為例碍讯,我們希望檢查是否有city和job參數(shù):
def person(name, age, **kw):
if 'city' in kw:
# 有city參數(shù)
pass
if 'job' in kw:
# 有job參數(shù)
pass
print('name:', name, 'age:', age, 'other:', kw)
但是調用者仍可以傳入不受限制的關鍵字參數(shù):
>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)
如果要限制關鍵字參數(shù)的名字悬蔽,就可以用命名關鍵字參數(shù),例如捉兴,只接收city和job作為關鍵字參數(shù)蝎困。這種方式定義的函數(shù)如下:
def person(name, age, *, city, job):
print(name, age, city, job)
和關鍵字參數(shù)**kw不同,命名關鍵字參數(shù)需要一個特殊分隔符*倍啥,*后面的參數(shù)被視為命名關鍵字參數(shù)禾乘。
調用方式如下:
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
如果函數(shù)定義中已經有了一個可變參數(shù),后面跟著的命名關鍵字參數(shù)就不再需要一個特殊分隔符*了:
def person(name, age, *args, city, job):
print(name, age, args, city, job)
命名關鍵字參數(shù)必須傳入?yún)?shù)名逗栽,這和位置參數(shù)不同盖袭。如果沒有傳入?yún)?shù)名失暂,調用將報錯:
>>> 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
由于調用時缺少參數(shù)名city和job彼宠,Python解釋器把這4個參數(shù)均視為位置參數(shù),但person()函數(shù)僅接受2個位置參數(shù)弟塞。
命名關鍵字參數(shù)可以有缺省值凭峡,從而簡化調用:
def person(name, age, *, city='Beijing', job):
print(name, age, city, job)
由于命名關鍵字參數(shù)city具有默認值,調用時决记,可不傳入city參數(shù):
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
使用命名關鍵字參數(shù)時摧冀,要特別注意,如果沒有可變參數(shù)系宫,就必須加一個*作為特殊分隔符索昂。如果缺少*,Python解釋器將無法識別位置參數(shù)和命名關鍵字參數(shù):
def person(name, age, city, job):
# 缺少 *扩借,city和job被視為位置參數(shù)
pass
參數(shù)組合
在Python中定義函數(shù)椒惨,可以用必選參數(shù)、默認參數(shù)潮罪、可變參數(shù)康谆、關鍵字參數(shù)和命名關鍵字參數(shù),這5種參數(shù)都可以組合使用嫉到。但是請注意沃暗,參數(shù)定義的順序必須是:必選參數(shù)、默認參數(shù)何恶、可變參數(shù)孽锥、命名關鍵字參數(shù)和關鍵字參數(shù)。
比如定義一個函數(shù)细层,包含上述若干種參數(shù):
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)
在函數(shù)調用的時候惜辑,Python解釋器自動按照參數(shù)位置和參數(shù)名把對應的參數(shù)傳進去隔崎。
>>> 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,你也可以調用上述函數(shù):
>>> 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': '#'}
所以韵丑,對于任意函數(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ù)名正蛙,但最好使用習慣用法督弓。
命名的關鍵字參數(shù)是為了限制調用者可以傳入的參數(shù)名,同時可以提供默認值乒验。
定義命名的關鍵字參數(shù)在沒有可變參數(shù)的情況下不要忘了寫分隔符*愚隧,否則定義的將是位置參數(shù)。