Python函數默認參數避坑指南

列表是一種經常使用的數據類型。在函數的定義中,常常會使用列表作爲參數。

比如,要測試一個接口的數據,接口返回的數據格式如下:

{
  "code": "20000", 
  "data": ["孫悟空","李白","甄姬"], 
  "msg": "success", 
  "status": 0
}

要測試的內容是:返回的 data 數據是否跟需求符合。在測試之前,需要對數據進一步處理,比如要增加 "王昭君" 這個元素進去,需要寫一個函數:

def add_element(data=["孫悟空","李白","甄姬"]):
    data.append('王昭君')
    return data

print(add_element())
print(add_element())
print(add_element())

在函數定義的時候經常會給參數設置默認值,在這個例子中,將 data 參數設置了默認值,函數定義以後,後面會被頻繁的調用,期望值應該是打印如下:

["孫悟空","李白","甄姬","王昭君"]
["孫悟空","李白","甄姬","王昭君"]
["孫悟空","李白","甄姬","王昭君"]

實際結果爲:

["孫悟空","李白","甄姬","王昭君"]
["孫悟空","李白","甄姬","王昭君","王昭君"]
["孫悟空","李白","甄姬","王昭君","王昭君","王昭君"]

原因

當定義函數時,會保存函數中默認參數 data 的值,也就是 ["孫悟空","李白","甄姬"],在每次調用的時候如果傳遞了新的實參,則使用傳遞的參數;沒有傳遞,使用定義函數時保存的默認參數。

上面兩次調用中,都沒有傳遞新的實參,程序會調用定義函數時保存的默認參數,因爲 append() , 在第一次調用以後,默認參數已經由 ["孫悟空","李白","甄姬"] 改變爲 ["孫悟空","李白","甄姬","王昭君"],再次執行 append() 之後,就變成了 ["孫悟空","李白","甄姬","王昭君","王昭君"];同理,第三次又改變了。

可以使用 id() 函數來定位問題:

def add_element(data=["孫悟空","李白","甄姬"]):
    # id 來表示是不是同一個對象
	print(id(data))
    data.append('王昭君')
    return data

print(add_element())
print(add_element())
print(add_element())

打印出來的 id(data) 爲同一個對象,也就是默認參數。如果我們改變 第二個 print(add_element()) print(add_element(["孫悟空","李白","甄姬"])),那麼第 2 個 id(data) 就會發生變化,因爲它不在是默認值,而是新傳進來的實參,實際結果也將變成:

2543416926792
['孫悟空', '李白', '甄姬', '王昭君']
2543418907848
["孫悟空","李白","甄姬", '王昭君']
2543416926792
['孫悟空', '李白', '甄姬', '王昭君', '王昭君']

改進方案

  • 如果參數中有列表,儘量不要用它做默認參數
  • 如果使用了列表作爲默認參數,函數調用時傳入實參,而不是省略
  • 可以在函數體中另外定義一個變量接收默認參數
def add_element(data=["孫悟空","李白","甄姬"]):
    if data == ["孫悟空","李白","甄姬"]:
        data = ["孫悟空","李白","甄姬"]
    data.append('王昭君')
    return data

我是九柄,公衆號【 九柄 】,分享軟件測試文章、面試、教程資料,歡迎來看看。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章