定義函數(shù)的時(shí)候计寇,我們把參數(shù)的名字和位置確定下來(lái),函數(shù)的接口定義就完成了匙姜。對(duì)于函數(shù)的調(diào)用者來(lái)說(shuō)畅厢,只需要知道如何傳遞正確的參數(shù),以及函數(shù)將返回什么樣的值就夠了氮昧,函數(shù)內(nèi)部的復(fù)雜邏輯被封裝起來(lái)框杜,調(diào)用者無(wú)需了解。
Python的函數(shù)定義非常簡(jiǎn)單袖肥,但靈活度卻非常大咪辱。除了正常定義的必選參數(shù)外,還可以使用默認(rèn)參數(shù)昭伸、可變參數(shù)和關(guān)鍵字參數(shù)梧乘,使得函數(shù)定義出來(lái)的接口,不但能處理復(fù)雜的參數(shù)庐杨,還可以簡(jiǎn)化調(diào)用者的代碼选调。
位置參數(shù)
我們先寫一個(gè)計(jì)算x2的函數(shù):
def power(x):
return x * x
對(duì)于power(x)
函數(shù),參數(shù)x
就是一個(gè)位置參數(shù)灵份。
當(dāng)我們調(diào)用power
函數(shù)時(shí)仁堪,必須傳入有且僅有的一個(gè)參數(shù)x
:
>>> power(5)
25
>>> power(15)
225
現(xiàn)在,如果我們要計(jì)算x3怎么辦填渠?可以再定義一個(gè)power3
函數(shù)弦聂,但是如果要計(jì)算x4、x5……怎么辦氛什?我們不可能定義無(wú)限多個(gè)函數(shù)莺葫。
你也許想到了,可以把power(x)
修改為power(x, n)
枪眉,用來(lái)計(jì)算xn捺檬,說(shuō)干就干:
def power(x, n):
s = 1
while n > 0:
n = n - 1
s = s * x
return s
對(duì)于這個(gè)修改后的power(x, n)
函數(shù),可以計(jì)算任意n次方:
>>> power(5, 2)
25
>>> power(5, 3)
125
修改后的power(x, n)
函數(shù)有兩個(gè)參數(shù):x
和n
贸铜,這兩個(gè)參數(shù)都是位置參數(shù)堡纬,調(diào)用函數(shù)時(shí),傳入的兩個(gè)值按照位置順序依次賦給參數(shù)x
和n
蒿秦。
默認(rèn)參數(shù)
新的power(x, n)
函數(shù)定義沒(méi)有問(wèn)題烤镐,但是,舊的調(diào)用代碼失敗了棍鳖,原因是我們?cè)黾恿艘粋€(gè)參數(shù)炮叶,導(dǎo)致舊的代碼因?yàn)槿鄙僖粋€(gè)參數(shù)而無(wú)法正常調(diào)用:
>>> power(5)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: power() missing 1 required positional argument: 'n'
Python的錯(cuò)誤信息很明確:調(diào)用函數(shù)power()
缺少了一個(gè)位置參數(shù)n
。
這個(gè)時(shí)候渡处,默認(rèn)參數(shù)就排上用場(chǎng)了镜悉。由于我們經(jīng)常計(jì)算x2,所以骂蓖,完全可以把第二個(gè)參數(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)
時(shí),相當(dāng)于調(diào)用power(5, 2)
:
>>> power(5)
25
>>> power(5, 2)
25
而對(duì)于n > 2
的其他情況登下,就必須明確地傳入n茫孔,比如power(5, 3)
。
從上面的例子可以看出被芳,默認(rèn)參數(shù)可以簡(jiǎn)化函數(shù)的調(diào)用缰贝。設(shè)置默認(rèn)參數(shù)時(shí),有幾點(diǎn)要注意:
一是必選參數(shù)在前畔濒,默認(rèn)參數(shù)在后剩晴,否則Python的解釋器會(huì)報(bào)錯(cuò)(思考一下為什么默認(rèn)參數(shù)不能放在必選參數(shù)前面);
二是如何設(shè)置默認(rèn)參數(shù)。
當(dāng)函數(shù)有多個(gè)參數(shù)時(shí)赞弥,把經(jīng)常變的參數(shù)放前面毅整,不太變的參數(shù)放后面。變化小的參數(shù)就可以作為默認(rèn)參數(shù)绽左。
使用默認(rèn)參數(shù)有什么好處悼嫉?最大的好處是能降低調(diào)用函數(shù)的難度。
舉個(gè)例子拼窥,我們寫個(gè)一年級(jí)小學(xué)生注冊(cè)的函數(shù)戏蔑,需要傳入name
和gender
兩個(gè)參數(shù):
def enroll(name, gender):
print('name:', name)
print('gender:', gender)
這樣,調(diào)用enroll()
函數(shù)只需要傳入兩個(gè)參數(shù):
>>> enroll('Sarah', 'F')
name: Sarah
gender: F
如果要繼續(xù)傳入年齡鲁纠、城市等信息怎么辦总棵?這樣會(huì)使得調(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é)生注冊(cè)時(shí)不需要提供年齡和城市情龄,只提供必須的兩個(gè)參數(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í)刃唤,又可以傳遞更多的參數(shù)來(lái)實(shí)現(xiàn)。無(wú)論是簡(jiǎn)單調(diào)用還是復(fù)雜調(diào)用白群,函數(shù)只需要定義一個(gè)尚胞。
有多個(gè)默認(rèn)參數(shù)時(shí),調(diào)用的時(shí)候帜慢,既可以按順序提供默認(rèn)參數(shù)笼裳,比如調(diào)用enroll('Bob', 'M', 7)
,意思是粱玲,除了name
躬柬,gender
這兩個(gè)參數(shù)外,最后1個(gè)參數(shù)應(yīng)用在參數(shù)age
上抽减,city
參數(shù)由于沒(méi)有提供允青,仍然使用默認(rèn)值。
也可以不按順序提供部分默認(rèn)參數(shù)卵沉。當(dāng)不按順序提供部分默認(rèn)參數(shù)時(shí)颠锉,需要把參數(shù)名寫上。比如調(diào)用enroll('Adam', 'M', city='Tianjin')
史汗,意思是琼掠,city
參數(shù)用傳進(jìn)去的值,其他默認(rèn)參數(shù)繼續(xù)使用默認(rèn)值停撞。
默認(rèn)參數(shù)很有用瓷蛙,但使用不當(dāng),也會(huì)掉坑里。默認(rèn)參數(shù)有個(gè)最大的坑艰猬,演示如下:
先定義一個(gè)函數(shù)横堡,傳入一個(gè)list,添加一個(gè)END
再返回:
def add_end(L=[]):
L.append('END')
return L
當(dāng)你正常調(diào)用時(shí)姥宝,結(jié)果似乎不錯(cuò):
>>> 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)用時(shí)翅萤,一開始結(jié)果也是對(duì)的:
>>> add_end()
['END']
但是恐疲,再次調(diào)用add_end()
時(shí)腊满,結(jié)果就不對(duì)了:
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
很多初學(xué)者很疑惑,默認(rèn)參數(shù)是[]
培己,但是函數(shù)似乎每次都“記住了”上次添加了'END'
后的list碳蛋。
原因解釋如下:
Python函數(shù)在定義的時(shí)候,默認(rèn)參數(shù)L
的值就被計(jì)算出來(lái)了省咨,即[]
肃弟,因?yàn)槟J(rèn)參數(shù)L
也是一個(gè)變量,它指向?qū)ο?code>[]零蓉,每次調(diào)用該函數(shù)笤受,如果改變了L
的內(nèi)容,則下次調(diào)用時(shí)敌蜂,默認(rèn)參數(shù)的內(nèi)容就變了箩兽,不再是函數(shù)定義時(shí)的[]
了。
定義默認(rèn)參數(shù)要牢記一點(diǎn):默認(rèn)參數(shù)必須指向不變對(duì)象章喉!
要修改上面的例子汗贫,我們可以用None
這個(gè)不變對(duì)象來(lái)實(shí)現(xiàn):
def add_end(L=None):
if L is None:
L = []
L.append('END')
return L
現(xiàn)在,無(wú)論調(diào)用多少次秸脱,都不會(huì)有問(wèn)題:
>>> add_end()
['END']
>>> add_end()
['END']
為什么要設(shè)計(jì)str
落包、None
這樣的不變對(duì)象呢?因?yàn)椴蛔儗?duì)象一旦創(chuàng)建摊唇,對(duì)象內(nèi)部的數(shù)據(jù)就不能修改咐蝇,這樣就減少了由于修改數(shù)據(jù)導(dǎo)致的錯(cuò)誤。此外巷查,由于對(duì)象不變有序,多任務(wù)環(huán)境下同時(shí)讀取對(duì)象不需要加鎖蛉拙,同時(shí)讀一點(diǎn)問(wèn)題都沒(méi)有用狱。我們?cè)诰帉懗绦驎r(shí),如果可以設(shè)計(jì)一個(gè)不變對(duì)象捏题,那就盡量設(shè)計(jì)成不變對(duì)象髓需。
可變參數(shù)
在Python函數(shù)中许师,還可以定義可變參數(shù)。顧名思義,可變參數(shù)就是傳入的參數(shù)個(gè)數(shù)是可變的微渠,可以是1個(gè)搭幻、2個(gè)到任意個(gè),還可以是0個(gè)逞盆。
我們以數(shù)學(xué)題為例子檀蹋,給定一組數(shù)字a,b云芦,c……俯逾,請(qǐng)計(jì)算a2 + b2 + c2 + ……。
要定義出這個(gè)函數(shù)舅逸,我們必須確定輸入的參數(shù)桌肴。由于參數(shù)個(gè)數(shù)不確定,我們首先想到可以把a(bǔ)琉历,b坠七,c……作為一個(gè)list或tuple傳進(jìn)來(lái),這樣旗笔,函數(shù)可以定義如下:
def calc(numbers):
sum = 0
for n in numbers:
sum = sum + n * n
return sum
但是調(diào)用的時(shí)候彪置,需要先組裝出一個(gè)list或tuple:
>>> calc([1, 2, 3])
14
>>> calc((1, 3, 5, 7))
84
如果利用可變參數(shù),調(diào)用函數(shù)的方式可以簡(jiǎn)化成這樣:
>>> 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ù)和定義一個(gè)list或tuple參數(shù)相比拳魁,僅僅在參數(shù)前面加了一個(gè)*
號(hào)。在函數(shù)內(nèi)部艘包,參數(shù)numbers
接收到的是一個(gè)tuple的猛,因此,函數(shù)代碼完全不變想虎。但是卦尊,調(diào)用該函數(shù)時(shí),可以傳入任意個(gè)參數(shù)舌厨,包括0個(gè)參數(shù):
>>> calc(1, 2)
5
>>> calc()
0
如果已經(jīng)有一個(gè)list或者tuple岂却,要調(diào)用一個(gè)可變參數(shù)怎么辦?可以這樣做:
>>> nums = [1, 2, 3]
>>> calc(nums[0], nums[1], nums[2])
14
這種寫法當(dāng)然是可行的裙椭,問(wèn)題是太繁瑣躏哩,所以Python允許你在list或tuple前面加一個(gè)*
號(hào),把list或tuple的元素變成可變參數(shù)傳進(jìn)去:
>>> nums = [1, 2, 3]
>>> calc(*nums)
14
*nums
表示把nums
這個(gè)list的所有元素作為可變參數(shù)傳進(jìn)去揉燃。這種寫法相當(dāng)有用扫尺,而且很常見。
關(guān)鍵字參數(shù)
可變參數(shù)允許你傳入0個(gè)或任意個(gè)參數(shù)炊汤,這些可變參數(shù)在函數(shù)調(diào)用時(shí)自動(dòng)組裝為一個(gè)tuple正驻。而關(guān)鍵字參數(shù)允許你傳入0個(gè)或任意個(gè)含參數(shù)名的參數(shù)弊攘,這些關(guān)鍵字參數(shù)在函數(shù)內(nèi)部自動(dòng)組裝為一個(gè)dict。請(qǐng)看示例:
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í),可以只傳入必選參數(shù):
>>> person('Michael', 30)
name: Michael age: 30 other: {}
也可以傳入任意個(gè)數(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ù)有什么用伤靠?它可以擴(kuò)展函數(shù)的功能捣域。比如,在person
函數(shù)里宴合,我們保證能接收到name
和age
這兩個(gè)參數(shù)焕梅,但是,如果調(diào)用者愿意提供更多的參數(shù)形纺,我們也能收到丘侠。試想你正在做一個(gè)用戶注冊(cè)的功能,除了用戶名和年齡是必填項(xiàng)外逐样,其他都是可選項(xiàng),利用關(guān)鍵字參數(shù)來(lái)定義這個(gè)函數(shù)就能滿足注冊(cè)的需求打肝。
和可變參數(shù)類似脂新,也可以先組裝出一個(gè)dict,然后粗梭,把該dict轉(zhuǎn)換為關(guān)鍵字參數(shù)傳進(jìn)去:
>>> 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)用可以用簡(jiǎn)化的寫法:
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, **extra)
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
**extra
表示把extra
這個(gè)dict的所有key-value用關(guān)鍵字參數(shù)傳入到函數(shù)的**kw
參數(shù),kw
將獲得一個(gè)dict断医,注意kw
獲得的dict是extra
的一份拷貝滞乙,對(duì)kw
的改動(dòng)不會(huì)影響到函數(shù)外的extra
。
命名關(guān)鍵字參數(shù)
對(duì)于關(guān)鍵字參數(shù)鉴嗤,函數(shù)的調(diào)用者可以傳入任意不受限制的關(guān)鍵字參數(shù)斩启。至于到底傳入了哪些,就需要在函數(shù)內(nèi)部通過(guò)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ù)需要一個(gè)特殊分隔符*
狸窘,*
后面的參數(shù)被視為命名關(guān)鍵字參數(shù)。
調(diào)用方式如下:
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
如果函數(shù)定義中已經(jīng)有了一個(gè)可變參數(shù)坯认,后面跟著的命名關(guān)鍵字參數(shù)就不再需要一個(gè)特殊分隔符*
了:
def person(name, age, *args, city, job):
print(name, age, args, city, job)
命名關(guān)鍵字參數(shù)必須傳入?yún)?shù)名翻擒,這和位置參數(shù)不同介杆。如果沒(méi)有傳入?yún)?shù)名,調(diào)用將報(bào)錯(cuò):
>>> 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í)缺少參數(shù)名city
和job
韭寸,Python解釋器把這4個(gè)參數(shù)均視為位置參數(shù)春哨,但person()
函數(shù)僅接受2個(gè)位置參數(shù)。
命名關(guān)鍵字參數(shù)可以有缺省值恩伺,從而簡(jiǎn)化調(diào)用:
def person(name, age, *, city='Beijing', job):
print(name, age, city, job)
由于命名關(guān)鍵字參數(shù)city
具有默認(rèn)值赴背,調(diào)用時(shí),可不傳入city
參數(shù):
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
使用命名關(guān)鍵字參數(shù)時(shí)晶渠,要特別注意凰荚,如果沒(méi)有可變參數(shù),就必須加一個(gè)*
作為特殊分隔符褒脯。如果缺少*
便瑟,Python解釋器將無(wú)法識(shí)別位置參數(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ù)都可以組合使用。但是請(qǐng)注意沉御,參數(shù)定義的順序必須是:必選參數(shù)屿讽、默認(rèn)參數(shù)、可變參數(shù)吠裆、命名關(guān)鍵字參數(shù)和關(guān)鍵字參數(shù)伐谈。
比如定義一個(gè)函數(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)用的時(shí)候试疙,Python解釋器自動(dòng)按照參數(shù)位置和參數(shù)名把對(duì)應(yīng)的參數(shù)傳進(jìn)去诵棵。
>>> 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}
最神奇的是通過(guò)一個(gè)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': '#'}
所以效斑,對(duì)于任意函數(shù)非春,都可以通過(guò)類似func(*args, **kw)
的形式調(diào)用它,無(wú)論它的參數(shù)是如何定義的缓屠。