Python中函数参数传递方法详解

本文将讨论Python的函数参数。我们将了解args和**kwargs，/和的都是什么，虽然这个问题是一个基本的python问题，但是在我们写代码时会经常遇到，比如timm中就大量使用了这样的参数传递方式。

定义和传递参数

parameters 和arguments 之间的区别是什么?

许多人交替使用这些术语，但它们是有区别的：

• Parameters 是函数定义中定义的名称
• Arguments是传递给函数的值

红色的是parameters , 绿色的是arguments。

传递参数的两种方式

我们可以按位置和关键字传递参数。在下面的例子中，我们将值hello作为位置参数传递。值world 用关键字传递的。

 def the_func(greeting, thing):
 print(greeting + ' ' + thing)
 
 the_func('hello', thing='world')

位置参数和kwargs(关键字参数)之间的区别在于传递位置参数的顺序很重要。如果调用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在位置参数之后，就可以混合和匹配位置参数和关键字参数，以上就是我们在python教程中经常看到的内容，下面我们继续。

函数参数

我们将演示6个函数参数传递的方法，这些方法能够覆盖到所有的问题。

1、如何获得所有未捕获的位置参数

使用*args，让它接收一个不指定数量的形参。

def multiply(a, b, args):
result = a * b
for arg in args:
result = result * arg
return result

在这个函数中，我们通常定义前两个参数(a和b)。然后使用args将所有剩余参数打包到一个元组中。可以把*看作是获取到了其他没有处理的参数，并将它们收集到一个名为“args”的元组变量中:

multiply(1, 2)# returns 2
multiply(1, 2, 3, 4)# returns 24

最后一次调用将值1赋给参数a，将2赋给参数b，并将arg变量填充为(3,4)。由于这是一个元组，我们可以在函数中循环它并使用这些值进行乘法!

2、如何获得所有未捕获的关键字参数

与*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关键字会将所有不匹配的关键字参数存储在一个名为kwargs的字典中。然后可以像上面的函数一样访问这个字典。

 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、如果想只接受关键字参数，那怎么设计

可以强制函数只接受关键字参数。

 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)

在上面的函数中，*星号获得了了所有不匹配的位置参数，但是并没有一个变量来接受它，也就是被忽略了。

4、如何设计函数只接受位置参数

下面是一个只允许位置参数的函数示例：

 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')

函数定义中的/强制在它之前的所有参数都是位置参数。这并不意味着/后面的所有参数都必须是kwarg-only;这些可以是位置和关键字。

看到这个你肯定会想，为什么想要这个?这不会降低代码的可读性吗?，我也觉得你说的非常正确，当定义一个非常明确的函数时，不需要关键字参数来指定它的功能。例如:

def exceeds_100_bytes(x, /) -> bool:
 return x.__sizeof__() > 100
 
 exceeds_100_bytes('a')
 exceeds_100_bytes({'a'})

在这个例子中，正在检查'a'的内存大小是否超过100字节。因为这个x对于我们来说他的名字不重要，在调用函数的时候不需要指定x= ' a '。比如说我们最常用的len，如果你调用len(__obj=[]) 这样看起来是不是有点呆萌，因为len是这么定义的def len(__obj: Sized) -> int:

5、混合和匹配

作为一个例子，我们将看看前面讨论过的len函数。这个函数只允许位置参数。我们将通过允许开发人员选择是否计算重复项来扩展此函数，比如用kwargs传递这个关键字:

 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形参的参数，因为它前面有一个/。no_duplicate参数必须与关键字一起传递，因为它跟在后面。让我们看看这个函数都可以怎么调用：

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、最后把它们合在一起

下面的函数是一个非常极端的例子，说明了如何组合前面讨论的所有技术：它强制前两个参数以位置方式传递，接下来的两个参数可以以位置方式传递，并且带有关键字，然后是两个只有关键字的参数，然后我们用**kwargs捕获剩下的未捕获的参数。

 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=}")

调用方式如下：

# 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')

总结

看着很乱是吧，这就对了。因为python在设计时是一个很宽松的语言，并没有那么多的规范，用的人越多使用方法就越多，就变成了这样。

那么回到第一张图：

def func(x,/,y,,z,**k):

(x,/,y,,z,**k):是函数的参数。总共有四个参数:

• x: 是一个常规参数，这意味着它可以按位置传递，也可以按关键字传递。
• /,: 是一个参数分隔符，将仅限位置的参数与其他参数分开。与前面的x结合，意味着x只能按位置传递。
• y: 时另一个常规参数。
• *: 是一个参数分隔符，用于分隔仅限位置参数和仅限关键字参数。它意味着后面的z只能通过关键字传递。
• z: 是一个仅限关键字的参数。
• **k: 这是一个参数，将所有剩余的关键字参数收集到一个名为' k '的字典中。

这样解释是不是就很明白了。

我们今天介绍的这个例子虽然在看源代码时没有遇到这么复杂的情况，但是在 面试 的时候还真有人问（虽然我觉得没啥用），所以最好还是知道一些，以免尴尬。

如果你忘记了，这里可以教你一个变通的办法，可以使用类似的回答：

上面的参数传递在开发时并不常用，因为对于开发规范来说，应该保证代码的可读性，我们这边遵循的开发规范是：

1、尽量不要在函数定义中将可变位置参数 *args 和可变关键字参数 **kwargs 放在一起，因为这样会让函数的调用方式变得不太直观。

2、在使用可变参数时，要保证函数的行为是可预测的。上面函数中的进行了太多的python语法糖，对于理解该函数的参数会造成很大的困惑，也就是可读性太差，我们在进行codereview（如果你了解什么是codereview就说，不了解就说组长检查）/组长merge代码 时会直接要求返工，所以我们在实际开发时是不会用这个的。

对于我阅读的开源代码，也都基本上使用的是 **kwargs这种情况（这里可以举两个例子），还没有看到有人写这么乱的代码，我想要是写这样的代码估计开源的人也会被人吐糟（这里自己可以自行延伸），所以这些参数传递的规则我在学习的时候看到过，但是实际中没见过真正使用，就不太记住了。

回到本文，我们介绍了设计函数参数的所有方法，并了解了如何混合和匹配它们，虽然后面几个内容可能你一辈子也不会用到，但是了解一下也是好的，因为万一呢。