本文將討論P(yáng)ython的函數(shù)參數(shù)。我們將了解args和**kwargs，/和的都是什么，雖然這個問題是一個基本的python問題，但是在我們寫代碼時會經(jīng)常遇到，比如timm中就大量使用了這樣的參數(shù)傳遞方式。
定義和傳遞參數(shù)
parameters 和arguments 之間的區(qū)別是什么?
許多人交替使用這些術(shù)語，但它們是有區(qū)別的：
- Parameters 是函數(shù)定義中定義的名稱
- Arguments是傳遞給函數(shù)的值
紅色的是parameters , 綠色的是arguments。
傳遞參數(shù)的兩種方式
我們可以按位置和關(guān)鍵字傳遞參數(shù)。在下面的例子中，我們將值hello作為位置參數(shù)傳遞。值world 用關(guān)鍵字傳遞的。
def the_func(greeting, thing):
print(greeting + ' ' + thing)
the_func('hello', thing='world')
位置參數(shù)和kwargs(關(guān)鍵字參數(shù))之間的區(qū)別在于傳遞位置參數(shù)的順序很重要。如果調(diào)用the_func('world'， 'hello')它會打印world hello。傳遞kwargs的順序并不重要：
the_func('hello', 'world') # -> 'hello world'
the_func('world', 'hello') # -> 'world hello'
the_func(greeting='hello', thing='world') # -> 'hello world'
the_func(thing='world', greeting='hello') # -> 'hello world'
the_func('hello', thing='world') # -> 'hello world'只要kwarg在位置參數(shù)之后，就可以混合和匹配位置參數(shù)和關(guān)鍵字參數(shù)，以上就是我們在python教程中經(jīng)?？吹降膬?nèi)容，下面我們繼續(xù)。
函數(shù)參數(shù)
我們將演示6個函數(shù)參數(shù)傳遞的方法，這些方法能夠覆蓋到所有的問題。
1、如何獲得所有未捕獲的位置參數(shù)
使用*args，讓它接收一個不指定數(shù)量的形參。
def multiply(a, b, args):
result = a * b
for arg in args:
result = result * arg
return result
在這個函數(shù)中，我們通常定義前兩個參數(shù)(a和b)。然后使用args將所有剩余參數(shù)打包到一個元組中?？梢园?看作是獲取到了其他沒有處理的參數(shù)，并將它們收集到一個名為“args”的元組變量中:
multiply(1, 2) # returns 2
multiply(1, 2, 3, 4) # returns 24
最后一次調(diào)用將值1賦給參數(shù)a，將2賦給參數(shù)b，并將arg變量填充為(3,4)。由于這是一個元組，我們可以在函數(shù)中循環(huán)它并使用這些值進(jìn)行乘法!
2、如何獲得所有未捕獲的關(guān)鍵字參數(shù)
與*args類似，這次是兩個星號**kwargs
def introduce(firstname, lastname, **kwargs):
introduction = f"I am {firstname} {lastname}"
for key, value in kwargs.items():
introduction += f" my {key} is {value} "
return introduction
**kwargs關(guān)鍵字會將所有不匹配的關(guān)鍵字參數(shù)存儲在一個名為kwargs的字典中。然后可以像上面的函數(shù)一樣訪問這個字典。
print(introduce(firstname='mike', lastname='huls'))
# returns "I am mike huls"
print(introduce(firstname='mike', lastname='huls', age=33, website='mikehuls.com'))
# I am mike huls my age is 33 my website is overfit.cn
3、如果想只接受關(guān)鍵字參數(shù)，那怎么設(shè)計
可以強(qiáng)制函數(shù)只接受關(guān)鍵字參數(shù)。
def transfer_money(*, from_account:str, to_account:str, amount:int):
print(f'Transfering ${amount} FORM {from_account} to {to_account}')
transfer_money(from_account='1234', to_account='6578', amount=9999)
# won't work: TypeError: transfer_money() takes 0 positional arguments but 1 positional argument (and 2 keyword-only arguments) were given
transfer_money('1234', to_account='6578', amount=9999)
# won't work: TypeError: transfer_money() takes 0 positional arguments but 3 were given
transfer_money('1234', '6578', 9999)
在上面的函數(shù)中，*星號獲得了了所有不匹配的位置參數(shù)，但是并沒有一個變量來接受它，也就是被忽略了。
4、如何設(shè)計函數(shù)只接受位置參數(shù)
下面是一個只允許位置參數(shù)的函數(shù)示例：
def the_func(arg1:str, arg2:str, /):
print(f'provided {arg1=}, {arg2=}')
# These work:
the_func('num1', 'num2')
the_func('num2', 'num1')
# won't work: TypeError: the_func() got some positional-only arguments passed as keyword arguments: 'arg1, arg2'
the_func(arg1='num1', arg2='num2')
# won't work: TypeError: the_func() got some positional-only arguments passed as keyword arguments: 'arg2'
the_func('num1', arg2='num2')
函數(shù)定義中的/強(qiáng)制在它之前的所有參數(shù)都是位置參數(shù)。這并不意味著/后面的所有參數(shù)都必須是kwarg-only;這些可以是位置和關(guān)鍵字。
看到這個你肯定會想，為什么想要這個?這不會降低代碼的可讀性嗎?，我也覺得你說的非常正確，當(dāng)定義一個非常明確的函數(shù)時，不需要關(guān)鍵字參數(shù)來指定它的功能。例如:
def exceeds_100_bytes(x, /) -> bool:
return x.__sizeof__() > 100
exceeds_100_bytes('a')
exceeds_100_bytes({'a'})
在這個例子中，正在檢查'a'的內(nèi)存大小是否超過100字節(jié)。因?yàn)檫@個x對于我們來說他的名字不重要，在調(diào)用函數(shù)的時候不需要指定x= ' a '。比如說我們最常用的len，如果你調(diào)用len(__obj=[]) 這樣看起來是不是有點(diǎn)呆萌，因?yàn)閘en是這么定義的def len(__obj: Sized) -> int:
5、混合和匹配
作為一個例子，我們將看看前面討論過的len函數(shù)。這個函數(shù)只允許位置參數(shù)。我們將通過允許開發(fā)人員選擇是否計算重復(fù)項(xiàng)來擴(kuò)展此函數(shù)，比如用kwargs傳遞這個關(guān)鍵字:
def len_new(x, /, *, no_duplicates=False):
if (no_duplicates):
return len(list(set([a for a in x])))
return len(x)
想計算變量x的len，只能按位置傳遞x形參的參數(shù)，因?yàn)樗懊嬗幸粋€/。no_duplicate參數(shù)必須與關(guān)鍵字一起傳遞，因?yàn)樗?/em>后面。讓我們看看這個函數(shù)都可以怎么調(diào)用：
print(len_new('aabbcc')) # returns 6
print(len_new('aabbcc', no_duplicates=True)) # returns 3
print(len_new([1, 1, 2, 2, 3, 3], no_duplicates=False)) # returns 6
print(len_new([1, 1, 2, 2, 3, 3], no_duplicates=True)) # returns 3
# Won't work: TypeError: len_() got some positional-only arguments passed as keyword arguments: 'x'
print(len_new(x=[1, 1, 2, 2, 3, 3]))
# Won't work: TypeError: len_new() takes 1 positional argument but 2 were given
print(len_new([1, 1, 2, 2, 3, 3], True))6、最后把它們合在一起
下面的函數(shù)是一個非常極端的例子，說明了如何組合前面討論的所有技術(shù)：它強(qiáng)制前兩個參數(shù)以位置方式傳遞，接下來的兩個參數(shù)可以以位置方式傳遞，并且?guī)в嘘P(guān)鍵字，然后是兩個只有關(guān)鍵字的參數(shù)，然后我們用**kwargs捕獲剩下的未捕獲的參數(shù)。
def the_func(pos_only1, pos_only2, /, pos_or_kw1, pos_or_kw2, *, kw1, kw2, **extra_kw):
# cannot be passed kwarg <-- | --> can be passed 2 ways | --> can only be passed by kwarg
print(f"{pos_only1=}, {pos_only2=}, {pos_or_kw1=}, {pos_or_kw2=}, {kw1=}, {kw2=}, {extra_kw=}")
調(diào)用方式如下：
# works (pos_or_kw1 & pow_or_k2 can be passed positionally and by kwarg)
pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={}
pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={}
pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={'kw_extra1': 'extra_kw1'}
# doesnt work, (pos1 and pos2 cannot be passed with kwarg)
# the_func(pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2')
# doesnt work, (kw1 and kw2 cannot be passed positionally)
# the_func('pos1', 'pos2', 'pk1', 'pk2', 'kw1', 'kw2')
總結(jié)
看著很亂是吧，這就對了。因?yàn)閜ython在設(shè)計時是一個很寬松的語言，并沒有那么多的規(guī)范，用的人越多使用方法就越多，就變成了這樣。
那么回到第一張圖：
(x,/,y,,z,**k):是函數(shù)的參數(shù)?？偣灿兴膫€參數(shù):
- x: 是一個常規(guī)參數(shù)，這意味著它可以按位置傳遞，也可以按關(guān)鍵字傳遞。
- /,: 是一個參數(shù)分隔符，將僅限位置的參數(shù)與其他參數(shù)分開。與前面的x結(jié)合，意味著x只能按位置傳遞。
- y: 時另一個常規(guī)參數(shù)。
- *: 是一個參數(shù)分隔符，用于分隔僅限位置參數(shù)和僅限關(guān)鍵字參數(shù)。它意味著后面的z只能通過關(guān)鍵字傳遞。
- z: 是一個僅限關(guān)鍵字的參數(shù)。
- **k: 這是一個參數(shù)，將所有剩余的關(guān)鍵字參數(shù)收集到一個名為' k '的字典中。
這樣解釋是不是就很明白了。
我們今天介紹的這個例子雖然在看源代碼時沒有遇到這么復(fù)雜的情況，但是在 面試 的時候還真有人問（雖然我覺得沒啥用），所以最好還是知道一些，以免尷尬。
如果你忘記了，這里可以教你一個變通的辦法，可以使用類似的回答：
上面的參數(shù)傳遞在開發(fā)時并不常用，因?yàn)閷τ陂_發(fā)規(guī)范來說，應(yīng)該保證代碼的可讀性，我們這邊遵循的開發(fā)規(guī)范是：
1、盡量不要在函數(shù)定義中將可變位置參數(shù) *args 和可變關(guān)鍵字參數(shù) **kwargs 放在一起，因?yàn)檫@樣會讓函數(shù)的調(diào)用方式變得不太直觀。
2、在使用可變參數(shù)時，要保證函數(shù)的行為是可預(yù)測的。上面函數(shù)中的進(jìn)行了太多的python語法糖，對于理解該函數(shù)的參數(shù)會造成很大的困惑，也就是可讀性太差，我們在進(jìn)行codereview（如果你了解什么是codereview就說，不了解就說組長檢查）/組長merge代碼 時會直接要求返工，所以我們在實(shí)際開發(fā)時是不會用這個的。
對于我閱讀的開源代碼，也都基本上使用的是 **kwargs 這種情況（這里可以舉兩個例子），還沒有看到有人寫這么亂的代碼，我想要是寫這樣的代碼估計開源的人也會被人吐糟（這里自己可以自行延伸），所以這些參數(shù)傳遞的規(guī)則我在學(xué)習(xí)的時候看到過，但是實(shí)際中沒見過真正使用，就不太記住了。
回到本文，我們介紹了設(shè)計函數(shù)參數(shù)的所有方法，并了解了如何混合和匹配它們，雖然后面幾個內(nèi)容可能你一輩子也不會用到，但是了解一下也是好的，因?yàn)槿f一呢。
