定義函數(shù)的時候般渡,我們把參數(shù)的名字和位置確定下來蚕脏,函數(shù)的接口定義就完成了褐隆。對于函數(shù)的調(diào)用者來說污它,只需要知道如何傳遞正確的參數(shù),以及函數(shù)將返回什么樣的值就夠了庶弃,函數(shù)內(nèi)部的復(fù)雜邏輯被封裝起來衫贬,調(diào)用者無需了解。
Python的函數(shù)定義非常簡單歇攻,但靈活度卻非常大固惯。除了正常定義的必選參數(shù)外,還可以使用默認(rèn)參數(shù)缴守、可變參數(shù)和關(guān)鍵字參數(shù)葬毫,使得函數(shù)定義出來的接口,不但能處理復(fù)雜的參數(shù)屡穗,還可以簡化調(diào)用者的代碼贴捡。
位置參數(shù)
我們先寫一個計算x2的函數(shù):
def power(x):
return x * x
對于power(x)
函數(shù),參數(shù)x
就是一個位置參數(shù)村砂。
當(dāng)我們調(diào)用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ù)祸轮,調(diào)用函數(shù)時,傳入的兩個值按照位置順序依次賦給參數(shù)x
和n
侥钳。
默認(rèn)參數(shù)
新的power(x, n)
函數(shù)定義沒有問題适袜,但是,舊的調(diào)用代碼失敗了舷夺,原因是我們增加了一個參數(shù)苦酱,導(dǎo)致舊的代碼因為缺少一個參數(shù)而無法正常調(diào)用:
>>> power(5)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: power() missing 1 required positional argument: 'n'
Python的錯誤信息很明確:調(diào)用函數(shù)power()
缺少了一個位置參數(shù)n
售貌。
這個時候,默認(rèn)參數(shù)就排上用場了疫萤。由于我們經(jīng)常計算x2颂跨,所以,完全可以把第二個參數(shù)n的默認(rèn)值設(shè)定為2:
def power(x, n=2):
s = 1
while n > 0:
n = n - 1
s = s * x
return s
這樣扯饶,當(dāng)我們調(diào)用power(5)
時恒削,相當(dāng)于調(diào)用power(5, 2)
:
>>> power(5)
25
>>> power(5, 2)
25
而對于n > 2
的其他情況,就必須明確地傳入n尾序,比如power(5, 3)
钓丰。
從上面的例子可以看出,默認(rèn)參數(shù)可以簡化函數(shù)的調(diào)用每币。設(shè)置默認(rèn)參數(shù)時携丁,有幾點要注意:
一是必選參數(shù)在前,默認(rèn)參數(shù)在后兰怠,否則Python的解釋器會報錯(思考一下為什么默認(rèn)參數(shù)不能放在必選參數(shù)前面)梦鉴;
二是如何設(shè)置默認(rèn)參數(shù)。
當(dāng)函數(shù)有多個參數(shù)時揭保,把變化大的參數(shù)放前面洒敏,變化小的參數(shù)放后面呜呐。變化小的參數(shù)就可以作為默認(rèn)參數(shù)用押。
使用默認(rèn)參數(shù)有什么好處诡渴?最大的好處是能降低調(diào)用函數(shù)的難度跟狱。
舉個例子蛮粮,我們寫個一年級小學(xué)生注冊的函數(shù)溅固,需要傳入name
和gender
兩個參數(shù):
def enroll(name, gender):
print('name:', name)
print('gender:', gender)
這樣有缆,調(diào)用enroll()
函數(shù)只需要傳入兩個參數(shù):
>>> enroll('Sarah', 'F')
name: Sarah
gender: F
如果要繼續(xù)傳入年齡名秀、城市等信息怎么辦励负?這樣會使得調(diào)用函數(shù)的復(fù)雜度大大增加。
我們可以把年齡和城市設(shè)為默認(rèn)參數(shù):
def enroll(name, gender, age=6, city='Beijing'):
print('name:', name)
print('gender:', gender)
print('age:', age)
print('city:', city)
這樣匕得,大多數(shù)學(xué)生注冊時不需要提供年齡和城市继榆,只提供必須的兩個參數(shù):
>>> enroll('Sarah', 'F')
name: Sarah
gender: F
age: 6
city: Beijing
只有與默認(rèn)參數(shù)不符的學(xué)生才需要提供額外的信息:
enroll('Bob', 'M', 7)
enroll('Adam', 'M', city='Tianjin')
可見,默認(rèn)參數(shù)降低了函數(shù)調(diào)用的難度汁掠,而一旦需要更復(fù)雜的調(diào)用時略吨,又可以傳遞更多的參數(shù)來實現(xiàn)。無論是簡單調(diào)用還是復(fù)雜調(diào)用考阱,函數(shù)只需要定義一個翠忠。
有多個默認(rèn)參數(shù)時,調(diào)用的時候乞榨,既可以按順序提供默認(rèn)參數(shù)秽之,比如調(diào)用enroll('Bob', 'M', 7)
当娱,意思是,除了name
考榨,gender
這兩個參數(shù)外跨细,最后1個參數(shù)應(yīng)用在參數(shù)age
上,city
參數(shù)由于沒有提供河质,仍然使用默認(rèn)值冀惭。
也可以不按順序提供部分默認(rèn)參數(shù)。當(dāng)不按順序提供部分默認(rèn)參數(shù)時愤诱,需要把參數(shù)名寫上云头。比如調(diào)用enroll('Adam', 'M', city='Tianjin')
,意思是淫半,city
參數(shù)用傳進去的值溃槐,其他默認(rèn)參數(shù)繼續(xù)使用默認(rèn)值。
默認(rèn)參數(shù)很有用科吭,但使用不當(dāng)昏滴,也會掉坑里。默認(rèn)參數(shù)有個最大的坑对人,演示如下:
先定義一個函數(shù)谣殊,傳入一個list,添加一個END
再返回:
def add_end(L=[]):
L.append('END')
return L
當(dāng)你正常調(diào)用時牺弄,結(jié)果似乎不錯:
>>> add_end([1, 2, 3])
[1, 2, 3, 'END']
>>> add_end(['x', 'y', 'z'])
['x', 'y', 'z', 'END']
當(dāng)你使用默認(rèn)參數(shù)調(diào)用時姻几,一開始結(jié)果也是對的:
>>> add_end()
['END']
但是,再次調(diào)用add_end()
時势告,結(jié)果就不對了:
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
很多初學(xué)者很疑惑蛇捌,默認(rèn)參數(shù)是[]
,但是函數(shù)似乎每次都“記住了”上次添加了'END'
后的list咱台。
原因解釋如下:
Python函數(shù)在定義的時候络拌,默認(rèn)參數(shù)L
的值就被計算出來了,即[]
回溺,因為默認(rèn)參數(shù)L
也是一個變量春贸,它指向?qū)ο?code>[],每次調(diào)用該函數(shù)遗遵,如果改變了L
的內(nèi)容萍恕,則下次調(diào)用時,默認(rèn)參數(shù)的內(nèi)容就變了车要,不再是函數(shù)定義時的[]
了雄坪。
定義默認(rèn)參數(shù)要牢記一點:默認(rèn)參數(shù)必須指向不變對象!
要修改上面的例子,我們可以用None
這個不變對象來實現(xiàn):
def add_end(L=None):
if L is None:
L = []
L.append('END')
return L
現(xiàn)在维哈,無論調(diào)用多少次绳姨,都不會有問題:
>>> add_end()
['END']
>>> add_end()
['END']
為什么要設(shè)計str
、None
這樣的不變對象呢阔挠?因為不變對象一旦創(chuàng)建飘庄,對象內(nèi)部的數(shù)據(jù)就不能修改,這樣就減少了由于修改數(shù)據(jù)導(dǎo)致的錯誤购撼。此外跪削,由于對象不變,多任務(wù)環(huán)境下同時讀取對象不需要加鎖迂求,同時讀一點問題都沒有碾盐。我們在編寫程序時,如果可以設(shè)計一個不變對象揩局,那就盡量設(shè)計成不變對象毫玖。
可變參數(shù)
在Python函數(shù)中,還可以定義可變參數(shù)凌盯。顧名思義付枫,可變參數(shù)就是傳入的參數(shù)個數(shù)是可變的,可以是1個驰怎、2個到任意個阐滩,還可以是0個。
我們以數(shù)學(xué)題為例子县忌,給定一組數(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
但是調(diào)用的時候翁逞,需要先組裝出一個list或tuple:
>>> calc([1, 2, 3])
14
>>> calc((1, 3, 5, 7))
84
如果利用可變參數(shù),調(diào)用函數(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ù)內(nèi)部浊竟,參數(shù)numbers
接收到的是一個tuple怨喘,因此津畸,函數(shù)代碼完全不變。但是必怜,調(diào)用該函數(shù)時肉拓,可以傳入任意個參數(shù),包括0個參數(shù):
>>> calc(1, 2)
5
>>> calc()
0
如果已經(jīng)有一個list或者tuple梳庆,要調(diào)用一個可變參數(shù)怎么辦暖途?可以這樣做:
>>> nums = [1, 2, 3]
>>> calc(nums[0], nums[1], nums[2])
14
這種寫法當(dāng)然是可行的,問題是太繁瑣膏执,所以Python允許你在list或tuple前面加一個*
號驻售,把list或tuple的元素變成可變參數(shù)傳進去:
>>> nums = [1, 2, 3]
>>> calc(*nums)
14
*nums
表示把nums
這個list的所有元素作為可變參數(shù)傳進去。這種寫法相當(dāng)有用更米,而且很常見欺栗。
關(guān)鍵字參數(shù)
可變參數(shù)允許你傳入0個或任意個參數(shù),這些可變參數(shù)在函數(shù)調(diào)用時自動組裝為一個tuple壳快。而關(guān)鍵字參數(shù)允許你傳入0個或任意個含參數(shù)名的參數(shù)纸巷,這些關(guān)鍵字參數(shù)在函數(shù)內(nèi)部自動組裝為一個dict。請看示例:
def person(name, age, **kw):
print('name:', name, 'age:', age, 'other:', kw)
函數(shù)person
除了必選參數(shù)name
和age
外眶痰,還接受關(guān)鍵字參數(shù)kw
瘤旨。在調(diào)用該函數(shù)時,可以只傳入必選參數(shù):
>>> person('Michael', 30)
name: Michael age: 30 other: {}
也可以傳入任意個數(shù)的關(guān)鍵字參數(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'}
關(guān)鍵字參數(shù)有什么用竖伯?它可以擴展函數(shù)的功能存哲。比如,在person
函數(shù)里七婴,我們保證能接收到name
和age
這兩個參數(shù)祟偷,但是,如果調(diào)用者愿意提供更多的參數(shù)打厘,我們也能收到修肠。試想你正在做一個用戶注冊的功能,除了用戶名和年齡是必填項外户盯,其他都是可選項嵌施,利用關(guān)鍵字參數(shù)來定義這個函數(shù)就能滿足注冊的需求。
和可變參數(shù)類似莽鸭,也可以先組裝出一個dict吗伤,然后,把該dict轉(zhuǎn)換為關(guān)鍵字參數(shù)傳進去:
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, city=extra['city'], job=extra['job'])
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
當(dāng)然硫眨,上面復(fù)雜的調(diào)用可以用簡化的寫法:
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, **extra)
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
**extra
表示把extra
這個dict的所有key-value用關(guān)鍵字參數(shù)傳入到函數(shù)的**kw
參數(shù)足淆,kw
將獲得一個dict,注意kw
獲得的dict是extra
的一份拷貝,對kw
的改動不會影響到函數(shù)外的extra
巧号。
命名關(guān)鍵字參數(shù)
對于關(guān)鍵字參數(shù)族奢,函數(shù)的調(diào)用者可以傳入任意不受限制的關(guān)鍵字參數(shù)。至于到底傳入了哪些裂逐,就需要在函數(shù)內(nèi)部通過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)
但是調(diào)用者仍可以傳入不受限制的關(guān)鍵字參數(shù):
>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)
如果要限制關(guān)鍵字參數(shù)的名字卜高,就可以用命名關(guān)鍵字參數(shù)弥姻,例如,只接收city
和job
作為關(guān)鍵字參數(shù)掺涛。這種方式定義的函數(shù)如下:
def person(name, age, *, city, job):
print(name, age, city, job)
和關(guān)鍵字參數(shù)**kw
不同庭敦,命名關(guān)鍵字參數(shù)需要一個特殊分隔符*
,*
后面的參數(shù)被視為命名關(guān)鍵字參數(shù)薪缆。
調(diào)用方式如下:
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
如果函數(shù)定義中已經(jīng)有了一個可變參數(shù)秧廉,后面跟著的命名關(guān)鍵字參數(shù)就不再需要一個特殊分隔符*
了:
def person(name, age, *args, city, job):
print(name, age, args, city, job)
命名關(guān)鍵字參數(shù)必須傳入?yún)?shù)名,這和位置參數(shù)不同拣帽。如果沒有傳入?yún)?shù)名疼电,調(diào)用將報錯:
>>> 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
由于調(diào)用時缺少參數(shù)名city
和job
,Python解釋器把這4個參數(shù)均視為位置參數(shù)减拭,但person()
函數(shù)僅接受2個位置參數(shù)蔽豺。
命名關(guān)鍵字參數(shù)可以有缺省值,從而簡化調(diào)用:
def person(name, age, *, city='Beijing', job):
print(name, age, city, job)
由于命名關(guān)鍵字參數(shù)city
具有默認(rèn)值拧粪,調(diào)用時修陡,可不傳入city
參數(shù):
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
使用命名關(guān)鍵字參數(shù)時,要特別注意可霎,如果沒有可變參數(shù)魄鸦,就必須加一個*
作為特殊分隔符。如果缺少*
癣朗,Python解釋器將無法識別位置參數(shù)和命名關(guān)鍵字參數(shù):
def person(name, age, city, job):
# 缺少 *拾因,city和job被視為位置參數(shù)
pass
參數(shù)組合
在Python中定義函數(shù),可以用必選參數(shù)旷余、默認(rèn)參數(shù)绢记、可變參數(shù)、關(guān)鍵字參數(shù)和命名關(guān)鍵字參數(shù)荣暮,這5種參數(shù)都可以組合使用。但是請注意罩驻,參數(shù)定義的順序必須是:必選參數(shù)穗酥、默認(rèn)參數(shù)、可變參數(shù)、命名關(guān)鍵字參數(shù)和關(guān)鍵字參數(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ù)調(diào)用的時候,Python解釋器自動按照參數(shù)位置和參數(shù)名把對應(yīng)的參數(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判耕,你也可以調(diào)用上述函數(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)
的形式調(diào)用它壁熄,無論它的參數(shù)是如何定義的。
雖然可以組合多達5種參數(shù)碳竟,但不要同時使用太多的組合草丧,否則函數(shù)接口的可理解性很差。
練習(xí)
以下函數(shù)允許計算兩個數(shù)的乘積莹桅,請稍加改造昌执,變成可接收一個或多個數(shù)并計算乘積:
def product(x, y):
return x * y
# 測試
print('product(5) =', product(5))
print('product(5, 6) =', product(5, 6))
print('product(5, 6, 7) =', product(5, 6, 7))
print('product(5, 6, 7, 9) =', product(5, 6, 7, 9))
if product(5) != 5:
print('測試失敗!')
elif product(5, 6) != 30:
print('測試失敗!')
elif product(5, 6, 7) != 210:
print('測試失敗!')
elif product(5, 6, 7, 9) != 1890:
print('測試失敗!')
else:
try:
product()
print('測試失敗!')
except TypeError:
print('測試成功!')
小結(jié)
Python的函數(shù)具有非常靈活的參數(shù)形態(tài),既可以實現(xiàn)簡單的調(diào)用诈泼,又可以傳入非常復(fù)雜的參數(shù)懂拾。
默認(rèn)參數(shù)一定要用不可變對象,如果是可變對象铐达,程序運行時會有邏輯錯誤岖赋!
要注意定義可變參數(shù)和關(guān)鍵字參數(shù)的語法:
*args
是可變參數(shù),args接收的是一個tuple娶桦;
**kw
是關(guān)鍵字參數(shù)贾节,kw接收的是一個dict。
以及調(diào)用函數(shù)時如何傳入可變參數(shù)和關(guān)鍵字參數(shù)的語法:
可變參數(shù)既可以直接傳入:func(1, 2, 3)
衷畦,又可以先組裝list或tuple栗涂,再通過*args
傳入:func(*(1, 2, 3))
;
關(guān)鍵字參數(shù)既可以直接傳入:func(a=1, b=2)
祈争,又可以先組裝dict斤程,再通過**kw
傳入:func(**{'a': 1, 'b': 2})
。
使用*args
和**kw
是Python的習(xí)慣寫法菩混,當(dāng)然也可以用其他參數(shù)名忿墅,但最好使用習(xí)慣用法。
命名的關(guān)鍵字參數(shù)是為了限制調(diào)用者可以傳入的參數(shù)名沮峡,同時可以提供默認(rèn)值疚脐。
定義命名的關(guān)鍵字參數(shù)在沒有可變參數(shù)的情況下不要忘了寫分隔符*,否則定義的將是位置參數(shù)邢疙。