注:本文部分內容來自廖雪峯的Python教程,部分內容來自網上搜索,部分內容由自己編寫。
函數(一)
位置參數、默認參數適合用於預先已知需要的參數的個數;
可變參數、關鍵字參數適合用於不知參數個數的情況。
一、位置參數
func(X,X):固定參數個數,參數類型是否出錯看定義函數的內容。
我們先寫一個計算x2的函數:
def power(x):
return x * x
對於power(x)
函數,參數x
就是一個位置參數。
當我們調用power
函數時,必須傳入有且僅有的一個參數x
:
>>> power(5)
25
>>> power(15)
225
現在,如果我們要計算x3怎麼辦?可以再定義一個power3
函數,但是如果要計算x4、x5……怎麼辦?我們不可能定義無限多個函數。
你也許想到了,可以把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)
函數,可以計算任意n次方:
>>> power(5, 2)
25
>>> power(5, 3)
125
修改後的power(x, n)
函數有兩個參數:x
和n
,這兩個參數都是位置參數,調用函數時,傳入的兩個值按照位置順序依次賦給參數x
和n
。
二、默認參數
新的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
。
這個時候,默認參數就排上用場了。由於我們經常計算x2,所以,完全可以把第二個參數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
參數用傳進去的值,其他默認參數繼續使用默認值。
PS:默認參數必須是不可變對象(str、none等)。
三、可變參數
可變參數:允許你傳入0個或任意個參數,這些可變參數在函數調用時自動組裝爲一個tuple。
例子:
def funcD(a, b, *c):
print a
print b
print("length of c is: %d " % len(c))
print c
調用結果如下:
1四、關鍵字參數
2
length of c is: 4
(3, 4, 5, 6)
關鍵字參數:允許你傳入0個或任意個含參數名的參數,這些關鍵字參數在函數內部自動組裝爲一個dict。
def person(name, age, **kw):
print('name:', name, 'age:', age, 'other:', kw)
函數person
除了必選參數name
和age
外,還接受關鍵字參數kw
。在調用該函數時,可以只傳入必選參數:
>>> person('Michael', 30)
name: Michael age: 30 other: {}
也可以傳入任意個數的關鍵字參數:
>>> 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'}
關鍵字參數有什麼用?它可以擴展函數的功能。比如,在person
函數裏,我們保證能接收到name
和age
這兩個參數,但是,如果調用者願意提供更多的參數,我們也能收到。試想你正在做一個用戶註冊的功能,除了用戶名和年齡是必填項外,其他都是可選項,利用關鍵字參數來定義這個函數就能滿足註冊的需求。
和可變參數類似,也可以先組裝出一個dict,然後,把該dict轉換爲關鍵字參數傳進去:
>>> 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'}
五、命名關鍵字參數
注意:如果參數沒有可變參數,所以必須要在命名關鍵字參數前加上“*”號,否則會被當做位置參數對待。
如果要限制關鍵字參數的名字,就可以用命名關鍵字參數,例如,只接收city
和job
作爲關鍵字參數。這種方式定義的函數如下:
def person(name, age, *, city, job):
print(name, age, city, job)
和關鍵字參數**kw
不同,命名關鍵字參數需要一個特殊分隔符*
,*
後面的參數被視爲命名關鍵字參數。
調用方式如下:
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
如果函數定義中已經有了一個可變參數,後面跟着的命名關鍵字參數就不再需要一個特殊分隔符*
了:
def person(name, age, *args, city, job):
print(name, age, args, city, job)
命名關鍵字參數必須傳入參數名,這和位置參數不同。如果沒有傳入參數名,調用將報錯:
>>> 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
由於調用時缺少參數名city
和job
,Python解釋器把這4個參數均視爲位置參數,但person()
函數僅接受2個位置參數。
命名關鍵字參數可以有缺省值,從而簡化調用:
def person(name, age, *, city='Beijing', job):
print(name, age, city, job)
由於命名關鍵字參數city
具有默認值,調用時,可不傳入city
參數:
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
六、參數組合
在Python中定義函數,可以用必選參數、默認參數、可變參數、關鍵字參數和命名關鍵字參數,這5種參數都可以組合使用。但是請注意,參數定義的順序必須是:必選參數、默認參數、可變參數、命名關鍵字參數和關鍵字參數。
比如定義一個函數,包含上述若干種參數:
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)
在函數調用的時候,Python解釋器自動按照參數位置和參數名把對應的參數傳進去。
>>> 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,你也可以調用上述函數:
>>> 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': '#'}
所以,對於任意函數,都可以通過類似func(*args, **kw)
的形式調用它,無論它的參數是如何定義的。
小結
Python的函數具有非常靈活的參數形態,既可以實現簡單的調用,又可以傳入非常複雜的參數。
默認參數一定要用不可變對象,如果是可變對象,程序運行時會有邏輯錯誤!
要注意定義可變參數和關鍵字參數的語法:
*args
是可變參數,args接收的是一個tuple;
**kw
是關鍵字參數,kw接收的是一個dict。
以及調用函數時如何傳入可變參數和關鍵字參數的語法:
可變參數既可以直接傳入:func(1, 2, 3)
,又可以先組裝list或tuple,再通過*args
傳入:func(*(1,
2, 3))
;
關鍵字參數既可以直接傳入:func(a=1, b=2)
,又可以先組裝dict,再通過**kw
傳入:func(**{'a':
1, 'b': 2})
。
使用*args
和**kw
是Python的習慣寫法,當然也可以用其他參數名,但最好使用習慣用法。
命名的關鍵字參數是爲了限制調用者可以傳入的參數名,同時可以提供默認值。
定義命名的關鍵字參數在沒有可變參數的情況下不要忘了寫分隔符*
,否則定義的將是位置參數。