函式引數(預設引數、可變引數、關鍵字引數)
原文地址:https://www.cnblogs.com/mingshengling/p/7842826.html
1、預設引數
預設引數降低了函式呼叫的難度,而一旦需要更復雜的呼叫時,又可以傳遞更多的引數來實現。無論是簡單呼叫還是複雜呼叫,函式只需要定義一個。
有多個預設引數時,呼叫的時候,既可以按順序提供預設引數,比如呼叫enroll('Bob', 'M', 7)
,意思是,除了name
,gender
這兩個引數外,最後1個引數應用在引數age
上,city
引數由於沒有提供,仍然使用預設值。
也可以不按順序提供部分預設引數。當不按順序提供部分預設引數時,需要把引數名寫上。比如呼叫enroll('Adam', 'M', city='Tianjin')
city
引數用傳進去的值,其他預設引數繼續使用預設值。
預設引數很有用,但使用不當,也會掉坑裡。預設引數有個最大的坑,演示如下:
先定義一個函式,傳入一個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']
當你使用預設引數呼叫時,一開始結果也是對的:
>>> add_end()
['END']
但是,再次呼叫add_end()
時,結果就不對了:
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
很多初學者很疑惑,預設引數是[]
,但是函式似乎每次都“記住了”上次添加了'END'
後的list。
原因解釋如下:
Python函式在定義的時候,預設引數L
的值就被計算出來了,即[]
,因為預設引數L
也是一個變數,它指向物件[]
,每次呼叫該函式,如果改變了L
的內容,則下次呼叫時,預設引數的內容就變了,不再是函式定義時的[]
所以,定義預設引數要牢記一點:預設引數必須指向不變物件!
要修改上面的例子,我們可以用None
這個不變物件來實現:
def add_end(L=None):
if L is None: L = [] L.append('END') return L
現在,無論呼叫多少次,都不會有問題:
>>> add_end()
['END']
>>> add_end()
['END']
為什麼要設計str
、None
這樣的不變物件呢?因為不變物件一旦建立,物件內部的資料就不能修改,這樣就減少了由於修改資料導致的錯誤。此外,由於物件不變,多工環境下同時讀取物件不需要加鎖,同時讀一點問題都沒有。我們在編寫程式時,如果可以設計一個不變物件,那就儘量設計成不變物件。
2、可變引數
在Python函式中,還可以定義可變引數。顧名思義,可變引數就是傳入的引數個數是可變的,可以是1個、2個到任意個,還可以是0個。
我們以數學題為例子,給定一組數字a,b,c……,請計算a2 + b2 + c2 + ……。
要定義出這個函式,我們必須確定輸入的引數。由於引數個數不確定,我們首先想到可以把a,b,c……作為一個list或tuple傳進來,這樣,函式可以定義如下:
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
如果利用可變引數,呼叫函式的方式可以簡化成這樣:
>>> calc(1, 2, 3)
14 >>> calc(1, 3, 5, 7) 84
所以,我們把函式的引數改為可變引數:
def calc(*numbers):
sum = 0 for n in numbers: sum = sum + n * n return sum
定義可變引數和定義一個list或tuple引數相比,僅僅在引數前面加了一個*
號。在函式內部,引數numbers
接收到的是一個tuple,因此,函式程式碼完全不變。但是,呼叫該函式時,可以傳入任意個引數,包括0個引數:
>>> calc(1, 2)
5
>>> calc() 0
如果已經有一個list或者tuple,要呼叫一個可變引數怎麼辦?可以這樣做:
>>> nums = [1, 2, 3]
>>> calc(nums[0], nums[1], nums[2]) 14
這種寫法當然是可行的,問題是太繁瑣,所以Python允許你在list或tuple前面加一個*
號,把list或tuple的元素變成可變引數傳進去:
>>> nums = [1, 2, 3]
>>> calc(*nums) 14
*nums
表示把nums
這個list的所有元素作為可變引數傳進去。這種寫法相當有用,而且很常見。
3、關鍵字引數
可變引數允許你傳入0個或任意個引數,這些可變引數在函式呼叫時自動組裝為一個tuple。而關鍵字引數允許你傳入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'}
**extra
表示把extra
這個dict的所有key-value用關鍵字引數傳入到函式的**kw
引數,kw
將獲得一個dict,注意kw
獲得的dict是extra
的一份拷貝,對kw
的改動不會影響到函式外的extra
。
4、命名關鍵字引數
對於關鍵字引數,函式的呼叫者可以傳入任意不受限制的關鍵字引數。至於到底傳入了哪些,就需要在函式內部通過kw
檢查。
仍以person()
函式為例,我們希望檢查是否有city
和job
引數:
def person(name, age, **kw):
if 'city' in kw: # 有city引數 pass if 'job' in kw: # 有job引數 pass print('name:', name, 'age:', age, 'other:', kw)
但是呼叫者仍可以傳入不受限制的關鍵字引數:
>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)
如果要限制關鍵字引數的名字,就可以用命名關鍵字引數,例如,只接收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直譯器將無法識別位置引數和命名關鍵字引數:
def person(name, age, city, job):
# 缺少 *,city和job被視為位置引數 pass
5、引數組合
在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的習慣寫法,當然也可以用其他引數名,但最好使用習慣用法。
命名的關鍵字引數是為了限制呼叫者可以傳入的引數名,同時可以提供預設值。
定義命名的關鍵字引數在沒有可變引數的情況下不要忘了寫分隔符*
,否則定義的將是位置引數。
1、預設引數
預設引數降低了函式呼叫的難度,而一旦需要更復雜的呼叫時,又可以傳遞更多的引數來實現。無論是簡單呼叫還是複雜呼叫,函式只需要定義一個。
有多個預設引數時,呼叫的時候,既可以按順序提供預設引數,比如呼叫enroll('Bob', 'M', 7)
,意思是,除了name
,gender
這兩個引數外,最後1個引數應用在引數age
上,city
引數由於沒有提供,仍然使用預設值。
也可以不按順序提供部分預設引數。當不按順序提供部分預設引數時,需要把引數名寫上。比如呼叫enroll('Adam', 'M', city='Tianjin')
,意思是,city
引數用傳進去的值,其他預設引數繼續使用預設值。
預設引數很有用,但使用不當,也會掉坑裡。預設引數有個最大的坑,演示如下:
先定義一個函式,傳入一個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']
當你使用預設引數呼叫時,一開始結果也是對的:
>>> add_end()
['END']
但是,再次呼叫add_end()
時,結果就不對了:
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
很多初學者很疑惑,預設引數是[]
,但是函式似乎每次都“記住了”上次添加了'END'
後的list。
原因解釋如下:
Python函式在定義的時候,預設引數L
的值就被計算出來了,即[]
,因為預設引數L
也是一個變數,它指向物件[]
,每次呼叫該函式,如果改變了L
的內容,則下次呼叫時,預設引數的內容就變了,不再是函式定義時的[]
了。
所以,定義預設引數要牢記一點:預設引數必須指向不變物件!
要修改上面的例子,我們可以用None
這個不變物件來實現:
def add_end(L=None):
if L is None: L = [] L.append('END') return L
現在,無論呼叫多少次,都不會有問題:
>>> add_end()
['END']
>>> add_end()
['END']
為什麼要設計str
、None
這樣的不變物件呢?因為不變物件一旦建立,物件內部的資料就不能修改,這樣就減少了由於修改資料導致的錯誤。此外,由於物件不變,多工環境下同時讀取物件不需要加鎖,同時讀一點問題都沒有。我們在編寫程式時,如果可以設計一個不變物件,那就儘量設計成不變物件。
2、可變引數
在Python函式中,還可以定義可變引數。顧名思義,可變引數就是傳入的引數個數是可變的,可以是1個、2個到任意個,還可以是0個。
我們以數學題為例子,給定一組數字a,b,c……,請計算a2 + b2 + c2 + ……。
要定義出這個函式,我們必須確定輸入的引數。由於引數個數不確定,我們首先想到可以把a,b,c……作為一個list或tuple傳進來,這樣,函式可以定義如下:
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
如果利用可變引數,呼叫函式的方式可以簡化成這樣:
>>> calc(1, 2, 3)
14 >>> calc(1, 3, 5, 7) 84
所以,我們把函式的引數改為可變引數:
def calc(*numbers):
sum = 0 for n in numbers: sum = sum + n * n return sum
定義可變引數和定義一個list或tuple引數相比,僅僅在引數前面加了一個*
號。在函式內部,引數numbers
接收到的是一個tuple,因此,函式程式碼完全不變。但是,呼叫該函式時,可以傳入任意個引數,包括0個引數:
>>> calc(1, 2)
5
>>> calc() 0
如果已經有一個list或者tuple,要呼叫一個可變引數怎麼辦?可以這樣做:
>>> nums = [1, 2, 3]
>>> calc(nums[0], nums[1], nums[2]) 14
這種寫法當然是可行的,問題是太繁瑣,所以Python允許你在list或tuple前面加一個*
號,把list或tuple的元素變成可變引數傳進去:
>>> nums = [1, 2, 3]
>>> calc(*nums) 14
*nums
表示把nums
這個list的所有元素作為可變引數傳進去。這種寫法相當有用,而且很常見。
3、關鍵字引數
可變引數允許你傳入0個或任意個引數,這些可變引數在函式呼叫時自動組裝為一個tuple。而關鍵字引數允許你傳入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'}
**extra
表示把extra
這個dict的所有key-value用關鍵字引數傳入到函式的**kw
引數,kw
將獲得一個dict,注意kw
獲得的dict是extra
的一份拷貝,對kw
的改動不會影響到函式外的extra
。
4、命名關鍵字引數
對於關鍵字引數,函式的呼叫者可以傳入任意不受限制的關鍵字引數。至於到底傳入了哪些,就需要在函式內部通過kw
檢查。
仍以person()
函式為例,我們希望檢查是否有city
和job
引數:
def person(name, age, **kw):
if 'city' in kw: # 有city引數 pass if 'job' in kw: # 有job引數 pass print('name:', name, 'age:', age, 'other:', kw)
但是呼叫者仍可以傳入不受限制的關鍵字引數:
>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)
如果要限制關鍵字引數的名字,就可以用命名關鍵字引數,例如,只接收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直譯器將無法識別位置引數和命名關鍵字引數:
def person(name, age, city, job):
# 缺少 *,city和job被視為位置引數 pass
5、引數組合
在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的習慣寫法,當然也可以用其他引數名,但最好使用習慣用法。
命名的關鍵字引數是為了限制呼叫者可以傳入的引數名,同時可以提供預設值。
定義命名的關鍵字引數在沒有可變引數的情況下不要忘了寫分隔符*
,否則定義的將是位置引數。