7.5 定義有默認(rèn)參數(shù)的函數(shù)

問題

你想定義一個(gè)函數(shù)或者方法，它的一個(gè)或多個(gè)參數(shù)是可選的并且有一個(gè)默認(rèn)值。

解決方案

定義一個(gè)有可選參數(shù)的函數(shù)是非常簡單的，直接在函數(shù)定義中給參數(shù)指定一個(gè)默認(rèn)值，并放到參數(shù)列表最后就行了。例如：

def spam(a, b=42):
    print(a, b)

spam(1) # Ok. a=1, b=42
spam(1, 2) # Ok. a=1, b=2

如果默認(rèn)參數(shù)是一個(gè)可修改的容器比如一個(gè)列表、集合或者字典，可以使用None作為默認(rèn)值，就像下面這樣：

# Using a list as a default value
def spam(a, b=None):
    if b is None:
        b = []
    ...

如果你并不想提供一個(gè)默認(rèn)值，而是想僅僅測試下某個(gè)默認(rèn)參數(shù)是不是有傳遞進(jìn)來，可以像下面這樣寫：

_no_value = object()

def spam(a, b=_no_value):
    if b is _no_value:
        print('No b value supplied')
    ...

我們測試下這個(gè)函數(shù)：

>>> spam(1)
No b value supplied
>>> spam(1, 2) # b = 2
>>> spam(1, None) # b = None
>>>

仔細(xì)觀察可以發(fā)現(xiàn)到傳遞一個(gè)None值和不傳值兩種情況是有差別的。

討論

定義帶默認(rèn)值參數(shù)的函數(shù)是很簡單的，但絕不僅僅只是這個(gè)，還有一些東西在這里也深入討論下。

首先，默認(rèn)參數(shù)的值僅僅在函數(shù)定義的時(shí)候賦值一次。試著運(yùn)行下面這個(gè)例子：

>>> x = 42
>>> def spam(a, b=x):
...     print(a, b)
...
>>> spam(1)
1 42
>>> x = 23 # Has no effect
>>> spam(1)
1 42
>>>

注意到當(dāng)我們改變x的值的時(shí)候?qū)δJ(rèn)參數(shù)值并沒有影響，這是因?yàn)樵诤瘮?shù)定義的時(shí)候就已經(jīng)確定了它的默認(rèn)值了。

其次，默認(rèn)參數(shù)的值應(yīng)該是不可變的對象，比如None、True、False、數(shù)字或字符串。特別的，千萬不要像下面這樣寫代碼：

def spam(a, b=[]): # NO!
    ...

如果你這么做了，當(dāng)默認(rèn)值在其他地方被修改后你將會遇到各種麻煩。這些修改會影響到下次調(diào)用這個(gè)函數(shù)時(shí)的默認(rèn)值。比如：

>>> def spam(a, b=[]):
...     print(b)
...     return b
...
>>> x = spam(1)
>>> x
[]
>>> x.append(99)
>>> x.append('Yow!')
>>> x
[99, 'Yow!']
>>> spam(1) # Modified list gets returned!
[99, 'Yow!']
>>>

這種結(jié)果應(yīng)該不是你想要的。為了避免這種情況的發(fā)生，最好是將默認(rèn)值設(shè)為None，然后在函數(shù)里面檢查它，前面的例子就是這樣做的。

在測試None值時(shí)使用 is 操作符是很重要的，也是這種方案的關(guān)鍵點(diǎn)。有時(shí)候大家會犯下下面這樣的錯誤：

def spam(a, b=None):
    if not b: # NO! Use 'b is None' instead
        b = []
    ...

這么寫的問題在于盡管None值確實(shí)是被當(dāng)成False，但是還有其他的對象(比如長度為0的字符串、列表、元組、字典等)都會被當(dāng)做False。因此，上面的代碼會誤將一些其他輸入也當(dāng)成是沒有輸入。比如：

>>> spam(1) # OK
>>> x = []
>>> spam(1, x) # Silent error. x value overwritten by default
>>> spam(1, 0) # Silent error. 0 ignored
>>> spam(1, '') # Silent error. '' ignored
>>>

最后一個(gè)問題比較微妙，那就是一個(gè)函數(shù)需要測試某個(gè)可選參數(shù)是否被使用者傳遞進(jìn)來。這時(shí)候需要小心的是你不能用某個(gè)默認(rèn)值比如None、0或者False值來測試用戶提供的值(因?yàn)檫@些值都是合法的值，是可能被用戶傳遞進(jìn)來的)。因此，你需要其他的解決方案了。

為了解決這個(gè)問題，你可以創(chuàng)建一個(gè)獨(dú)一無二的私有對象實(shí)例，就像上面的_no_value變量那樣。在函數(shù)里面，你可以通過檢查被傳遞參數(shù)值跟這個(gè)實(shí)例是否一樣來判斷。這里的思路是用戶不可能去傳遞這個(gè)_no_value實(shí)例作為輸入。因此，這里通過檢查這個(gè)值就能確定某個(gè)參數(shù)是否被傳遞進(jìn)來了。

這里對 object() 的使用看上去有點(diǎn)不太常見。object 是python中所有類的基類。你可以創(chuàng)建 object 類的實(shí)例，但是這些實(shí)例沒什么實(shí)際用處，因?yàn)樗]有任何有用的方法，也沒有哦任何實(shí)例數(shù)據(jù)(因?yàn)樗鼪]有任何的實(shí)例字典，你甚至都不能設(shè)置任何屬性值)。你唯一能做的就是測試同一性。這個(gè)剛好符合我的要求，因?yàn)槲以诤瘮?shù)中就只是需要一個(gè)同一性的測試而已。