寫在前面
如非特別說明效床,下文均基于
Python3
Python進階-函數默認參數
一、默認參數
python為了簡化函數的調用拉一,提供了默認參數機制:
def pow(x, n = 2):
r = 1
while n > 0:
r *= x
n -= 1
return r
這樣在調用pow
函數時矫夯,就可以省略最后一個參數不寫:
print(pow(5)) # output: 25
在定義有默認參數的函數時,需要注意以下:
- 必選參數必須在前面,默認參數在后测蘑;
- 設置何種參數為默認參數灌危?一般來說,將參數值變化小的設置為默認參數碳胳。
python標準庫實踐
python內建函數:
print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)
函數簽名可以看出勇蝙,使用print('hello python')
這樣的簡單調用的打印語句,實際上傳入了許多默認值挨约,默認參數使得函數的調用變得非常簡單味混。
二、一個坑诫惭?
引用一個官方的經典示例地址 :
def bad_append(new_item, a_list=[]):
a_list.append(new_item)
return a_list
print(bad_append('1'))
print(bad_append('2'))
這個示例并沒有按照預期打游涛:
['1']
['2']
而是打印了:
['1']
['1', '2']
其實這個錯誤問題不在默認參數上,而是我們對于及默認參數的初始化的理解有誤夕土。
三馆衔、函數初始化
按照Python
哲學:
一切皆對象
函數也是一個對象,如下示例:
import types
def test():
pass
print(type(test)) # <class 'function'>
print(isinstance(test, types.FunctionType)) # True
如此怨绣,函數就是類types.FunctionType
或者其子類的實例對象角溃。那么對象必然有其初始化的時候,一般來說篮撑,解釋器在讀到函數末尾時完成函數實例的初始化减细。初始化后,就有了函數名到函數對象這樣一個映射關系赢笨,可以通過函數名訪問到函數對象了邪财,并且,函數的一切屬性也確定下來质欲,包括所需的參數树埠,默認參數的值。因此每次調用函數時嘶伟,默認參數值是相同的(如果有默認參數)怎憋。
我們以一個直觀的例子來說明:
import datetime as dt
from time import sleep
def log_time(msg, time=dt.datetime.now()):
sleep(1) # 線程暫停一秒
print("%s: %s" % (time.isoformat(), msg))
log_time('msg 1')
log_time('msg 2')
log_time('msg 3')
運行這個程序,得到的輸出是:
2017-05-17T12:23:46.327258: msg 1
2017-05-17T12:23:46.327258: msg 2
2017-05-17T12:23:46.327258: msg 3
即使使用了sleep(1)
讓線程暫停一秒九昧,排除了程序執(zhí)行很快的因素绊袋。輸出中三次調用打印出的時間還是相同的,即三次調用中默認參數time
的值是相同的铸鹰。
上面的示例或許還不能完全說明問題癌别,以下通過觀察默認參數的內存地址的方式來說明。
首先需要了解內建函數id(object)
:
id(object)
Return the “identity” of an object. This is an integer which is guaranteed to be unique and constant for this object during its lifetime. Two objects with non-overlapping lifetimes may have the same id() value.
CPython implementation detail: This is the address of the object in memory.
即id(object)
函數返回一個對象的唯一標識蹋笼。這個標識是一個在對象的生命周期期間保證唯一并且不變的整數展姐。在重疊的生命周期中躁垛,兩個對象可能有相同的id值。
在CPython
解釋器實現(xiàn)中圾笨,id(object)
的值為對象的內存地址教馆。
如下示例使用id(object)
函數清楚說明了問題:
def bad_append(new_item, a_list=[]):
print('address of a_list:', id(a_list))
a_list.append(new_item)
return a_list
print(bad_append('1'))
print(bad_append('2'))
output:
address of a_list: 31128072
['1']
address of a_list: 31128072
['1', '2']
兩次調用bad_append
,默認參數a_list
的地址是相同的擂达。
而且a_list
是可變對象土铺,使用append
方法添加新元素并不會造成list
對象的重新創(chuàng)建,地址的重新分配板鬓。這樣悲敷,‘恰好’就在默認參數指向的地址處修改了對象,下一次調用再次使用這個地址時俭令,就可以看到上一次的修改了后德。
那么,出現(xiàn)上述的輸出就不奇怪了唤蔗,因為它們本來就是指向同一內存地址探遵。
四、可變與不可變
當默認參數指向可變類型對象和不可變類型對象時妓柜,會表現(xiàn)出不同的行為箱季。
可變默認參數 的表現(xiàn)就像上訴示例一樣。
不可變默認參數
首先看一個示例:
def immutable_test(i = 1):
print('before operation, address of i', id(i))
i += 1
print('after operation, address of i', id(i))
return i
print(immutable_test())
print(immutable_test())
Output:
before operation, address of i 1470514832
after operation, address of i 1470514848
2
before operation, address of i 1470514832
after operation, address of i 1470514848
2
很明顯棍掐,第二次調用時默認參數i
的值不會受第一次調用的影響藏雏。因為i
指向的是不可變對象,對i
的操作會造成內存重新分配作煌,對象重新創(chuàng)建掘殴,那么函數中i += 1
之后名字i
指向了另外的地址;根據默認參數的規(guī)則粟誓,下次調用時奏寨,i
指向的地址還是函數定義時賦予的地址,這個地址的值1
并沒有被改變鹰服。
其實病瞳,可變默認參數和不可變默認參數放在這里討論并沒太大的價值,就像其他語言中所謂的值傳遞還是引用傳遞
一樣悲酷,不只會對默認參數造成影響套菜。
五、最佳實踐
不可變的默認參數的多次調用不會造成任何影響设易,可變默認參數的多次調用的結果不符合預期逗柴。那么在使用可變默認參數時,就不能只在函數定義時初始化一次顿肺,而應該在每次調用時初始化戏溺。
最佳實踐是定義函數時指定可變默認參數的值為None
渣蜗,在函數體內部重新綁定默認參數的值。以下是對上面的兩個可變默認參數示例最佳實踐的應用:
def good_append(new_item, a_list = None):
if a_list is None:
a_list = []
a_list.append(new_item)
return a_list
print(good_append('1'))
print(good_append('2'))
print(good_append('c', ['a', 'b']))
import datetime as dt
from time import sleep
def log_time(msg, time = None):
if time is None:
time = dt.datetime.now()
sleep(1)
print("%s: %s" % (time.isoformat(), msg))
log_time('msg 1')
log_time('msg 2')
log_time('msg 3')