在python函數中預設參數的一些坑

一、預設參數

python為了簡化函數的調用，提供了預設參數機制：

這樣在調用pow函數時，就可以省略最後一個參數不寫：

在定義有預設參數的函數時，需要注意以下：

必選參數必須在前面，預設參數在後；

設定何種參數為預設參數？一般來說，将參數值變化小的設定為預設參數。

python标準庫實踐

python内建函數：

函數簽名可以看出，使用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學習交流QQ群：857662006 
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')           

運作這個程式，得到的輸出是：

即使使用了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)函數清楚說明了問題：

#Python學習交流QQ群：857662006 
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對象的重新建立，位址的重新配置設定。這樣，‘恰好'就在預設參數指向的位址處修改了對象，下一次調用再次使用這個位址時，就可以看到上一次的修改了。

那麼，出現上述的輸出就不奇怪了，因為它們本來就是指向同一記憶體位址。

四、可變與不可變預設參數

當預設參數指向可變類型對象和不可變類型對象時，會表現出不同的行為。

可變預設參數 的表現就像上訴示例一樣。

不可變預設參數

首先看一個示例：

#Python學習交流QQ群：857662006 
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')