【Python有坑系列】函式預設引數
Python進階-函式預設引數
寫在前面
如非特別說明,下文均基於
Python3
一、預設引數
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)
讓執行緒暫停一秒,排除了程式執行很快的因素。輸出中三次呼叫打印出的時間還是相同的,即三次呼叫中預設引數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
直譯器實現中,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
物件的重新建立,地址的重新分配。這樣,‘恰好’就在預設引數指向的地址處修改了物件,下一次呼叫再次使用這個地址時,就可以看到上一次的修改了。
那麼,出現上述的輸出就不奇怪了,因為它們本來就是指向同一記憶體地址。
四、可變與不可變
當預設引數指向可變型別物件和不可變型別物件時,會表現出不同的行為。
可變預設引數 的表現就像上訴示例一樣。
不可變預設引數
首先看一個示例:
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
的操作會造成記憶體重新分配,物件重新建立,那麼函式中i += 1
之後名字i
指向了另外的地址;根據預設引數的規則,下次呼叫時,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')
參考