5.3 函數(shù)的參數(shù)
定義函數(shù)的時(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ù)
我們先寫一個(gè)計(jì)算x2的函數(shù):
def power(x):
? ?return x * x
對于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……怎么辦?我們不可能定義無限多個(gè)函數(shù)。
你也許想到了,可以把power(x)
修改為power(x, n)
,用來計(jì)算xn,說干就干:
def power(x, n):
? ?s = 1
? ?while n > 0:
?? ? ? n = n - 1
? ? ? ?s = s * x
?? ?return s
對于這個(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ù)定義沒有問題,但是,舊的調(diào)用代碼失敗了,原因是我們增加了一個(gè)參數(shù),導(dǎo)致舊的代碼因?yàn)槿鄙僖粋€(gè)參數(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的錯(cuò)誤信息很明確:調(diào)用函數(shù)power()
缺少了一個(gè)位置參數(shù)n
。
這個(gè)時(shí)候,默認(rèn)參數(shù)就排上用場了。由于我們經(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
而對于n > 2
的其他情況,就必須明確地傳入n,比如power(5, 3)
。
從上面的例子可以看出,默認(rèn)參數(shù)可以簡化函數(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í),把變化大的參數(shù)放前面,變化小的參數(shù)放后面。變化小的參數(shù)就可以作為默認(rèn)參數(shù)。
使用默認(rèn)參數(shù)有什么好處?最大的好處是能降低調(diào)用函數(shù)的難度。
舉個(gè)例子,我們寫個(gè)一年級小學(xué)生注冊的函數(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é)生注冊時(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ù)來實(shí)現(xià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ù)由于沒有提供,仍然使用默認(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é)果也是對的:
>>> add_end()
['END']
但是,再次調(diào)用add_end()
時(shí),結(jié)果就不對了:
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
很多初學(xué)者很疑惑,默認(rèn)參數(shù)是[]
,但是函數(shù)似乎每次都“記住了”上次添加了'END'
后的list。
原因解釋如下:
Python函數(shù)在定義的時(shí)候,默認(rèn)參數(shù)L
的值就被計(jì)算出來了,即[]
,因?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ù)必須指向不變對象!
要修改上面的例子,我們可以用None
這個(gè)不變對象來實(shí)現(xiàn):
def add_end(L=None):
? ?if L is None:
? ? ? ?L = []
? ?L.append('END')
? ?return L
現(xiàn)在,無論調(diào)用多少次,都不會(huì)有問題:
>>> add_end()
['END']
>>> add_end()
['END']
為什么要設(shè)計(jì)str
、None
這樣的不變對象呢?因?yàn)椴蛔儗ο笠坏﹦?chuàng)建,對象內(nèi)部的數(shù)據(jù)就不能修改,這樣就減少了由于修改數(shù)據(jù)導(dǎo)致的錯(cuò)誤。此外,由于對象不變,多任務(wù)環(huán)境下同時(shí)讀取對象不需要加鎖,同時(shí)讀一點(diǎn)問題都沒有。我們在編寫程序時(shí),如果可以設(shè)計(jì)一個(gè)不變對象,那就盡量設(shè)計(jì)成不變對象。
可變參數(shù)
在Python函數(shù)中,還可以定義可變參數(shù)。顧名思義,可變參數(shù)就是傳入的參數(shù)個(gè)數(shù)是可變的,可以是1個(gè)、2個(gè)到任意個(gè),還可以是0個(gè)。
我們以數(shù)學(xué)題為例子,給定一組數(shù)字a,b,c……,請計(jì)算a2?+ b2?+ c2?+ ……。
要定義出這個(gè)函數(shù),我們必須確定輸入的參數(shù)。由于參數(shù)個(gè)數(shù)不確定,我們首先想到可以把a(bǔ),b,c……作為一個(gè)list或tuple傳進(jìn)來,這樣,函數(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ù)的方式可以簡化成這樣:
>>> 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è)*
號。在函數(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)然是可行的,問題是太繁瑣,所以Python允許你在list或tuple前面加一個(gè)*
號,把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。請看示例:
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è)用戶注冊的功能,除了用戶名和年齡是必填項(xiàng)外,其他都是可選項(xiàng),利用關(guān)鍵字參數(shù)來定義這個(gè)函數(shù)就能滿足注冊的需求。
和可變參數(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)用可以用簡化的寫法:
>>> 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
的一份拷貝,對kw
的改動(dòng)不會(huì)影響到函數(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ù)需要一個(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ù)不同。如果沒有傳入?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() missing 2 required keyword-only arguments: 'city' and 'job'
由于調(diào)用時(shí)缺少參數(shù)名city
和job
,Python解釋器把前兩個(gè)參數(shù)視為位置參數(shù),后兩個(gè)參數(shù)傳給*args
,但缺少命名關(guān)鍵字參數(shù)導(dǎo)致報(bào)錯(cuò)。
命名關(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)用時(shí),可不傳入city
參數(shù):
>>> person('Jack', 24, job='Engineer')?
Jack 24 Beijing Engineer
使用命名關(guān)鍵字參數(shù)時(shí),要特別注意,如果沒有可變參數(shù),就必須加一個(gè)*
作為特殊分隔符。如果缺少*
,Python解釋器將無法識(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ù)都可以組合使用。但是請注意,參數(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ù)名把對應(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}
最神奇的是通過一個(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': '#'}
所以,對于任意函數(shù),都可以通過類似func(*args, **kw)
的形式調(diào)用它,無論它的參數(shù)是如何定義的。
?雖然可以組合多達(dá)5種參數(shù),但不要同時(shí)使用太多的組合,否則函數(shù)接口的可理解性很差。
小結(jié)
Python的函數(shù)具有非常靈活的參數(shù)形態(tài),既可以實(shí)現(xiàn)簡單的調(diào)用,又可以傳入非常復(fù)雜的參數(shù)。
默認(rèn)參數(shù)一定要用不可變對象,如果是可變對象,程序運(yùn)行時(shí)會(huì)有邏輯錯(cuò)誤!
要注意定義可變參數(shù)和關(guān)鍵字參數(shù)的語法:
*args
是可變參數(shù),args接收的是一個(gè)tuple;**kw
是關(guān)鍵字參數(shù),kw接收的是一個(gè)dict。以及調(diào)用函數(shù)時(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ù)名,同時(shí)可以提供默認(rèn)值。
定義命名的關(guān)鍵字參數(shù)在沒有可變參數(shù)的情況下不要忘了寫分隔符
*
,否則定義的將是位置參數(shù)。